Get Agent

Retrieve config for an agent

GET /v1/convai/agents/{agent_id}

Get Agent

cURL

curl --request GET \
  --url https://api.threetone.in/v1/convai/agents/{agent_id} \
  --header 'x-api-key: <api-key>'

200

{
  "agent_id": "agent_7101k5zvyjhmfg983brhmhkd98n6",
  "name": "My Agent",
  "tags": [
    "Customer Support"
  ]
}

Authorizations

APIKeyHeaderHTTPBearer

x-api-key · string · header · required

API key for programmatic access

Path Parameters

agent_id · string · required

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

Example:

"agent_3701k3ttaq12ewp8b7qv5rfyszkz"

Response

200

application/json

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 · AgentPhoneNumberResponseModel · object[]

The phone numbers of the agent

Show child attributes

workflow · AgentWorkflowResponseModel · object

The workflow of the agent

Show child attributes

access_info · ResourceAccessInfo · object

Access information for the user

Show child attributes

tags · string[]

Agent tags for categorization