API Threads¶

Use esta API para criar threads usados para interagir com os Cortex Agents.

Criação de thread¶

POST /api/v2/cortex/threads

Cria um thread e retorna o UUID dele.

Solicitação¶

Cabeçalhos de solicitação¶

Cabeçalho	Descrição
`Authorization`	Token de autorização (obrigatório). Para obter mais informações, consulte Autenticação.
`Content-Type`	Aplicativo/json (obrigatório)

Corpo da solicitação¶

O corpo da solicitação pode incluir o seguinte campo:

Campo	Tipo	Descrição
`origin_application`	string	(Opcional) Nome do aplicativo que criou o thread. Permite agrupar threads por aplicativo. Limitado a 16 bytes.

Exemplo:

{
  "origin_application": "my_app"
}

Copy

Resposta¶

Retorna o UUID do thread como uma string.

"1234567890"

Copy

Descrição do thread¶

GET /api/v2/cortex/threads/{id}

Descreve um thread e retorna um lote de mensagens nele, com base em page_size e last_message_id, em ordem decrescente de criação. Essa solicitação só será bem-sucedida se o ID do thread pertencer ao usuário.

Solicitação¶

Parâmetros de caminho¶

Parâmetro	Tipo	Descrição
`id`	inteiro	(Obrigatório) UUID do thread.

Parâmetros de consulta¶

Parâmetro	Tipo	Descrição
`page_size`	inteiro	(Opcional) Número de mensagens a retornar (padrão: 20, máx.: 100).
`last_message_id`	inteiro	(Opcional) O ID da última mensagem recebida. Usado para definir o offset para o próximo lote. Pode estar vazio para o primeiro lote de mensagens.

Cabeçalhos de solicitação¶

Cabeçalho	Descrição
`Authorization`	Token de autorização (obrigatório).
`Content-Type`	Aplicativo/json (obrigatório)

Resposta¶

Retorna um objeto de metadados de thread e uma matriz de mensagens.

Campo	Tipo	Descrição
metadata	objeto	Metadados do thread, incluindo o nome, o aplicativo que criou o thread e a hora em que foi criado.
`messages`	matriz	Matriz de objetos de mensagem.

metadata¶

Campo	Tipo	Descrição
`thread_id`	inteiro	UUID do thread.
`thread_name`	string	Nome do thread.
`origin_application`	string	O nome do aplicativo que criou o thread.
`created_on`	inteiro	Hora em que o thread foi criado (milissegundos desde a época do UNIX).
`updated_on`	inteiro	Hora em que o thread foi atualizado pela última vez (milissegundos desde a época do UNIX). Uma atualização inclui a adição de novas mensagens ao thread.

Mensagens¶

Campo	Tipo	Descrição
`message_id`	inteiro	UUID da mensagem.
`parent_id`	inteiro	UUID da mensagem pai.
`created_on`	inteiro	Hora em que a mensagem foi criada (milissegundos desde a época do UNIX).
`role`	string	A função que gerou essa mensagem.
`message_payload`	string	Carga útil da mensagem.
`request_id`	string	ID da solicitação para a mensagem original.

Exemplo:

{
  "metadata": {
    "thread_id": 1234567890,
    "thread_name": "Support Chat",
    "origin_application": "my_app",
    "created_on": 1717000000000,
    "updated_on": 1717000100000
  },
  "messages": [
    {
      "message_id": 1,
      "parent_id": null,
      "created_on": 1717000000000,
      "role": "user",
      "message_payload": "Hello, I need help.",
      "request_id": "req_001"
    },
    {
      "message_id": 2,
      "parent_id": 1,
      "created_on": 1717000001000,
      "role": "assistant",
      "message_payload": "How can I assist you?",
      "request_id": "req_002"
    }
  ]
}

Copy

Atualização de thread¶

POST /api/v2/cortex/threads/{id}

Atualiza um thread.

Solicitação¶

Parâmetros de caminho¶

Parâmetro	Tipo	Descrição
`id`	inteiro	(Obrigatório) UUID do thread.

Cabeçalhos de solicitação¶

Cabeçalho	Descrição
`Authorization`	Token de autorização (obrigatório).
`Content-Type`	Aplicativo/json (obrigatório)

Corpo da solicitação¶

Campo	Tipo	Descrição
`thread_name`	string	(Opcional) Nome do thread.

Exemplo:

{
  "thread_name": "New Thread Name"
}

Copy

Resposta¶

Retorna o status da atualização do thread.

{"status": "Thread xxxx successfully updated."}

Copy

Listagem de threads¶

GET /api/v2/cortex/threads

Lista todos os threads pertencentes ao usuário.

Solicitação¶

Parâmetros de consulta¶

Parâmetro	Tipo	Descrição
`origin_application`	string	(Opcional) Filtre a lista de threads pelo aplicativo de origem. Sem especificar esse campo, todos os threads são retornados.

Cabeçalhos de solicitação¶

Cabeçalho	Descrição
`Authorization`	Token de autorização (obrigatório).
`Content-Type`	Aplicativo/json (obrigatório)

Resposta¶

Retorna uma matriz de objetos de metadados de thread.

Metadados do thread¶

Campo	Tipo	Descrição
`thread_id`	inteiro	UUID do thread.
`thread_name`	string	Nome do thread.
`origin_application`	string	O nome do aplicativo que criou o thread.
`created_on`	inteiro	Hora em que o thread foi criado (milissegundos desde a época do UNIX).
`updated_on`	inteiro	Hora em que o thread foi atualizado pela última vez (milissegundos desde a época do UNIX). Uma atualização inclui a adição de novas mensagens ao thread.

Exemplo:

[
  {
    "thread_id": 1234567890,
    "thread_name": "Support Chat",
    "origin_application": "my_app",
    "created_on": 1717000000000,
    "updated_on": 1717000100000
  }
]

Copy

Exclusao de thread¶

DELETE /api/v2/cortex/threads/{id}

Exclui um thread e todas as mensagens dele.

Solicitação¶

Parâmetros de caminho¶

Parâmetro	Tipo	Descrição
`id`	inteiro	(Obrigatório) UUID do thread.

Cabeçalhos de solicitação¶

Cabeçalho	Descrição
`Authorization`	Token de autorização (obrigatório).
`Content-Type`	Aplicativo/json (obrigatório)

Resposta¶

Retorna uma resposta de sucesso se o thread for excluído.

{
  "success": true
}

Copy