Agents Platform

Create Agent

Create an agent from a config object

post/v1/convai/agents/create

Query parameters

enable_versioningboolean

Deprecated: all agents are versioned. This parameter is ignored.

Deprecated: all agents are versioned. This parameter is ignored.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

namestring nullable

A name to make the agent easier to find

tagsstring[] nullable

Tags to help classify and filter the agent

Response

Successful Response

agent_idstring required

ID of the created agent

Example response

{
  "agent_id": "J3Pbu5gP6NNKBscdCdwB"
}

Changes

Changed in 29 of the 49 revisions of this API.636838

    • ○

      added the new deepseek-v41-flash enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new deepseek-v41-flash enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new deepseek-v41-flash enum value to the request property /////////

      request-property-enum-value-added

    • ○

      added the new deepseek-v41-flash enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new deepseek-v41-flash enum value to the request property /////

      request-property-enum-value-added

    • ○

      added the new deepseek-v41-flash enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new deepseek-v41-flash enum value to the request property ////////////

      request-property-enum-value-added

    • ○

      added the new deepseek-v41-flash enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new deepseek-v41-flash enum value to the request property //////////////

      request-property-enum-value-added

  • 14b71caad89713See the full diff
    • ▲

      removed from the ///// request property oneOf list

      request-property-one-of-removed

    • ○

      added the new optional request property //////

      new-optional-request-property

    • ○

      removed discriminator from ///// request property

      request-property-discriminator-removed

    • ○

      added to the ///// request property oneOf list

      request-property-one-of-added

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

  • ee57929773bf129See the full diff
    • ▲

      request property /////// was restricted to a list of enum values

      request-property-became-enum

    • ○

      the request property const value __system_data_collection_topic was removed

      request-property-const-removed

    • ○

      added the new __system_data_collection_topic enum value to the request property ///////

      request-property-enum-value-added

    • ○

      added the new glm-52 enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new glm-52 enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new glm-52 enum value to the request property /////////

      request-property-enum-value-added

    • ○

      added the new glm-52 enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new glm-52 enum value to the request property /////

      request-property-enum-value-added

    • ○

      added the new glm-52 enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new glm-52 enum value to the request property ////////////

      request-property-enum-value-added

    • ○

      added the new glm-52 enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new glm-52 enum value to the request property //////////////

      request-property-enum-value-added

    • ○

      added the new gpt-6-luna enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new gpt-6-luna enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new gpt-6-luna enum value to the request property /////////

      request-property-enum-value-added

    • ○

      added the new gpt-6-luna enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new gpt-6-luna enum value to the request property /////

      request-property-enum-value-added

    • ○

      added the new gpt-6-luna enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new gpt-6-luna enum value to the request property ////////////

      request-property-enum-value-added

    • ○

      added the new gpt-6-luna enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new gpt-6-luna enum value to the request property //////////////

      request-property-enum-value-added

    • ○

      added the new gpt-6-sol enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new gpt-6-sol enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new gpt-6-sol enum value to the request property /////////

      request-property-enum-value-added

    • ○

      added the new gpt-6-sol enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new gpt-6-sol enum value to the request property /////

      request-property-enum-value-added

    • ○

      added the new gpt-6-sol enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new gpt-6-sol enum value to the request property ////////////

      request-property-enum-value-added

    • ○

      added the new gpt-6-sol enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new gpt-6-sol enum value to the request property //////////////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5 enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5 enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new claude-opus-5 enum value to the request property /////////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5 enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new claude-opus-5 enum value to the request property /////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5 enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5 enum value to the request property ////////////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5 enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5 enum value to the request property //////////////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5-5 enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5-5 enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new claude-opus-5-5 enum value to the request property /////////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5-5 enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new claude-opus-5-5 enum value to the request property /////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5-5 enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5-5 enum value to the request property ////////////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5-5 enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new claude-opus-5-5 enum value to the request property //////////////

      request-property-enum-value-added

    • ○

      added the new optional request property ///

      new-optional-request-property

    • ○

      added the new optional request property /////////

      new-optional-request-property

  • 101ef23e39581211See the full diff
    • ▲

      the ///////// request property type changed from object to no type

      request-property-type-changed

    • ●

      removed the request property //////////

      request-property-removed

    • ●

      removed the request property //////////

      request-property-removed

    • ○

      added discriminator to ///////// request property

      request-property-discriminator-added

    • ○

      added the new gpt-6-astra enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new gpt-6-astra enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new gpt-6-astra enum value to the request property /////////

      request-property-enum-value-added

    • ○

      added the new gpt-6-astra enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new gpt-6-astra enum value to the request property /////

      request-property-enum-value-added

    • ○

      added the new gpt-6-astra enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new gpt-6-astra enum value to the request property ////////////

      request-property-enum-value-added

    • ○

      added the new gpt-6-astra enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new gpt-6-astra enum value to the request property //////////////

      request-property-enum-value-added

    • ○

      added to the ///////// request property oneOf list

      request-property-one-of-added

    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

      added the new gemini-3.8-flash enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new gemini-3.8-flash enum value to the request property ///

      request-property-enum-value-added

    • ○

      added the new gemini-3.8-flash enum value to the request property /////////

      request-property-enum-value-added

    • ○

      added the new gemini-3.8-flash enum value to the request property //

      request-property-enum-value-added

    • ○

      added the new gemini-3.8-flash enum value to the request property /////

      request-property-enum-value-added

    • ○

      added the new gemini-3.8-flash enum value to the request property //////

      request-property-enum-value-added

    • ○

      added the new gemini-3.8-flash enum value to the request property ////////////

      request-property-enum-value-added

    • ○

      added the new gemini-3.8-flash enum value to the request property //////////

      request-property-enum-value-added

    • ○

      added the new gemini-3.8-flash enum value to the request property //////////////

      request-property-enum-value-added

  • d393c67c384a1861See the full diff
    • ▲

      removed from the /////// request property anyOf list

      request-property-any-of-removed

    • ▲

      removed from the ////////////// request property anyOf list

      request-property-any-of-removed

    • ▲

      removed from the ////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ///////////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ///////////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ///////////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ///////////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ///////////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ///////////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ///////////// request property oneOf list

      request-property-one-of-removed

    • ▲

      removed from the ///////////// request property oneOf list

      request-property-one-of-removed

    • ○

      added the new optional request property /////////

      new-optional-request-property

    • ○

      added the new optional request property ////////////

      new-optional-request-property

    • ○

      added the new optional request property //////////////

      new-optional-request-property

    • ○

      added the new optional request property ////////////

      new-optional-request-property

    • ○

      added the new optional request property //////////////

      new-optional-request-property

    • ○

      added the new optional request property ///////////

      new-optional-request-property

    • ○

      added the new optional request property /////////////

      new-optional-request-property

    • ○

      added the new optional request property ///////////

      new-optional-request-property

    • ○

      added the new optional request property /////////////

      new-optional-request-property

    • ○

      added the new optional request property ////

      new-optional-request-property

    • ○

      added the new optional request property ////

      new-optional-request-property

    • ○

      added the new optional request property ////////////////

      new-optional-request-property

    • ○

      added the new optional request property ///////////////////

      new-optional-request-property

    • ○

      added the new optional request property /////////////////////

      new-optional-request-property

    • ○

      added the new optional request property ///////////////////

      new-optional-request-property

    • ○

      added the new optional request property /////////////////////

      new-optional-request-property

    • ○

      added the new optional request property //////////////////

      new-optional-request-property

    • ○

      added the new optional request property ////////////////////

      new-optional-request-property

    • ○

      added the new optional request property //////////////////

      new-optional-request-property

    • ○

      added the new optional request property ////////////////////

      new-optional-request-property

    • ○

      added to the /////// request property anyOf list

      request-property-any-of-added

    • ○

      added to the ////////////// request property anyOf list

      request-property-any-of-added

    • ○

      request property ///////// deprecated

      request-property-deprecated

    • ○

      request property //////////// deprecated

      request-property-deprecated

    • ○

      request property ////////////// deprecated

      request-property-deprecated

    • ○

      request property //////////// deprecated

      request-property-deprecated

    • ○

      request property ////////////// deprecated

      request-property-deprecated

    • ○

      request property /////////// deprecated

      request-property-deprecated

    • ○

      request property ///////////// deprecated

      request-property-deprecated

    • ○

      request property /////////// deprecated

      request-property-deprecated

    • ○

      request property ///////////// deprecated

      request-property-deprecated

    • ○

      request property //// deprecated

      request-property-deprecated

    • ○

      request property //////////////// deprecated

      request-property-deprecated

    • ○

      request property /////////////////// deprecated

      request-property-deprecated

    • ○

      request property ///////////////////// deprecated

      request-property-deprecated

    • ○

      request property /////////////////// deprecated

      request-property-deprecated

    • ○

      request property ///////////////////// deprecated

      request-property-deprecated

    • ○

      request property ////////////////// deprecated

      request-property-deprecated

    • ○

      request property //////////////////// deprecated

      request-property-deprecated

    • ○

      request property ////////////////// deprecated

      request-property-deprecated

    • ○

      request property //////////////////// deprecated

      request-property-deprecated

    • ○

      added create_product_quote_request create_service_quote_request send_custom_email discriminator mapping keys to the ////// request property

      request-property-discriminator-mapping-added

    • ○

      added create_product_quote_request create_service_quote_request send_custom_email discriminator mapping keys to the ///////////// request property

      request-property-discriminator-mapping-added

    • ○

      removed run_subagent discriminator mapping keys from the ////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ///////////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ///////////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ///////////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ///////////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ///////////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ///////////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ///////////// request property

      request-property-discriminator-mapping-deleted

    • ○

      removed run_subagent discriminator mapping keys from the ///////////// request property

      request-property-discriminator-mapping-deleted

    • ○

      added to the ////// request property oneOf list

      request-property-one-of-added

    • ○

      added to the ///////////// request property oneOf list

      request-property-one-of-added

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

    • ○

      added the new answering_machine_detection enum value to the request property /////

      request-property-enum-value-added

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