Agents

Update agent metadata

Changed on

Update agent fields. Behavior depends on whether the agent has versioning enabled:

Versioned agents (have an active published version): only metadata fields are accepted — name, description, avatarUrl, telephonyProductId, allowInboundCall, visibleToEveryone. Submitting any config-level field returns 400 with "Agent has versioning enabled. Config changes must be made through drafts.". Use PATCH /agent/{id}/drafts/{draftId}/config instead.

Non-versioned agents (no active version): all configuration fields are accepted, the same full set as POST /agent.

400 is also returned when a cross-field constraint is violated (for example, north_indic language requires transcriberType: pulse).

403 is returned when selecting a gated model (gpt-5.2, electron-kogta, electron-kogta-v2) without org-level access.

patch/agent/{id}

Request

  • Base URL
    https://api.smallest.ai/atoms/v1
  • URL
    https://api.smallest.ai/atoms/v1/agent/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Request body

namestring

Name of the agent.

descriptionstring

Description of the agent.

avatarUrlstring

URL of the agent's avatar image.

telephonyProductIdstring[]

IDs of telephony products (phone numbers) to associate with the agent.

allowInboundCallboolean

Whether the agent accepts inbound calls.

visibleToEveryoneboolean

Whether the agent is visible to all members of the organization.

Response

Agent updated successfully

statusboolean
datastring

The ID of the updated agent

Example response

{
  "status": true,
  "data": "60d0fe4f5311236168a109ca"
}

Changes

  • 7131fe74f3cbRevision changes
    • breaking

      the request property type changed from string to array

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • 801f1d220d57Revision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the new optional request property