API reference

API reference · Agents

Claim an on chain deposit for an agent

POST/v1/agents/{id}/depositsAPI key

A transfer from the agent's proven wallet to the deployment's deposit address, credited to the agent's sub balance once, under the same replay guard as every claim.

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredstringThe agent's id; self on an agent's own key where the route allows it.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
tx_hashrequiredstring
chainstring or nullA network key or chain id.

Example

{
  "tx_hash": "string",
  "chain": "string"
}

Answer 200

Credited, or already credited to this agent.

Fields of the 200 answer
FieldTypeWhat it is
objectstringOne of "agent.deposit".
already_creditedboolean
credited_microsinteger
chainstring or null

Errors

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 403OpenAI shaped error.
  • 404OpenAI shaped error.
  • 409OpenAI shaped error.
  • 502OpenAI shaped error.
  • 503OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter