AgentActionRead
Fields
41 fields
action_type· required- string
approvable- boolean
approval_required· required- boolean
approve_blocked_reason- string or null
approved_at- string or null
approved_by- string or null
approved_by_name- string or null
canonical_type- string or null
created_at- string or null
error_code- string or null
execution_completed_at- string or null
execution_started_at- string or null
id· required- string
idempotency_key· required- string
outcome- string
outcome_text- string
pipeline_run_id- string or null
pipeline_workflow_type- string or null
project_id· required- string
proposing_agent_id- string or null
proposing_agent_label- string or null
proposing_review_state- string
rationale- string or null
rejection_reason_code- string or null
request_payload· required- object
request_sha256· required- string
result_link- AgentActionResultLink or null
result_payload- object or null
reversible- boolean
review_id- string or null
risk- string or null
rollback_payload- object or null
side_effect- string or null
status· required- string
target- AgentActionTarget or null
target_id- string or null
target_type· required- string
test_run_branch- string or null
test_run_build_number- string or null
test_run_id- string or null
title- string or null
Raw schema (JSON)
{
"properties": {
"action_type": {
"title": "Action Type",
"type": "string"
},
"approvable": {
"default": false,
"title": "Approvable",
"type": "boolean"
},
"approval_required": {
"title": "Approval Required",
"type": "boolean"
},
"approve_blocked_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Approve Blocked Reason"
},
"approved_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Approved At"
},
"approved_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Approved By"
},
"approved_by_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Approved By Name"
},
"canonical_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Canonical Type"
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Created At"
},
"error_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error Code"
},
"execution_completed_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Execution Completed At"
},
"execution_started_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Execution Started At"
},
"id": {
"title": "Id",
"type": "string"
},
"idempotency_key": {
"title": "Idempotency Key",
"type": "string"
},
"outcome": {
"default": "unknown",
"title": "Outcome",
"type": "string"
},
"outcome_text": {
"default": "",
"title": "Outcome Text",
"type": "string"
},
"pipeline_run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pipeline Run Id"
},
"pipeline_workflow_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pipeline Workflow Type"
},
"project_id": {
"title": "Project Id",
"type": "string"
},
"proposing_agent_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Proposing Agent Id"
},
"proposing_agent_label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Proposing Agent Label"
},
"proposing_review_state": {
"default": "none",
"title": "Proposing Review State",
"type": "string"
},
"rationale": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Rationale"
},
"rejection_reason_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Rejection Reason Code"
},
"request_payload": {
"additionalProperties": true,
"title": "Request Payload",
"type": "object"
},
"request_sha256": {
"title": "Request Sha256",
"type": "string"
},
"result_link": {
"anyOf": [
{
"$ref": "#/components/schemas/AgentActionResultLink"
},
{
"type": "null"
}
]
},
"result_payload": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Result Payload"
},
"reversible": {
"default": false,
"title": "Reversible",
"type": "boolean"
},
"review_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Review Id"
},
"risk": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Risk"
},
"rollback_payload": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Rollback Payload"
},
"side_effect": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Side Effect"
},
"status": {
"title": "Status",
"type": "string"
},
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/AgentActionTarget"
},
{
"type": "null"
}
]
},
"target_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Target Id"
},
"target_type": {
"title": "Target Type",
"type": "string"
},
"test_run_branch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Test Run Branch"
},
"test_run_build_number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Test Run Build Number"
},
"test_run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Test Run Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"required": [
"id",
"project_id",
"action_type",
"target_type",
"status",
"approval_required",
"idempotency_key",
"request_sha256",
"request_payload"
],
"title": "AgentActionRead",
"type": "object"
}Used by endpoints
Section titled “Used by endpoints”2 endpoints send or return this schema, on its own or inside another schema.
PATCH/api/v1/projects/{project_id}/agent-actions/{action_id}— Transition Agent ActionGET/api/v1/projects/{project_id}/agent-actions— List Agent Actions
Used by schemas
Section titled “Used by schemas”More details
Section titled “More details”- Specification: OpenAPI JSON