agents

Update Agent

Update an existing agent.

put/api/agents/{agent_id}

Path parameters

agent_idinteger required

Request body

namestring nullable
descriptionstring nullable
instructionsstring nullable
execution_modestring nullable

Execution mode: flash, balanced, think, or auto

modelsobject nullable
knowledge_basesstring[] nullable
skillsstring[] nullable
tool_categoriesstring[] nullable
suggested_promptsstring[] nullable

Suggested prompt examples for users

logo_base64string nullable
widget_enabledboolean nullable
allowed_domainsstring[] nullable

Response

Successful Response

idinteger required
user_idinteger required
namestring required
descriptionstring nullable required
instructionsstring nullable required
execution_modestring required
modelsobject nullable required
knowledge_basesstring[] required
skillsstring[] required
tool_categoriesstring[] required
suggested_promptsstring[] required
logo_urlstring nullable required
statusstring required
published_atstring nullable required
created_atstring required
updated_atstring required
widget_enabledboolean required
allowed_domainsstring[] required
share_enabledboolean required
share_updated_atstring nullable required

Changes

Changed in 2 of the 4 revisions of this API.6

    • added the required property share_enabled to the response with the 200 status

      response-required-property-added

    • added the required property share_updated_at to the response with the 200 status

      response-required-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional request property allowed_domains

      new-optional-request-property

    • added the new optional request property widget_enabled

      new-optional-request-property

    • added the required property allowed_domains to the response with the 200 status

      response-required-property-added

    • added the required property widget_enabled to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog