All pages

API reference

Publish an agent

POST /v1/agents/{agent_id}/publish

View as Markdown

Put the agent live and freeze what went live as its next version — after the console's own Publish check, rehearsals and provider checks included. Refused with every reason it is not ready. Needs agents:write and a live key.

Parameters

Name In Type Required Description
agent_id path string (uuid) Yes

Answer

201 with AgentVersionObject.

Errors

Every error is a problem document with a stable code.

Status When
401 The key is missing, mistyped, unknown, revoked or expired.
403 The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something.
404 This key reaches no such agent.
409 The agent is not ready — errors lists every reason, as the console does — or its project is frozen.
422 Validation Error
429 Too many requests for this key or its organization; see Retry-After.
500 Something went wrong on our side. Quote the request_id to support.

Examples

Publish an agent
#!/bin/sh
# Publish an agent. Runs the console's Publish check first. With a live key.
curl -sS --fail-with-body -X POST "https://api.aigently.ai/v1/agents/9b1d3f5a-7c9e-4b1d-a3f5-7c9e1b3d5f7a/publish" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY" \
  --json '{
  "note": "Booking wording"
}'

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.