API reference

API reference · Agents

Publish an agent, or change its public words

PUT/api/account/agents/{id}/publicationSigned in session

Visitors who sign in run it on their own balance, never the owner's. Same origin only. A 404 while hosted runs or public agents (ANTIMATTER_AGENT_PUBLISH) are off on the deployment.

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredstringThe agent's id.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
namerequiredstring
descriptionstring or null
slugstring or null

Example

{
  "name": "string",
  "description": "string",
  "slug": "string"
}

Answer 200

The publication.

The answer's fields are not named in the document.

Errors

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 404OpenAI shaped error.
  • 409OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter