Skip to main content
PATCH
/
projects
/
{project_reference}
/
work
/
{work_id}
/
executions
/
{execution_id}
Update Work execution
curl --request PATCH \
  --url https://api.veryfront.com/projects/{project_reference}/work/{work_id}/executions/{execution_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": {},
  "summary": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "work_id": "<string>",
  "work_name": "<string>",
  "work_outcome": "<string>",
  "work_source_path": "<string>",
  "work_definition_hash": "<string>",
  "input": {},
  "state": {},
  "summary": "<string>",
  "agent_id": "<string>",
  "schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "canonical_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "root_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "root_conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "updated_at": "<string>",
  "started_at": "<string>",
  "completed_at": "<string>",
  "acceptance_criteria": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "work_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "criterion_id": "<string>",
      "description": "<string>",
      "optional": true,
      "position": 123,
      "reason": "<string>",
      "evidence": [
        null
      ],
      "created_at": "<string>",
      "updated_at": "<string>",
      "evaluated_at": "<string>"
    }
  ],
  "events": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "work_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "actor_id": "<string>",
      "payload": {},
      "created_at": "<string>",
      "updated_at": "<string>",
      "actor_name": "<string>",
      "actor_avatar_url": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

​
project_reference
string
required
​
work_id
string
required

Work identifier

Minimum string length: 1
Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]*$
​
execution_id
string<uuid>
required

Work execution identifier

Body

application/json
​
status
enum<string>
Available options:
pending,
running,
blocked,
completed,
failed,
cancelled
​
state
object
​
summary
string | null

Response

Updated Work execution

​
id
string<uuid>
required
​
project_id
string<uuid>
required
​
work_id
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]*$
​
work_name
string
required
​
work_outcome
string
required
​
work_source_path
string | null
required
​
work_definition_hash
string | null
required
​
status
enum<string>
required
Available options:
pending,
running,
blocked,
completed,
failed,
cancelled
​
input
object
required
​
state
object
required
​
summary
string | null
required
​
agent_id
string | null
required
​
schedule_id
string<uuid> | null
required
​
canonical_run_id
string<uuid> | null
required
​
root_run_id
string<uuid> | null
required
​
root_conversation_id
string<uuid> | null
required
​
created_by
string<uuid> | null
required
​
created_at
string
required
​
updated_at
string
required
​
started_at
string | null
required
​
completed_at
string | null
required
​
acceptance_criteria
object[]
required
​
events
object[]
required