Skip to content

Space HTTP API ​

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

API conventions · Schedules · Data schemas

OpenAPI YAML

MethodPathOperation
GET/api/v1/schedulesList schedules
POST/api/v1/schedulesCreate a schedule
GET/api/v1/schedules/{id}Get a schedule including deleted records
PATCH/api/v1/schedules/{id}Update selected schedule fields
DELETE/api/v1/schedules/{id}Soft delete a schedule
GET/api/v1/profilesGet a page of Orpheus model profiles
GET/api/v1/templatesGet a page of Orpheus templates
GET/api/v1/servicesGet available Orpheus services
GET/api/v1/schedules/settingsGet schedule interface settings
POST/api/v1/schedules/previewPreview five future cron occurrences
GET/api/v1/auth/sessionGet browser access state
GET/api/v1/schedules/{id}/occurrencesRead stored history without calling the core
GET/api/v1/schedules/{id}/occurrences/{occurrence_id}Read a stored occurrence without calling the core
GET/api/v1/schedules/{id}/occurrences/{occurrence_id}/resultExplicitly fetch the current result from the Orpheus core
POST/api/v1/schedules/{id}/runRun a schedule now without changing its timing or activity
POST/api/v1/schedules/{id}/reset-sessionDetach the reusable session for the next occurrence
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