Get an Agent

Returns detailed information for a specific agent.

GET https://api.platica.mx/v1/agents/{agentId}

URL parameters

ParameterTypeDescriptionRequired
agentIdstringUnique identifier of the agent

Response

{
  "workspaces": [
    {
      "id": "ws_001",
      "name": "Soporte Técnico",
      "agents": [
        {
          "id": "agent_789def",
          "name": "Asistente Técnico",
          "status": "active",
          "channel": "whatsapp",
          "owners": [
            "soporte@empresa.com"
          ],
          "comunicationChannel": {
            "channelId": ["channel-1", "channel-2"],
            "phoneNumber": ["phoneNumber-1"]
          },
          "systemPrompt": "Eres un asistente técnico especializado...",
          "activePromptId": "id45iLWReNWPfEGkAbFv",
          "imageUrl": "/images/campaignCreator.png",
          "supportInformation": {
            "supportAddress": "Avenida principal #1",
            "supportEmail": "soporte@platica.mx",
            "supportPhone": "12345689101",
            "serviceHours": {
              "monday": {
                "start": "12:00am",
                "end": "11:59pm",
                "availability": "Abierto"
              }
            }
          },
          "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 }
          },
          "creationDate": null,
          "lastUpdate": "2025-03-14T12:00:00Z"
        }
      ],
      "agentsCount": 1
    }
  ]
}

Response fields

FieldDescription
idInternal agent ID
nameAgent name
statusAgent state: active or inactive
channelAgent platform
ownersList of responsible-user emails
comunicationChannel.channelIdChannel IDs, always as an array
comunicationChannel.phoneNumberPhone numbers, always as an array
systemPromptSystem prompt (active)
activePromptIdID of the active version in the prompt history ; null if the agent has never been edited via the prompt endpoints
imageUrlImage URL
supportInformationSupport configuration and hours
assistanceTriggersHuman-assist triggers
waitMessageWait message
assistanceEnabledWhether human assistance is enabled
recallLastConversationMemory across conversations
enableFileAttachmentsFile attachment reading
disableContextSummarizationKeep the full history
workingMessageConfiguration of the "working" message (see PATCH /v1/agents/{id} for the full shape)
creationDateCreation date in ISO 8601 format
lastUpdateLast update date in ISO 8601 format