Listar Mensagens

Ler o histórico de uma conversa, das mensagens mais antigas para as mais recentes. Diferente das outras listas do Chat v1, esta é paginada por cursor: omita before para a página mais recente e depois passe o meta.before de cada resposta para caminhar para trás até que meta.hasMore seja false. Mensagens excluídas são retornadas com content null e sem anexos, em vez de serem omitidas, então o formato do histórico é preservado. Toda operação é delimitada pelo workspaceId obrigatório. Uma API key com escopo de workspace que nomeie qualquer outro workspace é recusada com 403 antes de qualquer consulta rodar, então uma API key de workspace só consegue alcançar o próprio workspace.

GET/api/v1/chat/conversations/{conversationId}/messages

Authorization

apiKey
X-API-Key<token>

Sua API key do Studio, pessoal ou com escopo de workspace. Gere uma em Settings e depois API Keys. As operações que rejeitam API keys de workspace dizem isso na própria descrição.

Em: header

Parâmetros de path

conversationId*string

Conversa cujo histórico é lido.

Tamanho1 <= length

Parâmetros de query

workspaceId*string

Workspace ao qual a conversa pertence.

Tamanho1 <= length
before?string

Cursor ISO 8601. Retorna as mensagens criadas estritamente antes deste instante. Omita para a página mais recente e depois passe o meta.before da resposta anterior para caminhar para trás.

Corresponde a^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Formatodate-time
limit?integer

Mensagens por página, entre 1 e 100. O padrão é 20.

Padrão20
Intervalo1 <= value <= 100

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://agent-studio.seeyu.ai/api/v1/chat/conversations/string/messages?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "messages": [
    {
      "id": "msg_01J9M4Q0X6RA",
      "conversationId": "conv_01J9M4Q0X6R7",
      "content": "Thanks, that fixed it!",
      "messageType": "incoming",
      "private": false,
      "contentType": "text",
      "senderType": "Contact",
      "senderId": "cnt_01J8F2K3N5P9",
      "attachments": [],
      "inReplyToId": null,
      "contentAttributes": null,
      "status": null,
      "createdAt": "2026-08-28T14:22:05.000Z"
    }
  ],
  "meta": {
    "before": null,
    "hasMore": false
  }
}
{
  "error": "Invalid input: expected string, received undefined",
  "details": [
    {
      "code": "invalid_type",
      "expected": "string",
      "path": [
        "phone"
      ],
      "message": "Invalid input: expected string, received undefined"
    }
  ]
}
{
  "error": "Unauthorized"
}
{
  "error": "API key is not authorized for this workspace"
}
{
  "error": "Conversation not found"
}
{
  "error": "Rate limit exceeded",
  "message": "API rate limit exceeded. Please retry after 2026-09-13T12:00:00.000Z",
  "retryAfter": 1789286400000
}
{
  "error": "Internal server error",
  "requestId": "req_01J9Z2K3M4N5P6Q7R8S9T0"
}
PATCHAtualizar ConversaPOSTEnviar Mensagem