Skip to content
Docs
GitHub

Management API

Sessions & workspaces

Manage execution sessions and rooms, and their files, tasks, storage, databases and managed sandboxes.

Browse endpoints

Files

GETList uploaded files, newest first/v1/filesPreviewPOSTUpload a PDF or zip file as a message attachment/v1/filesPreviewGETDownload a stored file's bytes/v1/files/{file_id}PreviewDELETEDelete a stored file/v1/files/{file_id}Preview

Images

GETList images/v1/imagesPreviewPOSTUpload an image/v1/imagesPreviewGETGet image (returns binary data)/v1/images/{image_id}PreviewDELETEDelete an image/v1/images/{image_id}PreviewGETGet image thumbnail/v1/images/{image_id}/thumbnailPreview

Rooms

GETList the org's rooms, most recently active first/v1/roomsPreviewPOSTCreate a room where people and agents talk/v1/roomsPreviewGETRead the change feed of every room in the org, in order/v1/rooms/eventsPreviewGETGet a room/v1/rooms/{room_id}PreviewPATCHChange a room's name, topic or settings/v1/rooms/{room_id}PreviewPOSTArchive a room (or bring it back with archived=false)/v1/rooms/{room_id}/archivePreviewGETRead a room's change feed/v1/rooms/{room_id}/eventsPreviewGETList a room's shared files/v1/rooms/{room_id}/filesPreviewPUTWrite a room file/v1/rooms/{room_id}/filesPreviewDELETEDelete a room file/v1/rooms/{room_id}/filesPreviewGETRead a room file/v1/rooms/{room_id}/files/contentPreviewPOSTEdit part of a room file/v1/rooms/{room_id}/files/editPreviewGETRead a room file's history/v1/rooms/{room_id}/files/historyPreviewPOSTMove or rename a room file/v1/rooms/{room_id}/files/movePreviewPOSTRestore an earlier version of a room file/v1/rooms/{room_id}/files/restorePreviewGETList a room's members/v1/rooms/{room_id}/membersPreviewPOSTAdd a member to a room/v1/rooms/{room_id}/membersPreviewDELETERemove a member from a room/v1/rooms/{room_id}/members/{member_id}PreviewPATCHChange a room member's settings/v1/rooms/{room_id}/members/{member_id}PreviewGETRead a room's top-level messages, oldest first/v1/rooms/{room_id}/messagesPreviewPOSTPost a message in a room, at the top level or as a reply/v1/rooms/{room_id}/messagesPreviewGETGet one message/v1/rooms/{room_id}/messages/{message_id}PreviewDELETEDelete a message/v1/rooms/{room_id}/messages/{message_id}PreviewPATCHChange a message's text/v1/rooms/{room_id}/messages/{message_id}PreviewPOSTPin a message to the room, or unpin it with pinned=false/v1/rooms/{room_id}/messages/{message_id}/pinPreviewPOSTAdd a reaction to a message, or remove it with add=false/v1/rooms/{room_id}/messages/{message_id}/reactionsPreviewGETWho has read a message, and who has not/v1/rooms/{room_id}/messages/{message_id}/readersPreviewGETRead the replies in a message's thread, oldest first/v1/rooms/{room_id}/messages/{message_id}/repliesPreviewGETList a room's pinned messages, most recently pinned first/v1/rooms/{room_id}/pinsPreviewPOSTMark a room's top level, or a thread, read up to a message/v1/rooms/{room_id}/readPreviewGETFind messages in a room by text, newest first/v1/rooms/{room_id}/searchPreviewPOSTRead and mark a room's unread messages/v1/rooms/{room_id}/unreadPreview

Sessions

GETList sessions in organization/v1/sessionsPreviewPOSTCreate a new session/v1/sessionsPreviewGETFacet counts and masthead metrics/v1/sessions/facetsPreviewPOSTOpen the current user's platform conversation/v1/sessions/platform-chatPreviewGETGet session counts by status/v1/sessions/statsPreviewGETGet session/v1/sessions/{session_id}PreviewDELETEDelete session/v1/sessions/{session_id}PreviewPATCHUpdate session/v1/sessions/{session_id}PreviewPUTArchive session/v1/sessions/{session_id}/archivePreviewDELETERestore an archived session/v1/sessions/{session_id}/archivePreviewPOSTCancel current turn/v1/sessions/{session_id}/cancelPreviewGETLatest context breakdown/v1/sessions/{session_id}/context-reportPreviewGETShow what a session spent/v1/sessions/{session_id}/costPreviewGETExport session messages as JSONL or ATIF/v1/sessions/{session_id}/exportPreviewPOSTFork a session into an independent copy/v1/sessions/{session_id}/forkPreviewPOSTSubmit elicitation consent/v1/sessions/{session_id}/mcp-elicitation-consentPreviewGETList session participants/v1/sessions/{session_id}/participantsPreviewPOSTAdd a session participant/v1/sessions/{session_id}/participantsPreviewDELETELeave a participant/v1/sessions/{session_id}/participants/{participant_id}PreviewPUTPin session for current user/v1/sessions/{session_id}/pinPreviewDELETEUnpin session for current user/v1/sessions/{session_id}/pinPreviewPOSTSubmit question answers/v1/sessions/{session_id}/question-answersPreviewGETResolve the session's active model/v1/sessions/{session_id}/resolved-modelPreviewGETShow a session's whole run/v1/sessions/{session_id}/runPreviewGETGet run requests/v1/sessions/{session_id}/run-requestsPreviewPOSTSubmit tool approvals/v1/sessions/{session_id}/tool-approvalsPreviewPOSTSubmit client-side tool results/v1/sessions/{session_id}/tool-resultsPreviewGETSummarize a session's trace/v1/sessions/{session_id}/tracePreviewGETList a page of a session's trace turns/v1/sessions/{session_id}/trace/turnsPreviewGETList the raw events of one trace turn/v1/sessions/{session_id}/trace/turns/{turn}/eventsPreviewGETList the steps of one trace turn/v1/sessions/{session_id}/trace/turns/{turn}/stepsPreviewGETGet one step of a session's trace in full/v1/sessions/{session_id}/trace/turns/{turn}/steps/{step}PreviewGETList the messages sent in one model call/v1/sessions/{session_id}/trace/turns/{turn}/steps/{step}/requestPreview

Session databases

GETList databases/v1/sessions/{session_id}/databasesPreviewPOSTCreate database/v1/sessions/{session_id}/databasesPreviewGETGet database/v1/sessions/{session_id}/databases/{name}PreviewDELETEDelete database/v1/sessions/{session_id}/databases/{name}PreviewGETGet schema/v1/sessions/{session_id}/databases/{name}/schemaPreview

Events

GETList events (JSON)/v1/sessions/{session_id}/eventsPreviewGETOne-shot debug summary/v1/sessions/{session_id}/events/summaryPreviewGETStream events (SSE notifications)/v1/sessions/{session_id}/ssePreviewGETShow what a session's turn is doing or got done/v1/sessions/{session_id}/workPreview

Messages

GETList your message ratings in a session/v1/sessions/{session_id}/feedbackPreviewGETList messages (PRIMARY data)/v1/sessions/{session_id}/messagesPreviewPOSTCreate message (user message triggers workflow)/v1/sessions/{session_id}/messagesPreviewPUTRate a message in a session/v1/sessions/{session_id}/messages/{message_id}/feedbackPreviewPUTReact to a message/v1/sessions/{session_id}/messages/{message_id}/reactions/{emoji}PreviewDELETERemove your reaction from a message/v1/sessions/{session_id}/messages/{message_id}/reactions/{emoji}PreviewGETList reactions in a session/v1/sessions/{session_id}/reactionsPreview

Session Git

POSTCreate branch/v1/sessions/{session_id}/git/branchesPreviewDELETEDelete branch/v1/sessions/{session_id}/git/branches/{name}PreviewPOSTCommit/v1/sessions/{session_id}/git/commitPreviewGETDiff/v1/sessions/{session_id}/git/diffPreviewGETLog/v1/sessions/{session_id}/git/logPreviewGETList refs/v1/sessions/{session_id}/git/refsPreview

Session resources

GETList the MCP servers added to this chat only/v1/sessions/{session_id}/mcp-serversPreviewDELETERemove an MCP server added to this chat only/v1/sessions/{session_id}/mcp-servers/{name}PreviewGETList the session's registered resources/v1/sessions/{session_id}/resourcesPreview

Session sandbox

GETGet session repositories/v1/sessions/{session_id}/repositoriesPreviewPOSTManage sandbox/v1/sessions/{session_id}/sandboxPreview

Session storage

GETList all key-value pairs/v1/sessions/{session_id}/storage/keysPreviewGETList all secrets (names only)/v1/sessions/{session_id}/storage/secretsPreviewPUTBatch set secrets/v1/sessions/{session_id}/storage/secretsPreviewDELETEDelete secret/v1/sessions/{session_id}/storage/secrets/{name}Preview

Session tasks

GETList background tasks owned by a session/v1/sessions/{session_id}/tasksPreviewGETGet one session task with its recent message thread/v1/sessions/{session_id}/tasks/{task_id}PreviewPOSTRequest cooperative cancellation of a session task/v1/sessions/{session_id}/tasks/{task_id}/cancelPreviewPOSTSend an inbound message to a session task/v1/sessions/{session_id}/tasks/{task_id}/messagesPreviewGETList per-task push-notification configs/v1/sessions/{session_id}/tasks/{task_id}/push-configsPreviewPOSTCreate a per-task push-notification config/v1/sessions/{session_id}/tasks/{task_id}/push-configsPreviewDELETEDelete a per-task push-notification config/v1/sessions/{session_id}/tasks/{task_id}/push-configs/{config_id}PreviewGETList background tasks across the organization/v1/tasksPreview

Workspace

GETList workspaces/v1/workspacesPreviewGETGet workspace/v1/workspaces/{workspace_id}PreviewDELETEDelete workspace/v1/workspaces/{workspace_id}PreviewPATCHUpdate workspace/v1/workspaces/{workspace_id}Preview

Workspace filesystem

GETWorkspace root listing/v1/workspaces/{workspace_id}/fsPreviewPOSTCopy a file/v1/workspaces/{workspace_id}/fs/_/copyPreviewGETDownload raw file bytes/v1/workspaces/{workspace_id}/fs/_/download/{path}PreviewPOSTSearch files/v1/workspaces/{workspace_id}/fs/_/grepPreviewPOSTMove/rename a file or directory/v1/workspaces/{workspace_id}/fs/_/movePreviewGETSandboxed HTML render/v1/workspaces/{workspace_id}/fs/_/preview/{path}PreviewPOSTFile metadata/v1/workspaces/{workspace_id}/fs/_/statPreviewPUTUpload raw file bytes/v1/workspaces/{workspace_id}/fs/_/upload/{path}PreviewGETRead file or list directory/v1/workspaces/{workspace_id}/fs/{path}PreviewPUTUpdate file content/v1/workspaces/{workspace_id}/fs/{path}PreviewPOSTCreate file or directory/v1/workspaces/{workspace_id}/fs/{path}PreviewDELETEDelete file or directory/v1/workspaces/{workspace_id}/fs/{path}Preview

Support & compatibility

Stable
Documented compatibility. Breaking changes follow an announced deprecation period.
Preview
Public early access. Breaking changes may occur; review the changelog before upgrading.
Experimental
Evaluation only. No compatibility guarantee; the endpoint lists its availability requirements.
Internal
Platform operation and diagnostics. No external compatibility commitment.
Deprecated
Use the linked replacement or migration guide. Removal dates appear only when announced.

Current public APIs are Preview unless marked Experimental. Support labels describe compatibility, not access permissions or a service-level agreement.