HTTP API
Generated from the Orpheus OpenAPI contract. Usage guidance is provided in the integration guides.
Authentication, errors and retries · Integration example · Data schemas
| Method | Path | Operation |
|---|---|---|
GET | /api/v1/profiles | List profiles |
POST | /api/v1/profiles | Create profile |
GET | /api/v1/profiles/{id} | Read profile |
PATCH | /api/v1/profiles/{id} | Update profile |
DELETE | /api/v1/profiles/{id} | Delete profile |
GET | /api/v1/llm-accounts | List llm-accounts |
POST | /api/v1/llm-accounts | Create llm account |
GET | /api/v1/llm-accounts/{id} | Read llm account |
PATCH | /api/v1/llm-accounts/{id} | Update llm account |
DELETE | /api/v1/llm-accounts/{id} | Delete llm account |
GET | /api/v1/credential-stores | List configured credential store names |
PUT | /api/v1/llm-accounts/{id}/api-key | Replace an account API key |
GET | /api/v1/llm-accounts/{id}/auth-file | Read the account authorization file |
PUT | /api/v1/llm-accounts/{id}/auth-file | Conditionally replace the account authorization file |
GET | /api/v1/templates | List registered templates |
POST | /api/v1/templates | Register an own-project AgentBox template |
GET | /api/v1/templates/{id} | Read a registered template |
PATCH | /api/v1/templates/{id} | Update template activity or description |
DELETE | /api/v1/templates/{id} | Delete an Orpheus catalog record |
GET | /api/v1/services | List configured services |
GET | /api/v1/accounts/limits | Current provider limits by account |
GET | /api/v1/analytics/overview | Dashboard analytics snapshot |
GET | /api/v1/auth/session | Read browser authentication state |
GET | /auth/login | Start SP-initiated SAML login |
POST | /auth/callback | Consume a signed SAML HTTP-POST response |
POST | /auth/logout | Revoke the local browser session |
GET | /saml/metadata | Read service provider metadata |
GET | /api/v1/runs | List All Runs |
GET | /api/v1/sessions | List Sessions |
POST | /api/v1/sessions | Create Session |
GET | /api/v1/sessions/{sid} | Read Session |
GET | /api/v1/sessions/{sid}/events | Events |
GET | /api/v1/sessions/{sid}/events/stream | Stream Events |
GET | /api/v1/sessions/{sid}/history | History |
GET | /api/v1/sessions/{sid}/runs | List Runs |
POST | /api/v1/sessions/{sid}/runs | Create Run |
GET | /api/v1/sessions/{sid}/runs/{rid} | Read Run |
POST | /api/v1/sessions/{sid}/runs/{rid}/cancel | Cancel Run |
POST | /api/v1/sessions/{sid}/runs/{rid}/messages | Send Message |