Ellipsis API

The Ellipsis REST API lives at https://api.ellipsis.dev. Create an API key in the dashboard and send it as a bearer token.

The Ellipsis REST API starts, searches, and streams sessions, invokes and manages automations and environments, runs code reviews, and reads your organization's settings from your own scripts and services. It is the same public API the Agent CLI uses. Every endpoint returns JSON, and every request is authenticated with a bearer token.

Endpoint map

The reference documents every endpoint, generated from the same OpenAPI specification the SDKs are built from. The spec itself is published at /openapi.v1.json. Beyond the endpoints below, Sessions is the shape of the object most of them return, and Sessions › From scripts is the end-to-end walkthrough.

Sessions
POST/v1/sessionsStart a cloud agent sessionGET/v1/sessionsList cloud agent sessions, newest firstGET/v1/sessions/{session_id}Return one sessionGET/v1/sessions/{session_id}/diffReturn the session's uncommitted changes as a patchGET/v1/sessions/{session_id}/exportExport the complete session historyPOST/v1/sessions/{session_id}/messagesSend a message to a sessionGET/v1/sessions/{session_id}/outputReturn the session's typed outputGET/v1/sessions/{session_id}/recordsReturn the session's stored transcript records, oldest firstPOST/v1/sessions/{session_id}/stopStop an in-flight session and return it
Automations
POST/v1/automationsCreate an automation, managed through the API: no file, live immediatelyGET/v1/automationsList automationsGET/v1/automations/{automation_id}Return one automation, by id or by namePUT/v1/automations/{automation_id}Replace an automation's definition, by id or by nameDELETE/v1/automations/{automation_id}Delete an automation, by id or by namePOST/v1/automations/{automation_id}/linkMove an automation into a repository, by id or by nameGET/v1/automations/{automation_id}/metricsReturn an automation's session distribution and trailing spend, by id or by namePOST/v1/automations/{automation_id}/sessionsInvoke an automationPOST/v1/automations/{automation_id}/unlinkTake over an automation from its file, by id or by name
Environments
POST/v1/environmentsCreate an environment, managed through the API: no file, live immediatelyGET/v1/environmentsList saved environmentsGET/v1/environments/{environment_id}Return one saved environment, by id or by namePUT/v1/environments/{environment_id}Replace an environment's definition, by id or by nameDELETE/v1/environments/{environment_id}Delete an environment, by id or by name
Secrets
PUT/v1/secretsUpsert secretsGET/v1/secretsList secretsDELETE/v1/secrets/{name}Delete a secret by name
Files
POST/v1/filesUpload a file that outlives the sandboxGET/v1/filesList uploaded files, newest firstGET/v1/files/{file_id}Return one file's metadata and download linkDELETE/v1/files/{file_id}Delete a file
Reviews
POST/v1/reviewsRun a code review on demandGET/v1/reviewsList code reviews, newest firstGET/v1/reviews/{review_id}Return one review with findings and outcome
Integrations
GET/v1/integrationsList connected integrationsGET/v1/integrations/github/membersList the GitHub organization rosterGET/v1/integrations/github/reposList GitHub repositories connected to the installationGET/v1/integrations/linear/teamsList the teams of the connected Linear workspaceGET/v1/integrations/sentry/organizationsList the connected Sentry organizationsGET/v1/integrations/slack/channelsList the channels of the connected Slack workspace, fetched live from the Slack APIGET/v1/integrations/slack/membersList the members of the connected Slack workspace, fetched live from the Slack API
Platform
GET/v1/modelsList selectable agent modelsGET/v1/meReturn the identity behind the caller's credentialGET/v1/budgetReturn the caller's current budget summaryGET/v1/usageReturn the caller's usage dashboard dataPUT/v1/settings/organizationSet the organization settingsGET/v1/settings/organizationGet the organization settings

On this page

Endpoint map
Schedule a demo