Skip to content

HTTP API ​

Generated from the Orpheus OpenAPI contract. Usage guidance is provided in the integration guides.

Authentication, errors and retries · Integration example · Data schemas

OpenAPI YAML

MethodPathOperation
GET/api/v1/profilesList profiles
POST/api/v1/profilesCreate 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-accountsList llm-accounts
POST/api/v1/llm-accountsCreate 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-storesList configured credential store names
PUT/api/v1/llm-accounts/{id}/api-keyReplace an account API key
GET/api/v1/llm-accounts/{id}/auth-fileRead the account authorization file
PUT/api/v1/llm-accounts/{id}/auth-fileConditionally replace the account authorization file
GET/api/v1/templatesList registered templates
POST/api/v1/templatesRegister 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/servicesList configured services
GET/api/v1/accounts/limitsCurrent provider limits by account
GET/api/v1/analytics/overviewDashboard analytics snapshot
GET/api/v1/auth/sessionRead browser authentication state
GET/auth/loginStart SP-initiated SAML login
POST/auth/callbackConsume a signed SAML HTTP-POST response
POST/auth/logoutRevoke the local browser session
GET/saml/metadataRead service provider metadata
GET/api/v1/runsList All Runs
GET/api/v1/sessionsList Sessions
POST/api/v1/sessionsCreate Session
GET/api/v1/sessions/{sid}Read Session
GET/api/v1/sessions/{sid}/eventsEvents
GET/api/v1/sessions/{sid}/events/streamStream Events
GET/api/v1/sessions/{sid}/historyHistory
GET/api/v1/sessions/{sid}/runsList Runs
POST/api/v1/sessions/{sid}/runsCreate Run
GET/api/v1/sessions/{sid}/runs/{rid}Read Run
POST/api/v1/sessions/{sid}/runs/{rid}/cancelCancel Run
POST/api/v1/sessions/{sid}/runs/{rid}/messagesSend Message