Update agent

Update agent

curl --request PATCH \
  --url https://api.threetone.in/v1/convai/agents/{agent_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My agent"
}
'

import requests

url = "https://api.threetone.in/v1/convai/agents/{agent_id}"

payload = { "name": "My agent" }
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'My agent'})
};

fetch('https://api.threetone.in/v1/convai/agents/{agent_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "agent_id": "agent_4m8q7z2pxn5r9vkt6d3h1c0b",
  "name": "My Agent",
  "workflow": {
    "edges": {
      "entry_to_tool_a": {
        "forward_condition": {
          "condition": "Tool A condition",
          "type": "llm"
        },
        "source": "entry_node",
        "target": "tool_node_a"
      },
      "start_to_entry": {
        "forward_condition": {
          "type": "unconditional"
        },
        "source": "start_node",
        "target": "entry_node"
      },
      "tool_a_to_failure": {
        "forward_condition": {
          "successful": false,
          "type": "result"
        },
        "source": "tool_node_a",
        "target": "failure_node"
      },
      "tool_a_to_tool_b": {
        "forward_condition": {
          "successful": true,
          "type": "result"
        },
        "source": "tool_node_a",
        "target": "tool_node_b"
      },
      "tool_b_to_agent_transfer": {
        "forward_condition": {
          "type": "unconditional"
        },
        "source": "tool_node_b",
        "target": "success_transfer"
      },
      "tool_b_to_conversation": {
        "forward_condition": {
          "condition": "Conversation condition",
          "type": "llm"
        },
        "source": "tool_node_b",
        "target": "success_conversation"
      },
      "tool_b_to_end": {
        "forward_condition": {
          "condition": "End condition",
          "type": "llm"
        },
        "source": "tool_node_b",
        "target": "success_end"
      },
      "tool_b_to_phone": {
        "forward_condition": {
          "expression": {
            "children": [
              {
                "name": "force_phone_transfer",
                "type": "dynamic_variable"
              },
              {
                "prompt": "Phone condition",
                "type": "llm",
                "value_schema": {
                  "description": "Phone condition",
                  "type": "boolean"
                }
              },
              {
                "left": {
                  "name": "mode",
                  "type": "dynamic_variable"
                },
                "right": {
                  "type": "string_literal",
                  "value": "dev"
                },
                "type": "eq_operator"
              }
            ],
            "type": "or_operator"
          },
          "type": "expression"
        },
        "source": "tool_node_b",
        "target": "success_phone"
      }
    },
    "nodes": {
      "entry_node": {
        "additional_knowledge_base": [],
        "additional_prompt": "",
        "additional_tool_ids": [],
        "auto_advance_after_first_response": false,
        "conversation_config": {},
        "edge_order": [
          "entry_to_tool_a"
        ],
        "entry_behavior": "auto",
        "label": "Entry",
        "position": {
          "x": 0,
          "y": 0
        },
        "type": "override_agent"
      },
      "failure_node": {
        "additional_knowledge_base": [],
        "additional_prompt": "",
        "additional_tool_ids": [],
        "auto_advance_after_first_response": false,
        "conversation_config": {},
        "edge_order": [],
        "entry_behavior": "auto",
        "label": "Failure",
        "position": {
          "x": 0,
          "y": 0
        },
        "type": "override_agent"
      },
      "start_node": {
        "edge_order": [
          "start_to_entry"
        ],
        "position": {
          "x": 0,
          "y": 0
        },
        "type": "start"
      },
      "success_conversation": {
        "additional_knowledge_base": [],
        "additional_prompt": "",
        "additional_tool_ids": [],
        "auto_advance_after_first_response": false,
        "conversation_config": {},
        "edge_order": [],
        "entry_behavior": "auto",
        "label": "Success A",
        "position": {
          "x": 0,
          "y": 0
        },
        "type": "override_agent"
      },
      "success_end": {
        "edge_order": [],
        "position": {
          "x": 0,
          "y": 0
        },
        "type": "end"
      },
      "success_phone": {
        "custom_sip_headers": [],
        "edge_order": [],
        "position": {
          "x": 0,
          "y": 0
        },
        "require_acceptance": false,
        "transfer_destination": {
          "phone_number": "+1234567890",
          "type": "phone"
        },
        "transfer_type": "conference",
        "type": "phone_number"
      },
      "success_transfer": {
        "agent_id": "success_transfer_agent",
        "delay_ms": 0,
        "edge_order": [],
        "enable_transferred_agent_first_message": false,
        "position": {
          "x": 0,
          "y": 0
        },
        "type": "standalone_agent"
      },
      "tool_node_a": {
        "edge_order": [
          "tool_a_to_failure",
          "tool_a_to_tool_b"
        ],
        "position": {
          "x": 0,
          "y": 0
        },
        "tools": [
          {
            "tool_id": "tool_a"
          },
          {
            "tool_id": "tool_b"
          }
        ],
        "type": "tool"
      },
      "tool_node_b": {
        "edge_order": [
          "tool_b_to_conversation",
          "tool_b_to_end",
          "tool_b_to_phone",
          "tool_b_to_agent_transfer"
        ],
        "position": {
          "x": 0,
          "y": 0
        },
        "tools": [
          {
            "tool_id": "tool_a"
          }
        ],
        "type": "tool"
      }
    },
    "prevent_subagent_loops": false
  }
}

{
  "detail": {
    "status": "agent_branch_required",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "detail": {
    "status": "agent_runtime_projection_unavailable",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": {
    "status": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

PATCH

convai

agents

{agent_id}

Update agent

curl --request PATCH \
  --url https://api.threetone.in/v1/convai/agents/{agent_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My agent"
}
'

import requests

url = "https://api.threetone.in/v1/convai/agents/{agent_id}"

payload = { "name": "My agent" }
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'My agent'})
};

fetch('https://api.threetone.in/v1/convai/agents/{agent_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "agent_id": "agent_4m8q7z2pxn5r9vkt6d3h1c0b",
  "name": "My Agent",
  "workflow": {
    "edges": {
      "entry_to_tool_a": {
        "forward_condition": {
          "condition": "Tool A condition",
          "type": "llm"
        },
        "source": "entry_node",
        "target": "tool_node_a"
      },
      "start_to_entry": {
        "forward_condition": {
          "type": "unconditional"
        },
        "source": "start_node",
        "target": "entry_node"
      },
      "tool_a_to_failure": {
        "forward_condition": {
          "successful": false,
          "type": "result"
        },
        "source": "tool_node_a",
        "target": "failure_node"
      },
      "tool_a_to_tool_b": {
        "forward_condition": {
          "successful": true,
          "type": "result"
        },
        "source": "tool_node_a",
        "target": "tool_node_b"
      },
      "tool_b_to_agent_transfer": {
        "forward_condition": {
          "type": "unconditional"
        },
        "source": "tool_node_b",
        "target": "success_transfer"
      },
      "tool_b_to_conversation": {
        "forward_condition": {
          "condition": "Conversation condition",
          "type": "llm"
        },
        "source": "tool_node_b",
        "target": "success_conversation"
      },
      "tool_b_to_end": {
        "forward_condition": {
          "condition": "End condition",
          "type": "llm"
        },
        "source": "tool_node_b",
        "target": "success_end"
      },
      "tool_b_to_phone": {
        "forward_condition": {
          "expression": {
            "children": [
              {
                "name": "force_phone_transfer",
                "type": "dynamic_variable"
              },
              {
                "prompt": "Phone condition",
                "type": "llm",
                "value_schema": {
                  "description": "Phone condition",
                  "type": "boolean"
                }
              },
              {
                "left": {
                  "name": "mode",
                  "type": "dynamic_variable"
                },
                "right": {
                  "type": "string_literal",
                  "value": "dev"
                },
                "type": "eq_operator"
              }
            ],
            "type": "or_operator"
          },
          "type": "expression"
        },
        "source": "tool_node_b",
        "target": "success_phone"
      }
    },
    "nodes": {
      "entry_node": {
        "additional_knowledge_base": [],
        "additional_prompt": "",
        "additional_tool_ids": [],
        "auto_advance_after_first_response": false,
        "conversation_config": {},
        "edge_order": [
          "entry_to_tool_a"
        ],
        "entry_behavior": "auto",
        "label": "Entry",
        "position": {
          "x": 0,
          "y": 0
        },
        "type": "override_agent"
      },
      "failure_node": {
        "additional_knowledge_base": [],
        "additional_prompt": "",
        "additional_tool_ids": [],
        "auto_advance_after_first_response": false,
        "conversation_config": {},
        "edge_order": [],
        "entry_behavior": "auto",
        "label": "Failure",
        "position": {
          "x": 0,
          "y": 0
        },
        "type": "override_agent"
      },
      "start_node": {
        "edge_order": [
          "start_to_entry"
        ],
        "position": {
          "x": 0,
          "y": 0
        },
        "type": "start"
      },
      "success_conversation": {
        "additional_knowledge_base": [],
        "additional_prompt": "",
        "additional_tool_ids": [],
        "auto_advance_after_first_response": false,
        "conversation_config": {},
        "edge_order": [],
        "entry_behavior": "auto",
        "label": "Success A",
        "position": {
          "x": 0,
          "y": 0
        },
        "type": "override_agent"
      },
      "success_end": {
        "edge_order": [],
        "position": {
          "x": 0,
          "y": 0
        },
        "type": "end"
      },
      "success_phone": {
        "custom_sip_headers": [],
        "edge_order": [],
        "position": {
          "x": 0,
          "y": 0
        },
        "require_acceptance": false,
        "transfer_destination": {
          "phone_number": "+1234567890",
          "type": "phone"
        },
        "transfer_type": "conference",
        "type": "phone_number"
      },
      "success_transfer": {
        "agent_id": "success_transfer_agent",
        "delay_ms": 0,
        "edge_order": [],
        "enable_transferred_agent_first_message": false,
        "position": {
          "x": 0,
          "y": 0
        },
        "type": "standalone_agent"
      },
      "tool_node_a": {
        "edge_order": [
          "tool_a_to_failure",
          "tool_a_to_tool_b"
        ],
        "position": {
          "x": 0,
          "y": 0
        },
        "tools": [
          {
            "tool_id": "tool_a"
          },
          {
            "tool_id": "tool_b"
          }
        ],
        "type": "tool"
      },
      "tool_node_b": {
        "edge_order": [
          "tool_b_to_conversation",
          "tool_b_to_end",
          "tool_b_to_phone",
          "tool_b_to_agent_transfer"
        ],
        "position": {
          "x": 0,
          "y": 0
        },
        "tools": [
          {
            "tool_id": "tool_a"
          }
        ],
        "type": "tool"
      }
    },
    "prevent_subagent_loops": false
  }
}

{
  "detail": {
    "status": "agent_branch_required",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "detail": {
    "status": "agent_runtime_projection_unavailable",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": {
    "status": "<string>",
    "message": "<string>",
    "request_id": "<string>"
  }
}

Headers

x-api-key

string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

agent_id

string

required

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

Example:

"agent_3701k3ttaq12ewp8b7qv5rfyszkz"

Query Parameters

branch_id

string | null

The ID of the branch to use

Example:

"agtbrch_0901k4aafjxxfxt93gd841r7tv5t"

Body

application/json

conversation_config

ConversationalConfigPatch · object | null

Conversation configuration for an agent

Show child attributes

Example:

{
  "asr": {
    "model_id": "elevenlabs/scribe_v2_realtime",
    "options": {
      "schema_id": "elevenlabs_scribe_v2_realtime_asr_options_v1"
    },
    "recognition": { "mode": "automatic_provider_languages" }
  },
  "tts": {
    "model_id": "cartesia/sonic-3.6",
    "options": {
      "schema_id": "cartesia_sonic_tts_options_v1",
      "speed": 1
    },
    "voice_id": "voice_cartesia_example"
  }
}

platform_settings

AgentPlatformSettingsPatch · object | null

Platform settings for the agent are all settings that aren't related to the conversation orchestration and content.

Show child attributes

workflow

AgentWorkflowRequestModel · object

Workflow for the agent. This is used to define the flow of the conversation and how the agent interacts with tools.

Show child attributes

name

string | null

A name to make the agent easier to find

Example:

"My agent"

Response

Successful Response

agent_id

string

required

The ID of the agent

name

string

required

The name of the agent

conversation_config

ConversationalConfigAPIModel · object

required

The conversation configuration of the agent

Show child attributes

metadata

AgentMetadataResponseModel · object

required

The metadata of the agent

Show child attributes

platform_settings

AgentPlatformSettingsResponseModel · object

The platform settings of the agent

Show child attributes

phone_numbers

(GetPhoneNumberManagedPSTNResponseModel · object | GetPhoneNumberSIPTrunkResponseModel · object)[]

The phone numbers of the agent

GetPhoneNumberManagedPSTNResponseModel
GetPhoneNumberSIPTrunkResponseModel

Show child attributes

Example:

{
  "fulfillment_provider": "twilio",
  "label": "Customer Support",
  "phone_number": "+1234567890",
  "phone_number_id": "phone_123",
  "source_type": "managed_pstn"
}

whatsapp_accounts

GetWhatsAppAccountResponse · object[]

WhatsApp accounts assigned to the agent

Show child attributes

workflow

AgentWorkflowResponseModel · object

The workflow of the agent

Show child attributes

Example:

{
  "edges": {
    "start_to_support": {
      "forward_condition": { "type": "unconditional" },
      "source": "start_node",
      "target": "support"
    },
    "support_to_end": {
      "forward_condition": {
        "condition": "The request is resolved",
        "type": "llm"
      },
      "source": "support",
      "target": "end"
    }
  },
  "nodes": {
    "end": {
      "edge_order": [],
      "position": { "x": 0, "y": 0 },
      "type": "end"
    },
    "start_node": {
      "edge_order": ["start_to_support"],
      "position": { "x": 0, "y": 0 },
      "type": "start"
    },
    "support": {
      "additional_knowledge_base": [],
      "additional_prompt": "",
      "additional_tool_ids": [],
      "conversation_config": {},
      "edge_order": ["support_to_end"],
      "entry_behavior": "auto",
      "label": "Support",
      "position": { "x": 0, "y": 0 },
      "type": "override_agent"
    }
  },
  "prevent_subagent_loops": false
}

access_info

ResourceAccessInfo · object | null

The access information of the agent for the user

Show child attributes

Example:

{
  "access_source": "creator",
  "creator_email": "john.doe@example.com",
  "creator_name": "John Doe",
  "is_creator": true,
  "role": "admin"
}

Overview

Agents Platform

Workspace

Shared resources

Utilities

Headers

Path Parameters

Query Parameters

Body

Response