Execution

Report coding-agent execution status

Agents should call this after starting work and when they have a branch, pull request, checks, blocker, or final outcome.

post/api/v1/agent-runs/{id}/status

Request

  • Base URL: https://www.specky.space
  • URL: https://www.specky.space/api/v1/agent-runs/{id}/status
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Request body

status'queued' | 'pending_assignment' | 'assigned' | 'awaiting_agent' | 'in_progress' | 'awaiting_review' | 'changes_requested' | 'passed' | 'failed' | 'blocked' | 'cancelled'
notestring
branchstring
commit_shastring
pull_request_urlstring uri
provider_agent_idstring
provider_run_idstring
ci_status'not_reported' | 'queued' | 'in_progress' | 'success' | 'failure' | 'cancelled' | 'unknown'
ci_namestring nullable
ci_urlstring uri nullable
ci_conclusionstring nullable
ci_atstring date-time nullable
deployment_status'not_reported' | 'queued' | 'in_progress' | 'success' | 'failure' | 'cancelled' | 'unknown'
deployment_environmentstring nullable
deployment_urlstring uri nullable
deployment_idstring nullable
deployment_atstring date-time nullable
deployment_sourcestring nullable
production_deployment_status'not_reported' | 'queued' | 'in_progress' | 'success' | 'failure' | 'cancelled' | 'unknown'
production_deployment_urlstring uri nullable
production_deployed_atstring date-time nullable
smoke_test_status'not_reported' | 'queued' | 'in_progress' | 'success' | 'failure' | 'cancelled' | 'unknown'
smoke_test_namestring nullable
smoke_test_urlstring uri nullable
smoke_test_atstring date-time nullable
feature_flag_status'not_reported' | 'queued' | 'in_progress' | 'success' | 'failure' | 'cancelled' | 'unknown'
feature_flag_namestring nullable
feature_flag_atstring date-time nullable
summarystring
blocked_reasonstring
errorstring

Response

Successful response. Always includes summary (string) and ok: true; mutating endpoints additionally include the created resource id under a tool-specific key.

oktrue
summarystring

Human-readable result text.

Changes

No recorded changes to this operation across all 1 revision of this API.