Skip to main content
POST
Grant a procedure to an agent
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

POST /api/v2/agents/assignProcedure grants the agent one procedure as a tool. The body is { agentId, procedureId }; the answer is { id, agentId, procedureId, assigned: true, changed }, where changed: false means the agent already had the grant.

Authority

You need agents:manage at the agent’s home org unit, and agents:read there to see the agent. Any credential works: a Personal key acts as its owner, narrowed by its scopes; an External App and a platform key use their own grants. A missing, PERSONAL, unhomed or unreadable agent is the same 404 resource_missing (Agent not found); an unavailable agent store is 500, never 404. Without agents:manage at the home the answer is 403 permission_denied, recorded as a refused request.

The procedure

You must be able to read the procedure: procedures:read at its home. A procedure you cannot read is the same 404 resource_missing (Procedure not found) as a missing one. It must also be grantable as an agent tool (active, approved or builtin, and exposed as an agent tool); otherwise the answer is 409 conflict. An operator’s deny of the procedure for this agent is 409 conflict: change it in the Console. The grant is a plain grant: the API never writes a deny. It is audited as agent_procedure_assigned.

Replay

With an Idempotency-Key, a repeat of the same request within 24 hours returns the recorded answer only while the slug still names the same agent definition, you may still read the agent at its home, and you still hold the route’s permission there (the agent_write replay rule). Otherwise the repeat is 409 conflict and the write never runs twice.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

1–255 printable ASCII characters (0x21–0x7E, no spaces), scoped to the calling credential. A repeat with the same key and request never runs the write again, a 5xx included: once the operation's permissions pass again it answers the identical status and body of the first response (Idempotent-Replayed: true, also sent as Idempotency-Replayed: true), unless the operation's own replay policy withholds it; a first response that was not stored (over 32 KiB, or carrying a one-time secret) answers its first status with only data.id (Idempotency-Replay-Disclosure: id-only) when it named one; otherwise 409 idempotency_result_unavailable; a repeat while the first is still running is 409 idempotency_key_in_flight, and the same key with a different request is 422 idempotency_key_reuse. Honoured for External App JWTs and platform and Personal keys; an External App's static companion key is not protected.

Required string length: 1 - 255

Path Parameters

agentId
string
required

The agent's slug (agentId).

Minimum string length: 1

Body

application/json
procedureId
string
required

The procedure's family key (procedureId).

Minimum string length: 1

Response

Grant a procedure to an agent

data
object
required
meta
object
required