Agents Platform

Create Agent Draft

Create a new draft for an agent

post/v1/convai/agents/{agent_id}/drafts

Path parameters

agent_idstring required

The id of an agent. This is returned on agent creation.

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

The id of an agent. This is returned on agent creation.

Query parameters

branch_idstring required

The ID of the agent branch to use

Example:agtbrch_8901k4t9z5defmb8vh3e9361y7nj

The ID of the agent branch to use

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.

Request body

conversation_configobject required

Conversation config for the draft

platform_settingsobject required

Platform settings for the draft

namestring required

Name for the draft

tagsstring[] nullable

Tags to help classify and filter the agent

Example request

{
  "workflow": {
    "edges": {
      "entry_to_tool_a": {
        "forward_condition": {
          "condition": "Tool A condition"
        },
        "source": "entry_node",
        "target": "tool_node_a"
      },
      "start_to_entry": {
        "forward_condition": {},
        "source": "start_node",
        "target": "entry_node"
      },
      "tool_a_to_failure": {
        "forward_condition": {
          "successful": false
        },
        "source": "tool_node_a",
        "target": "failure_node"
      },
      "tool_a_to_tool_b": {
        "forward_condition": {
          "successful": true
        },
        "source": "tool_node_a",
        "target": "tool_node_b"
      },
      "tool_b_to_agent_transfer": {
        "forward_condition": {},
        "source": "tool_node_b",
        "target": "success_transfer"
      },
      "tool_b_to_conversation": {
        "forward_condition": {
          "condition": "Conversation condition"
        },
        "source": "tool_node_b",
        "target": "success_conversation"
      },
      "tool_b_to_end": {
        "forward_condition": {
          "condition": "End condition"
        },
        "source": "tool_node_b",
        "target": "success_end"
      },
      "tool_b_to_phone": {
        "forward_condition": {
          "expression": {
            "children": [
              {
                "name": "force_phone_transfer"
              },
              {
                "prompt": "Phone condition",
                "value_schema": {
                  "description": "Phone condition",
                  "type": "boolean"
                }
              },
              {
                "left": {
                  "name": "mode"
                },
                "right": {
                  "value": "dev"
                }
              }
            ]
          }
        },
        "source": "tool_node_b",
        "target": "success_phone"
      }
    },
    "nodes": {
      "entry_node": {
        "conversation_config": {},
        "edge_order": [
          "entry_to_tool_a"
        ],
        "label": "Entry"
      },
      "failure_node": {
        "conversation_config": {},
        "label": "Failure"
      },
      "start_node": {
        "edge_order": [
          "start_to_entry"
        ]
      },
      "success_conversation": {
        "conversation_config": {},
        "label": "Success A"
      },
      "success_end": {},
      "success_phone": {
        "transfer_destination": {
          "phone_number": "+1234567890"
        }
      },
      "success_transfer": {
        "agent_id": "success_transfer_agent"
      },
      "tool_node_a": {
        "edge_order": [
          "tool_a_to_failure",
          "tool_a_to_tool_b"
        ],
        "tools": [
          {
            "tool_id": "tool_a"
          },
          {
            "tool_id": "tool_b"
          }
        ]
      },
      "tool_node_b": {
        "edge_order": [
          "tool_b_to_conversation",
          "tool_b_to_end",
          "tool_b_to_phone",
          "tool_b_to_agent_transfer"
        ],
        "tools": [
          {
            "tool_id": "tool_a"
          }
        ]
      }
    }
  },
  "tags": [
    "Customer Support",
    "Technical Help",
    "Eleven"
  ]
}

Response

Successful Response

{"stackTrail":"paths:/v1/convai/agents/{agent_id}/drafts:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 18 of the 30 revisions of this API.211318

Sep 2, 2026630c650dda663See the full diff
- ○
  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
Sep 1, 202670aad41bc4b91See the full diff
- ○
  added the new optional request property ///////
  new-optional-request-property
Aug 31, 2026aa277505183c824See the full diff
- ▲
  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
- ○
  mapped value for discriminator key end_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key end_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key start_procedure changed from to for ///////////// request property
  request-property-discriminator-mapping-changed
- ○
  added to the ///////////// request property oneOf list
  request-property-one-of-added
- ○
  added to the ///////////// request property oneOf list
  request-property-one-of-added
- ○
  added to the ///////////// request property oneOf list
  request-property-one-of-added
- ○
  added to the ///////////// request property oneOf list
  request-property-one-of-added
- ○
  added to the ///////////// request property oneOf list
  request-property-one-of-added
- ○
  added to the ///////////// request property oneOf list
  request-property-one-of-added
- ○
  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
Aug 27, 2026f366bca2ae3c10See the full diff
- ○
  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
Aug 25, 2026311280aae31f3See the full diff
- ○
  added the new optional request property ///////////
  new-optional-request-property
- ○
  added cancel_order create_order get_client_orders get_order_by_confirmation_number update_order discriminator mapping keys to the ///////////// request property
  request-property-discriminator-mapping-added
- ○
  added to the ///////////// request property oneOf list
  request-property-one-of-added
Aug 20, 2026db6eec599cbe1See the full diff
- ○
  added the new optional request property /////////////
  new-optional-request-property
Aug 19, 20264bbf59c13c422See the full diff
- ○
  added the new context_usage enum value to the request property /////////
  request-property-enum-value-added
- ○
  added the new context_usage enum value to the request property /////////
  request-property-enum-value-added
Aug 19, 2026f053c821dc1829See the full diff
- ○
  request property ////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property /////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property /////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ///////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property //////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property /////////////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property ////////// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
Aug 15, 2026acb0175c05253See the full diff
- ○
  added the new gemini-3.7-flash enum value to the request property ////////////
  request-property-enum-value-added
- ○
  added the new gemini-3.7-flash enum value to the request property //////////
  request-property-enum-value-added
- ○
  added the new gemini-3.7-flash enum value to the request property //////////////
  request-property-enum-value-added
Aug 13, 20266c2d6eb4a7e61See the full diff
- ○
  added the new optional request property /////////
  new-optional-request-property

Full history (18 revisions)