Platform Agents API

Sign in Install on GitHub

GET STARTED

Overview Authentication Python SDK TypeScript SDK Session events

API REFERENCE

All Endpoints Start a session List sessions Search sessions Get a session Get changes Download a transcript List executions Get commits and pull requests Send a message Get structured output List records Stop a session

Sessions

Sessions

Sessions run agents in the cloud. Start work, send follow-up messages, inspect progress, and retrieve transcripts, changes, and structured output.

Manage

Start a sessionPOST /v1/sessionsSend a messagePOST /v1/sessions/{session_id}/messagesStop a sessionPOST /v1/sessions/{session_id}/stop

Find

List sessionsGET /v1/sessionsSearch sessionsGET /v1/sessions/searchGet a sessionGET /v1/sessions/{session_id}

Activity and transcripts

List executionsGET /v1/sessions/{session_id}/executionsList recordsGET /v1/sessions/{session_id}/recordsDownload a transcriptGET /v1/sessions/{session_id}/download

Results and changes

Get structured outputGET /v1/sessions/{session_id}/outputGet changesGET /v1/sessions/{session_id}/diffGet commits and pull requestsGET /v1/sessions/{session_id}/git

On this page

No Headings

Schedule a demo