Skip to main content
PATCH
/
api
/
v1
/
executions
/
{execution_id}
Update Execution
curl --request PATCH \
  --url https://control-plane.kubiya.ai/api/v1/executions/{execution_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "<string>",
  "started_at": "<string>",
  "completed_at": "<string>",
  "response": "<string>",
  "error_message": "<string>",
  "usage": {},
  "execution_metadata": {}
}
'
{
  "id": "<string>",
  "organization_id": "<string>",
  "execution_type": "<string>",
  "entity_id": "<string>",
  "entity_name": "<string>",
  "prompt": "<string>",
  "system_prompt": "<string>",
  "status": "<string>",
  "response": "<string>",
  "error_message": "<string>",
  "usage": {},
  "execution_metadata": {},
  "runner_name": "<string>",
  "user_id": "<string>",
  "user_name": "<string>",
  "user_email": "<string>",
  "user_avatar": "<string>",
  "created_at": "<string>",
  "started_at": "<string>",
  "completed_at": "<string>",
  "updated_at": "<string>",
  "participants": [
    {
      "id": "<string>",
      "user_id": "<string>",
      "user_name": "<string>",
      "user_email": "<string>",
      "user_avatar": "<string>",
      "role": "<string>",
      "joined_at": "<string>",
      "last_active_at": "<string>"
    }
  ],
  "last_message_at": "<string>",
  "last_message_preview": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.kubiya.ai/llms.txt

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

Authorizations

​
Authorization
string
header
required

Enter your Kubiya API token (format: Bearer )

Path Parameters

​
execution_id
string
required

Body

application/json

Update execution fields - used by workers to update execution status

​
status
string | null
​
started_at
string | null
​
completed_at
string | null
​
response
string | null
​
error_message
string | null
​
usage
Usage · object
​
execution_metadata
Execution Metadata · object

Response

Successful Response

​
id
string
required
​
organization_id
string
required
​
execution_type
string
required
​
entity_id
string
required
​
entity_name
string | null
required
​
prompt
string
required
​
system_prompt
string | null
required
​
status
string
required
​
response
string | null
required
​
error_message
string | null
required
​
usage
Usage · object
required
​
execution_metadata
Execution Metadata · object
required
​
runner_name
string | null
required
​
user_id
string | null
required
​
user_name
string | null
required
​
user_email
string | null
required
​
user_avatar
string | null
required
​
created_at
string
required
​
started_at
string | null
required
​
completed_at
string | null
required
​
updated_at
string
required
​
participants
ParticipantResponse · object[]
​
last_message_at
string | null
​
last_message_preview
string | null