List Agents

Returns the list of every agent available across your workspaces.

GET https://api.platica.mx/v1/agents

Response

{
  "workspaces": [
    {
      "id": "ws_123",
      "name": "Soporte Técnico",
      "agents": [
        {
          "id": "agent_789def",
          "name": "Asistente Técnico",
          "status": "active",
          "channel": "whatsapp",
          "systemPrompt": "Eres un asistente técnico especializado...",
          "activePromptId": "id45iLWReNWPfEGkAbFv",
          "imageUrl": "/images/campaignCreator.png",
          "supportInformation": null,
          "assistanceTriggers": "",
          "waitMessage": "",
          "assistanceEnabled": true,
          "recallLastConversation": false,
          "enableFileAttachments": true,
          "disableContextSummarization": null,
          "workingMessage": {
            "enabled": true,
            "trigger": { "type": "toolCallCount", "minToolCalls": 2 },
            "message": { "enabled": true, "mode": "fixed", "fixedText": "Dame un momento, estoy procesando…" },
            "sticker": { "enabled": false }
          },
          "owners": [
            "soporte@empresa.com"
          ],
          "comunicationChannel": {
            "channelId": ["channel-1", "channel-2"],
            "phoneNumber": ["phoneNumber-1", "phoneNumber-2"]
          },
          "creationDate": null,
          "lastUpdate": "2025-02-14T12:00:00Z"
        }
      ],
      "agentsCount": 1
    }
  ]
}

Response fields

Field	Description
`id`	Internal agent ID
`name`	Agent name
`status`	Agent state: `active` or `inactive`
`channel`	Agent platform
`systemPrompt`	System prompt (active)
`activePromptId`	ID of the active version in the prompt history ; `null` if the agent has never been edited via the prompt endpoints
`imageUrl`	Agent image URL
`supportInformation`	Support information and hours
`assistanceTriggers`	Human-assist triggers
`waitMessage`	Wait message
`assistanceEnabled`	Whether human assistance is enabled
`recallLastConversation`	Memory across conversations
`enableFileAttachments`	File attachment reading
`disableContextSummarization`	Keep the full history
`workingMessage`	Configuration of the "working" message (see `PATCH /v1/agents/{id}` for the full shape)
`owners`	List of responsible-user emails
`comunicationChannel.channelId`	Channel IDs, always as an array
`comunicationChannel.phoneNumber`	Phone numbers, always as an array
`creationDate`	Creation date in ISO 8601 format
`lastUpdate`	Last update date in ISO 8601 format

Previous Introduction Next Get an Agent