Skip to main content
GET
/
agents
/
view
Retrieve all custom agents
curl --request GET \
  --url https://api.pawa-ai.com/v1/agents/view \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Agents retrieved successfully",
  "data": [
    {
      "id": 0,
      "agentReferenceId": "67cf5354-89f0-8001-b038-b2645377b214",
      "name": "TutorAI",
      "description": "TutorAI is an AI agent designed to assist students with their studies.",
      "instruction": "Teaching students on subjects ranging from form one to form 4. Follow questions properly and do not answer any other questions apart from what you have been tasked to",
      "status": "ACTIVE",
      "createdAt": "2021-09-01T00:00:00.000Z",
      "updatedAt": "2021-09-01T00:00:00.000Z",
      "intents": [
        "Be gentle",
        "Be detailed"
      ],
      "knowledgeBaseId": 159,
      "tools": [
        {
          "type": "function",
          "function": {
            "name": "convert_usd_to_tsh",
            "description": "Converts an amount in USD to Tanzanian Shillings.",
            "strict": true,
            "parameters": {
              "type": "object",
              "properties": {
                "amount_usd": {
                  "description": "Amount in USD",
                  "type": "number"
                }
              },
              "required": [
                "amount_usd"
              ],
              "additionalProperties": false
            }
          }
        },
        {
          "type": "pawa_tool",
          "pawa_tool": "web_search_tool"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Agents retrieved successfully

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Agents retrieved successfully"

​
data
object[]
required