openapi: 3.1.0 info: title: Amika API — v0beta1 API keys Sandboxes API version: 0beta1 tags: - name: Sandboxes paths: /sandboxes:slackMetadata: get: tags: - Sandboxes summary: Slack metadata for the org's Slack-made sandboxes security: - bearerAuth: [] - cookieAuth: [] responses: '200': description: Map of sandbox id to Slack metadata. content: application/json: schema: $ref: '#/components/schemas/SandboxSlackMetadataResponse' '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes: get: tags: - Sandboxes summary: List the org's sandboxes security: - bearerAuth: [] - cookieAuth: [] responses: '200': description: Sandboxes. content: application/json: schema: $ref: '#/components/schemas/ListSandboxesResponse' '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message post: tags: - Sandboxes summary: Create a sandbox security: - bearerAuth: [] - cookieAuth: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSandboxRequest' responses: '202': description: Sandbox created (provisioning continues in the background). content: application/json: schema: $ref: '#/components/schemas/Sandbox' '400': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '409': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}: get: tags: - Sandboxes summary: Read a sandbox by id or name security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path responses: '200': description: Sandbox. content: application/json: schema: $ref: '#/components/schemas/Sandbox' '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message delete: tags: - Sandboxes summary: Delete a sandbox security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path responses: '200': description: Deleted. content: application/json: schema: $ref: '#/components/schemas/OkStatus' '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '409': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}/start: post: tags: - Sandboxes summary: Start a sandbox security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path - schema: type: string enum: - 'true' - 'false' required: false name: skip_start_script in: query responses: '202': description: Sandbox start scheduled. content: application/json: schema: $ref: '#/components/schemas/OkStatus' '400': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '409': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}/stop: post: tags: - Sandboxes summary: Stop a sandbox security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path responses: '202': description: Sandbox stop scheduled. content: application/json: schema: $ref: '#/components/schemas/OkStatus' '400': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '409': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}/ssh: post: tags: - Sandboxes summary: Create SSH access to a sandbox security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path responses: '200': description: SSH access info. content: application/json: schema: $ref: '#/components/schemas/SshAccessResponse' '400': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message delete: tags: - Sandboxes summary: Revoke SSH access security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/RevokeSshRequest' responses: '204': description: Revoked. '400': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}/integrations: get: tags: - Sandboxes summary: List a sandbox's integrations security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path responses: '200': description: Integrations. content: application/json: schema: $ref: '#/components/schemas/SandboxIntegrationsResponse' '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}/slack-conversation: get: tags: - Sandboxes summary: Read the Slack conversation thread for a Slack-made sandbox security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path responses: '200': description: 'Conversation thread, or `{ conversation: null }` when the sandbox was not made by Slack or has no conversation yet.' content: application/json: schema: $ref: '#/components/schemas/SlackConversationResponse' '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}/sessions: get: tags: - Sandboxes summary: List a sandbox's agent sessions security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path - schema: type: string required: false name: status in: query - schema: type: integer minimum: 0 exclusiveMinimum: true required: false name: limit in: query - schema: type: integer nullable: true minimum: 0 required: false name: offset in: query responses: '200': description: Sessions. content: application/json: schema: $ref: '#/components/schemas/AgentSessionsList' '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message post: tags: - Sandboxes summary: Create a new agent session security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSessionRequest' responses: '201': description: Session. content: application/json: schema: $ref: '#/components/schemas/AgentSession' '400': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}/sessions/latest: get: tags: - Sandboxes summary: Read the latest agent session for a sandbox security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path responses: '200': description: Session. content: application/json: schema: $ref: '#/components/schemas/AgentSession' '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}/sessions/{sessionId}: get: tags: - Sandboxes summary: Read an agent session security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path - schema: type: string minLength: 1 required: true name: sessionId in: path responses: '200': description: Session. content: application/json: schema: $ref: '#/components/schemas/AgentSession' '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message patch: tags: - Sandboxes summary: Update an agent session security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path - schema: type: string minLength: 1 required: true name: sessionId in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSessionRequest' responses: '200': description: Updated session. content: application/json: schema: $ref: '#/components/schemas/AgentSession' '400': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}/agent-send: post: tags: - Sandboxes summary: Send a message to the agent in a sandbox security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/AgentSendRequest' responses: '200': description: Agent response. content: application/json: schema: $ref: '#/components/schemas/AgentSendResponse' '400': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}/agent-send-jobs: post: tags: - Sandboxes summary: Enqueue an async agent-send job security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/AgentSendJobRequest' responses: '202': description: Job enqueued. content: application/json: schema: $ref: '#/components/schemas/AgentSendJobResponse' '400': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}/agent-send-jobs/{job_id}: get: tags: - Sandboxes summary: Read an async agent-send job security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path - schema: type: string minLength: 1 required: true name: job_id in: path responses: '200': description: Job. content: application/json: schema: $ref: '#/components/schemas/AgentSendJobResponse' '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}/workflow/events: get: tags: - Sandboxes summary: Read workflow events from the sandbox event sink security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path - schema: type: string required: false name: since in: query responses: '200': description: Events list (empty when the file is missing). content: application/json: schema: $ref: '#/components/schemas/WorkflowEventsResponse' '400': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message /sandboxes/{id}/lifecycle-events: get: tags: - Sandboxes summary: Read the control-plane lifecycle event feed for a sandbox security: - bearerAuth: [] - cookieAuth: [] parameters: - schema: type: string minLength: 1 required: true name: id in: path responses: '200': description: Lifecycle events, oldest first (empty when none). content: application/json: schema: $ref: '#/components/schemas/SandboxLifecycleEventsResponse' '400': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '401': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '403': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message '404': description: Error headers: x-trace-id: description: Per-request trace id for correlating responses with logs. schema: type: string content: application/json: schema: type: object properties: type: type: string enum: - error error_code: type: string message: type: string details: type: array items: nullable: true trace_id: type: string required: - type - error_code - message components: schemas: SshAccessResponse: type: object properties: ssh_destination: type: string token: type: string expires_at: anyOf: - type: string - type: string format: date-time sandbox_id: type: string sandbox_name: type: string repo_name: type: string nullable: true web_socket_proxy_url: type: string private_key: type: string required: - ssh_destination - token - expires_at - sandbox_id - sandbox_name - repo_name SandboxLifecycleEventsResponse: type: object properties: events: type: array items: $ref: '#/components/schemas/SandboxLifecycleEvent' count: type: integer required: - events - count AgentSendResponse: type: object properties: session_id: type: string agent_session_id: type: string response: type: string is_error: type: boolean is_new_session: type: boolean cost_usd: type: number required: - session_id - response - is_error - is_new_session CreateSandboxRequest: type: object properties: name: type: string minLength: 1 repo_url: type: string git_url: type: string github_url: type: string branch: type: string minLength: 1 new_branch_name: type: string minLength: 1 provider: type: string enum: - local-docker - daytona - freestyle - vercel auto_stop_interval: type: number minimum: 0 maximum: 10080 auto_delete_interval: type: number minimum: -1 maximum: 10080 amika_opencode_web: anyOf: - type: string - type: number - nullable: true env_vars: type: object additionalProperties: type: string default: {} secret_env_vars: type: object additionalProperties: type: string minLength: 1 default: {} disabled_repo_env_var_names: type: array items: type: string pattern: ^[A-Z_][A-Z0-9_]*$ default: [] setup_script_text: type: string skip_setup_script: type: boolean default: false agent_credentials: type: array items: type: object properties: kind: type: string enum: - claude - codex name: type: string minLength: 1 type: type: string enum: - oauth - api_key none: type: boolean enum: - true required: - kind default: [] preset: type: string enum: - coder - coder-dind default: coder size: type: string enum: - xs - m - l - xl default: m snapshot: type: string nullable: true minLength: 1 integration_ids: type: array items: type: string default: [] initial_prompt: type: string agent: type: string enum: - claude - codex workflow: type: object properties: enabled: type: boolean required: - enabled github_auth_mode: type: string enum: - pat - app_token required: - name WorkflowEventsResponse: type: object properties: events: type: array items: type: object properties: event_type: type: string id: type: string time: type: string step: type: string contents: nullable: true required: - event_type - id - time count: type: integer capped: type: boolean required: - events - count - capped CreateSessionRequest: type: object properties: agent_name: type: string metadata: type: object additionalProperties: nullable: true required: - agent_name ListSandboxesResponse: type: array items: $ref: '#/components/schemas/Sandbox' SandboxIntegrationsResponse: type: array items: type: object properties: sandbox_id: type: string name: type: string mcp_server_type: type: string mcp_server_url: type: string required: - sandbox_id - name - mcp_server_type - mcp_server_url AgentSendJobResponse: type: object properties: job_id: type: string state: type: string agent_session_id: type: string nullable: true is_new_session: type: boolean is_error: type: boolean result_text: type: string nullable: true cost_usd: type: number created_at: anyOf: - type: string - type: string format: date-time updated_at: anyOf: - type: string - type: string format: date-time required: - job_id - state - agent_session_id - is_new_session - is_error - result_text - created_at - updated_at SlackConversationResponse: type: object properties: conversation: type: object nullable: true properties: conversation_id: type: string team_id: type: string team_name: type: string nullable: true channel_id: type: string channel_name: type: string nullable: true thread_id: type: string status: type: string nullable: true agent_name: type: string nullable: true enum: - claude - codex - null messages: type: array items: type: object properties: id: type: string author: type: string direction: type: string enum: - inbound - outbound contents: type: string occurred_at: anyOf: - type: string - type: string format: date-time is_error: type: boolean required: - id - author - direction - contents - occurred_at - is_error required: - conversation_id - team_id - team_name - channel_id - channel_name - thread_id - status - agent_name - messages required: - conversation SandboxSlackMetadataResponse: type: object properties: metadata: type: object additionalProperties: type: object properties: conversation_id: type: string nullable: true team_id: type: string team_name: type: string nullable: true team_icon_url: type: string nullable: true channel_id: type: string channel_name: type: string nullable: true thread_id: type: string preview: type: string nullable: true status: type: string nullable: true agent_name: type: string nullable: true enum: - claude - codex - null required: - conversation_id - team_id - team_name - team_icon_url - channel_id - channel_name - thread_id - preview - status - agent_name required: - metadata SandboxLifecycleEvent: type: object properties: id: type: string run_kind: type: string step: type: string status: type: string detail: type: string nullable: true created_at: anyOf: - type: string - type: string format: date-time required: - id - run_kind - step - status - detail - created_at RevokeSshRequest: type: object properties: token: type: string minLength: 1 required: - token AgentSendJobRequest: type: object properties: message: type: string minLength: 1 new_session: type: boolean default: false session_id: type: string agent: type: string required: - message UpdateSessionRequest: type: object properties: status: type: string enum: - active - completed - failed metadata: type: object additionalProperties: nullable: true AgentSendRequest: type: object properties: message: type: string minLength: 1 new_session: type: boolean default: false session_id: type: string agent: type: string required: - message AgentSessionsList: type: object properties: sessions: type: array items: $ref: '#/components/schemas/AgentSession' total: type: integer minimum: 0 required: - sessions - total Sandbox: type: object properties: id: type: string user_id: type: string nullable: true org_id: type: string name: type: string provider: type: string nullable: true provider_sandbox_id: type: string nullable: true provider_url: type: string nullable: true amika_opencode_web: type: string nullable: true repo_name: type: string nullable: true repo_provider: type: string nullable: true repo_id: type: string nullable: true repo_url: type: string nullable: true branch: type: string nullable: true commit_hash: type: string nullable: true snapshot: type: string nullable: true snapshot_name: type: string nullable: true sandbox_preset: type: string nullable: true sandbox_size: type: string nullable: true error_message: type: string nullable: true current_session_id: type: string nullable: true services: type: array nullable: true items: type: object properties: name: type: string url: type: string hostPort: type: integer containerPort: type: integer protocol: type: string required: - name - url - hostPort - containerPort - protocol state: type: string status: type: string enum: - creating - starting - running - stopping - suspending - suspended - snapshotting - failed - unknown setup_status: type: string nullable: true enum: - ok - setup-running - git-failed - setup-failed - sys-setup-failed - null urls_expire_at: anyOf: - type: string - type: string format: date-time - nullable: true secret_names: type: array items: type: string has_workflow: type: boolean resolved_agent_credentials: type: array items: oneOf: - type: object properties: kind: type: string outcome: type: string enum: - resolved name: type: string type: type: string enum: - oauth - api_key source: type: string required: - kind - outcome - name - type - source - type: object properties: kind: type: string outcome: type: string enum: - skipped reason: type: string enum: - request:none - no_user_credential required: - kind - outcome - reason created_by: type: object nullable: true properties: name: type: string nullable: true email: type: string nullable: true required: - name - email origin: type: string nullable: true created_at: anyOf: - type: string - type: string format: date-time updated_at: anyOf: - type: string - type: string format: date-time required: - id - user_id - org_id - name - provider - provider_sandbox_id - provider_url - amika_opencode_web - repo_name - repo_provider - repo_id - repo_url - branch - commit_hash - snapshot - current_session_id - services - created_at - updated_at additionalProperties: nullable: true AgentSession: type: object properties: id: type: string sandbox_id: type: string org_id: type: string agent_name: type: string status: type: string started_at: anyOf: - type: string - type: string format: date-time ended_at: anyOf: - type: string - type: string format: date-time - nullable: true metadata: type: object additionalProperties: nullable: true created_at: anyOf: - type: string - type: string format: date-time updated_at: anyOf: - type: string - type: string format: date-time required: - id - sandbox_id - org_id - agent_name - status - started_at - ended_at - metadata - created_at - updated_at OkStatus: type: object properties: ok: type: boolean enum: - true required: - ok