REST API Reference
Authentication, available endpoints, and example calls for the CAST Imaging REST API.
Authentication
All API requests require an API key. Pass the key in the Authorization header:
Authorization: Bearer <your-api-key>
Generate an API key in the Admin Center. See Manage users.
Base URL
https://<your-imaging-host>/api/v1
Available endpoints
[TODO: Full endpoint table — method, path, description, required parameters]
Applications
| Method | Path | Description |
|---|---|---|
| GET | /applications |
List all applications the user can access |
| GET | /applications/{id} |
Get details of one application |
| [TODO] |
Import and analysis
| Method | Path | Description |
|---|---|---|
| POST | /applications/{id}/import |
Trigger an application import |
| [TODO] |
Reports
| Method | Path | Description |
|---|---|---|
| POST | /reports |
Generate a report |
| GET | /reports/{id}/status |
Check report generation status |
| GET | /reports/{id}/download |
Download a completed report |
Example: trigger an import
curl -X POST https://imaging.example.com/api/v1/applications/42/import \
-H "Authorization: Bearer <api-key>"
Next steps
Feedback
Was this page helpful?