Skip to main content
POST
Submit an agent claim

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A description of the work done and the payment required

claimTypeName
string
required

The name of the claim type. This claim type must be defined in the agent's coral-agent.toml file

autoKill
boolean
required

Set this to false if the agent wants to handle budget exhaustion itself. Budget settings may kill agents on budget exhaustion even if this is set to false

quantity
integer

The amount of the claim type to claim. The cost of this claim will be multiplied by this value.

Required range: 0 <= x <= 4294967295
additionalDescription
string

An additional description of the claim, clamped at 256 characters long

Response

Success

A response to a claim request.

claimId
integer<int32>
required

A unique sequential ID assigned to this claim

requestedAmount
integer
required

The amount requested, echoed back to the agent

fulfilledAmount
integer
required

The amount of the budget that could be fulfilled. If this is not equal to the requested amount, the budget was exhausted.

remainingAgentBudget
integer
required

The remaining agent budget after the claim was made

remainingSessionBudget
integer
required

The remaining session budget after the claim was made

shouldExit
boolean
required

If this is true, the claim resulted in a budget exhaustion that should cause the agent to exit.