API reference

API reference · Agents

A signed delivery that starts an agent's run

POST/api/agents/hooks/{trigger}No key

No session and no key: the body is signed with the trigger's secret in x-antimatter-signature (t=<unix seconds>,v1=<hex HMAC-SHA256 of t.body>), judged before the body is read whole; a signature already taken is refused. The run is billed to the agent. A 404 while hosted runs or triggers (ANTIMATTER_AGENT_TRIGGERS) are off on the deployment.

Parameters

Path and query parameters
FieldTypeWhat it is
trigger (path)requiredstringThe trigger's id.

Request body

application/json, optional

The document names no fields for this body.

Example

{}

Answer 202

The run started.

The answer's fields are not named in the document.

Errors

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 402OpenAI shaped error.
  • 404OpenAI shaped error.
  • 409OpenAI shaped error.
  • 413OpenAI shaped error.
  • 429OpenAI 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.

Request headers it reads (1)
Request headers
FieldTypeWhat it is
x-antimatter-signaturerequiredstringt=<unix seconds>,v1=<hex HMAC-SHA256 of t.body>
Antimatter