Skip to content
TriedDocs
Chat agents

Get chat agent

Retrieve a chat agent.

GEThttps://api.tried.com.au/get-chat-agent/{chat_agent_id}

Returns the chat agent's current (editable) configuration.

Request#

Path parameters#

Parameter Type Required Description
chat_agent_id string Yes The chat agent.

Example request#

curl "https://api.tried.com.au/get-chat-agent/chat_agent_6a7b8c9d0e1f2a3b4c5d6e7f" \
  -H "Authorization: Bearer $TRIED_API_KEY"
const res = await fetch("https://api.tried.com.au/get-chat-agent/chat_agent_6a7b8c9d0e1f2a3b4c5d6e7f", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const data = await res.json();
import os, requests

res = requests.get(
    "https://api.tried.com.au/get-chat-agent/chat_agent_6a7b8c9d0e1f2a3b4c5d6e7f",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
data = res.json()

Response#

200 OK with the chat agent.

Errors#

Status When
401 Missing or invalid API key.
403 The key's IP allowlist or scopes reject the request. This route needs the calls scope.
404 The chat agent does not exist.
429 Rate limit exceeded. See Rate limits.

See Errors for the body format.