List agents

GEThttps://api.voice-agent.gowajee.ai/api/agent/list

Returns every agent in your organization, newest first. Use an agent’s id when you create a campaign, and its paramsSchema to build each recipient’s agentParams.

Or copy it from the dashboard

Every agent and its ID is also listed in the dashboard under Build → AI Agents. Click the copy icon next to the ID. Call this endpoint when your system needs the paramsSchema, or needs to pick the agent by itself.

Request

No parameters.

cURL

curl "https://api.voice-agent.gowajee.ai/api/agent/list" \
  -H "X-API-Key: $GOWAJEE_API_KEY"

JavaScript

const res = await fetch('https://api.voice-agent.gowajee.ai/api/agent/list', {
  headers: { 'X-API-Key': process.env.GOWAJEE_API_KEY },
});
const { data: agents } = await res.json();

Python

res = requests.get(
    "https://api.voice-agent.gowajee.ai/api/agent/list",
    headers={"X-API-Key": os.environ["GOWAJEE_API_KEY"]},
    timeout=30,
)
agents = res.json()["data"]

Response

200 OK

{
  "success": true,
  "message": "Get Agent list successfully",
  "data": [
    {
      "id": "33ea7a25-03b2-4614-a004-fa3bf9984bd1",
      "name": "Payment reminder",
      "paramsSchema": {
        "customer_name": {
          "type": "text",
          "required": true,
          "description": "Customer first name"
        },
        "amount_due": {
          "type": "number",
          "required": true,
          "description": "Outstanding amount in baht"
        },
        "is_vip": {
          "type": "boolean",
          "required": false
        }
      }
    }
  ]
}

Field	Type	Description
data[].id	string (UUID)	The agent ID.
data[].name	string	The agent’s name in the dashboard.
data[].paramsSchema	object or null	Maps each parameter name to { type, required, description? }. type is text, number or boolean. It comes from the agent’s published version, so draft changes in the dashboard don’t show here. See paramsSchema.

Other keys can appear inside a paramsSchema entry:

• default: the value the agent uses when a recipient’s agentParams doesn’t have this key.
• spell and pronunciation_map: they control how the agent pronounces the value. You can ignore them.