agent-rpc

Submit an agent claim

Changed on

Submits a claim for work performed

post/api/v1/agent-rpc/claim

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Request body

claimTypeNamestring required

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

quantityinteger

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

additionalDescriptionstring

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

autoKillboolean 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

Response

Success

claimIdinteger required

A unique sequential ID assigned to this claim

requestedAmountinteger required

The amount requested, echoed back to the agent

fulfilledAmountinteger required

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

remainingAgentBudgetinteger required

The remaining agent budget after the claim was made

remainingSessionBudgetinteger required

The remaining session budget after the claim was made

shouldExitboolean required

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

Changes

    • info

      added the new optional request property

    • info

      the request property became optional

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status