Skip to main content
POST
Ask for an agent's missing setup
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/requestSetup opens one setup request for the agent’s missing setup (connections, knowledge, approvals), asking the people who can provide each. The body is { id, note? }; the note is at most 500 characters. A repeat while the same gaps are open reuses that request. An agent with nothing to set up answers noSetupGaps: true with requestId: null and asks no one. Read the open request with GET /api/v2/agents/getSetupRequest.

Authority

You need agents:read at the agent’s home org unit, and agents:read there to see the agent. 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:read at the home the answer is 403 permission_denied, recorded as a refused request. A Personal key asks as its owner; an External App asks with no requesting person.

Rate limit

Each credential may ask 20 times an hour. The 21st call is 429 rate_limited with a Retry-After header (seconds) and writes nothing. A replay spends no slot.

What is withheld

The people a request asks are never returned, only their count (audienceCount).

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
note
string

A note shown to the people asked.

Maximum string length: 500

Response

Ask for an agent's missing setup

data
object
required
meta
object
required