CAcaveman

Read an automation run

GET /api/v1/code/automations/{automationId}/runs/{runId} on the Caveman Cloud control plane. Requires the code:read scope. Not exposed to autonomous agents: Cloud automations are applied from a repository's .caveman/ files by the Code app, a code:run key or a push to the default branch, and a person approves wider authority (ADR 0133). An agent works inside a run's session and never applies, approves, enables or fires automations from a control-plane connection.

get/code/automations/{automationId}/runs/{runId}

Request

  • Base URL
    https://api.caveman.so/api/v1
  • URL
    https://api.caveman.so/api/v1/code/automations/{automationId}/runs/{runId}
  • Auth
    • OAuth 2
      Authorization code: /api/v1/oauth/authorize
      Token URL: /api/v1/oauth/token scopes: code:read
    • or HTTP bearer
    • or API key in cookie cave_access
    • or API key in cookie __Secure-cave_identity.session_token

Response

The run

idstring uuid required
automation_idstring uuid required
revision_idstring uuid required
triggerstring required

github.<event>, schedule, webhook, slack.app_mention, linear.<event>, jira.<event> or manual.

event_idstring
fire_slotstring required
subjectstring required
inputsobject
triggered_by_user_idstring uuid nullable
session_idstring uuid nullable
workspace_idstring uuid nullable
status'queued' | 'running' | 'waiting' | 'succeeded' | 'failed' | 'cancelled' | 'skipped' required
outcomestring required

The reason a terminal status carries: superseded, skipped_overlap, policy_denied, admission_refused, dispatch_failed, deadline, session_failed (the session failed and no run record came).

cost_usdnumber required
started_atstring date-time nullable
finished_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time
recorded_atstring date-time nullable

When the run's record arrived (ADR 0134). An ended run that started a session and has none: cost_usd is unknown, not 0.

automationstring

The automation's name; on the organization-wide list.

repostring

Changes

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