Skip to main content
POST
Publish agent
Use a user API key with agents:write and an Idempotency-Key. Supply name and a globally unique lowercase handle. The response is agent, with its stable agentId, handle, name, and revision. Visibility defaults to private. This registers a business agent; it never creates a second private personal agent. Publishing a profile does not independently verify an executable route. See Publish quickstart and Agents.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string
required

Stable key for this exact mutation. Reusing it with different input returns 409.

Required string length: 1 - 200

Body

application/json
handle
string
required
Pattern: ^[a-z0-9](?:[a-z0-9-]{0,39}[a-z0-9])?$
name
string
required
Required string length: 1 - 160
description
string
default:""
Maximum string length: 5000
avatarUrl
string<uri> | null
Maximum string length: 2000
visibility
enum<string>
default:PRIVATE
Available options:
PRIVATE,
RESTRICTED,
PUBLIC

Response

Current owner-scoped result. A mutation retry returns its saved response.

agent
object
required
Last modified on October 19, 2026