Skip to content

Approve

POST
/api/v3/projects/{project_id}/approvals/{approval_id}/approve
curl --request POST \
--url 'https://example.com/api/v3/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/approvals/example/approve?runtime_mode=test' \
--header 'Content-Type: application/json' \
--data '{ "binding_fingerprint": "example", "reason": "example" }'
project_id
required
Project Id
string format: uuid
approval_id
required
Approval Id
string
runtime_mode
Runtime Mode
string
default: live
Allowed values: test live
X-Admin-Key
Any of:
string
Media typeapplication/json
ApprovalDecisionRequestV3
object
binding_fingerprint
required
Binding Fingerprint
string
/^[0-9a-f]{64}$/
reason
Any of:
string
<= 500 characters
Examplegenerated
{
"binding_fingerprint": "example",
"reason": "example"
}

Successful Response

Media typeapplication/json
ApprovalDecisionResponseV3
object
approval
required
ApprovalResponseV3
object
action_summary
required
Action Summary
string
agent_id
Any of:
string format: uuid
approval_id
required
Approval Id
string
binding_fingerprint
Any of:
string
channel
required
Channel
string
expires_at
required
Expires At
string format: date-time
id
required
Id
string format: uuid
input_summary
Any of:
string
project_id
required
Project Id
string format: uuid
requested_at
required
Requested At
string format: date-time
resolved_at
Any of:
string format: date-time
runtime_mode
required
Runtime Mode
string
session_id
required
Session Id
string format: uuid
status
required
Status
string
Allowed values: pending approved denied expired
tool_id
required
Tool Id
string
user_id
required
User Id
string format: uuid
enqueued
required
Enqueued
boolean
Example
{
"approval": {
"status": "pending"
}
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}