Skip to main content
POST
/
snippets
/
{id}
/
runs
Create snippet run
curl --request POST \
  --url https://api.akua.dev/v1/snippets/{id}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "overrides": {},
  "agent_turn_id": "<string>"
}
'
{
  "id": "<string>",
  "snippet_id": "<string>",
  "agent_session_id": "<string>",
  "agent_turn_id": "<string>",
  "duration_ms": 123,
  "created_at": 1,
  "etag": "<string>",
  "overrides": {},
  "output": "<unknown>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.akua.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

​
akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens — a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def456"

​
idempotency-key
string

Caller-supplied idempotency key. Repeated requests with the same key return the existing resource instead of creating a duplicate. Safe to retry after a timed-out or interrupted request.

Required string length: 1 - 64
Example:

"create-prod-2026-05-07"

Path Parameters

​
id
string
required
Required string length: 1 - 54

Body

application/json
​
overrides
object
​
agent_turn_id
string
Required string length: 1 - 54

Response

Snippet run created

​
id
string
required
Required string length: 1 - 54
​
snippet_id
string
required
Required string length: 1 - 54
​
agent_session_id
string | null
required
Required string length: 1 - 54
​
agent_turn_id
string | null
required
Required string length: 1 - 54
​
state
enum<string>
required

Terminal run state in past participle form.

Available options:
succeeded,
failed,
timed_out
​
duration_ms
number
required
​
created_at
integer
required

Unix timestamp (seconds)

Required range: x >= 0
​
etag
string
required
​
overrides
object
​
output
any
​
error
object