v2

latestOpenAPI 3.1.0Proprietary2026-07-26127193620.1 KB

Registries

Define an agent identity

post/agents

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Request body

addressstring required

The agent's globally unique email address; mail to it must route to an endpoint the account controls.

endpoint_idstring uuid

Optional. The endpoint the agent runs on. Omit it to resolve the endpoint from the address's routing automatically; supply it to pin a specific endpoint, which is then validated against the address's route.

display_namestring required

titlestring nullable

descriptionstring nullable

tagsstring[]

Response

Agent defined

successtrue required