Pular para o conteúdo
AdiosDocumentação
Explorar a documentação

API de sessões de agentes

Gerencie o estado da conversa. Criar um registro de sessão, por si só, não inicia uma execução de IA. Use o aplicativo Adios ou a integração MCP para iniciar o trabalho do agente.

Usar Autenticação da API para pedidos protegidos. Exemplos usam seus próprios IDs de recursos e um token temporário; exemplos de resposta salvos são sintéticos.

MétodoCaminhoOperação
GET/v1/agent_sessionListar sessões de agentes
POST/v1/agent_sessionCriar sessão de agente
GET/v1/agent_session/{id}Obter sessão do agente
PUT/v1/agent_session/{id}Atualizar sessão de agente
DELETE/v1/agent_session/{id}Apagar a sessão do agente
GET/v1/agent_session/{id}/stateObter o estado da sessão do agente
GET/v1/agent_session/{id}/planObter o plano de sessão do agente
POST/v1/agent_session/{id}/runs/{run_id}/cancelCancelar a execução do agente

Listar sessões de agentes

GET /v1/agent_session

Retorna uma lista paginada de AgentSession

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.
pageconsultanãoNúmero da página
per_pageconsultanãoItens por página

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/agent_session" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Lista de AgentSession

Campos de resposta

CampoTipoDescrição
dataarray
data[].agent_session_idstring
data[].channel_idstring
data[].company_project_idstring
data[].context_snapshotobjeto
data[].created_atinteiro(Timestamp Unix)
data[].deleted_atinteiro(Timestamp Unix)
data[].last_message_atinteiro(Timestamp Unix)
data[].memory_summaryobjeto
data[].metadataobjeto
data[].modestringValores permitidos: build, debug, ops, review, chat.
data[].modelstring
data[].owner_idstring
data[].providerstring
data[].sharing_scopestringValores permitidos: private, team.
data[].sourcestringValores permitidos: app, slack, cli.
data[].statusstringValores permitidos: active, paused, blocked, complete, failed.
data[].team_idstring
data[].thread_idstring
data[].updated_atinteiro(Timestamp Unix)
data[].workspace_idstring
data[].writable_repository_idstring
paginationobjeto
pagination.pageinteiroNúmero da página atual
pagination.per_pageinteiroNúmero de itens por página
pagination.totalinteiroNúmero total de itens

Exemplo ilustrativo; não é uma resposta real:

{
  "data": [
    {
      "agent_session_id": "000000000000000000000000001",
      "channel_id": "",
      "company_project_id": "",
      "context_snapshot": {},
      "created_at": 1791072000,
      "deleted_at": 0,
      "last_message_at": 0,
      "memory_summary": {},
      "metadata": {},
      "mode": "chat",
      "model": "",
      "owner_id": "",
      "provider": "",
      "sharing_scope": "private",
      "source": "app",
      "status": "active",
      "team_id": "000000000000000000000000001",
      "thread_id": "",
      "updated_at": 1791072000,
      "workspace_id": "",
      "writable_repository_id": ""
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Criar sessão de agente

POST /v1/agent_session

Cria um novo objeto AgentSession

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Campos da requisição (o corpo contém um exemplo editável):

CampoTipoObrigatórioDescrição
channel_idstringnãoPadrão: "".
company_project_idstringnãoPadrão: "".
context_snapshotobjetonão
last_message_atinteironão(Timestamp Unix) Padrão: 0.
memory_summaryobjetonão
metadataobjetonão
modestringsimValores permitidos: build, debug, ops, review, chat. Padrão: "chat".
modelstringnãoPadrão: "".
owner_idstringnãoPadrão: "".
providerstringnãoPadrão: "".
sharing_scopestringsimValores permitidos: private, team. Padrão: "private".
sourcestringsimValores permitidos: app, slack, cli.
statusstringsimValores permitidos: active, paused, blocked, complete, failed. Padrão: "active".
team_idstringsim
thread_idstringnãoPadrão: "".
workspace_idstringnãoPadrão: "".
writable_repository_idstringnãoPadrão: "".

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/agent_session" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "team_id": "YOUR_TEAM_ID",
  "owner_id": "YOUR_USER_ID",
  "workspace_id": "YOUR_WORKSPACE_ID",
  "sharing_scope": "private",
  "source": "app",
  "mode": "chat",
  "status": "active"
}
JSON

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 201

AgentSession criado

Campos de resposta

CampoTipoDescrição
agent_session_idstring
channel_idstring
company_project_idstring
context_snapshotobjeto
created_atinteiro(Timestamp Unix)
deleted_atinteiro(Timestamp Unix)
last_message_atinteiro(Timestamp Unix)
memory_summaryobjeto
metadataobjeto
modestringValores permitidos: build, debug, ops, review, chat.
modelstring
owner_idstring
providerstring
sharing_scopestringValores permitidos: private, team.
sourcestringValores permitidos: app, slack, cli.
statusstringValores permitidos: active, paused, blocked, complete, failed.
team_idstring
thread_idstring
updated_atinteiro(Timestamp Unix)
workspace_idstring
writable_repository_idstring

Exemplo ilustrativo; não é uma resposta real:

{
  "agent_session_id": "000000000000000000000000001",
  "channel_id": "",
  "company_project_id": "",
  "context_snapshot": {},
  "created_at": 1791072000,
  "deleted_at": 0,
  "last_message_at": 0,
  "memory_summary": {},
  "metadata": {},
  "mode": "chat",
  "model": "",
  "owner_id": "",
  "provider": "",
  "sharing_scope": "private",
  "source": "app",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "thread_id": "",
  "updated_at": 1791072000,
  "workspace_id": "",
  "writable_repository_id": ""
}

Obter sessão do agente

GET /v1/agent_session/{id}

Retorna um objeto AgentSession

Defina agent_session_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/agent_session/${ADIOS_AGENT_SESSION_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

AgentSession

Campos de resposta

CampoTipoDescrição
agent_session_idstring
channel_idstring
company_project_idstring
context_snapshotobjeto
created_atinteiro(Timestamp Unix)
deleted_atinteiro(Timestamp Unix)
last_message_atinteiro(Timestamp Unix)
memory_summaryobjeto
metadataobjeto
modestringValores permitidos: build, debug, ops, review, chat.
modelstring
owner_idstring
providerstring
sharing_scopestringValores permitidos: private, team.
sourcestringValores permitidos: app, slack, cli.
statusstringValores permitidos: active, paused, blocked, complete, failed.
team_idstring
thread_idstring
updated_atinteiro(Timestamp Unix)
workspace_idstring
writable_repository_idstring

Exemplo ilustrativo; não é uma resposta real:

{
  "agent_session_id": "000000000000000000000000001",
  "channel_id": "",
  "company_project_id": "",
  "context_snapshot": {},
  "created_at": 1791072000,
  "deleted_at": 0,
  "last_message_at": 0,
  "memory_summary": {},
  "metadata": {},
  "mode": "chat",
  "model": "",
  "owner_id": "",
  "provider": "",
  "sharing_scope": "private",
  "source": "app",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "thread_id": "",
  "updated_at": 1791072000,
  "workspace_id": "",
  "writable_repository_id": ""
}

Atualizar sessão de agente

PUT /v1/agent_session/{id}

Atualiza um objeto AgentSession existente

Defina agent_session_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Campos da requisição (o corpo contém um exemplo editável):

CampoTipoObrigatórioDescrição
channel_idstringnãoPadrão: "".
company_project_idstringnãoPadrão: "".
context_snapshotobjetonão
last_message_atinteironão(Timestamp Unix) Padrão: 0.
memory_summaryobjetonão
metadataobjetonão
modestringsimValores permitidos: build, debug, ops, review, chat. Padrão: "chat".
modelstringnãoPadrão: "".
owner_idstringnãoPadrão: "".
providerstringnãoPadrão: "".
sharing_scopestringsimValores permitidos: private, team. Padrão: "private".
sourcestringsimValores permitidos: app, slack, cli.
statusstringsimValores permitidos: active, paused, blocked, complete, failed. Padrão: "active".
team_idstringsim
thread_idstringnãoPadrão: "".
workspace_idstringnãoPadrão: "".
writable_repository_idstringnãoPadrão: "".

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request PUT "$ADIOS_API_URL/v1/agent_session/${ADIOS_AGENT_SESSION_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "team_id": "YOUR_TEAM_ID",
  "owner_id": "YOUR_USER_ID",
  "workspace_id": "YOUR_WORKSPACE_ID",
  "sharing_scope": "private",
  "source": "app",
  "mode": "chat",
  "status": "active"
}
JSON

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 200

AgentSession atualizado

Campos de resposta

CampoTipoDescrição
agent_session_idstring
channel_idstring
company_project_idstring
context_snapshotobjeto
created_atinteiro(Timestamp Unix)
deleted_atinteiro(Timestamp Unix)
last_message_atinteiro(Timestamp Unix)
memory_summaryobjeto
metadataobjeto
modestringValores permitidos: build, debug, ops, review, chat.
modelstring
owner_idstring
providerstring
sharing_scopestringValores permitidos: private, team.
sourcestringValores permitidos: app, slack, cli.
statusstringValores permitidos: active, paused, blocked, complete, failed.
team_idstring
thread_idstring
updated_atinteiro(Timestamp Unix)
workspace_idstring
writable_repository_idstring

Exemplo ilustrativo; não é uma resposta real:

{
  "agent_session_id": "000000000000000000000000001",
  "channel_id": "",
  "company_project_id": "",
  "context_snapshot": {},
  "created_at": 1791072000,
  "deleted_at": 0,
  "last_message_at": 0,
  "memory_summary": {},
  "metadata": {},
  "mode": "chat",
  "model": "",
  "owner_id": "",
  "provider": "",
  "sharing_scope": "private",
  "source": "app",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "thread_id": "",
  "updated_at": 1791072000,
  "workspace_id": "",
  "writable_repository_id": ""
}

Apagar a sessão do agente

DELETE /v1/agent_session/{id}

Exclui um objeto AgentSession

Defina agent_session_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/agent_session/${ADIOS_AGENT_SESSION_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

O recurso foi apagado.

Campos de resposta

CampoTipoDescrição
messagestring

Exemplo ilustrativo; não é uma resposta real:

{
  "message": "Deleted successfully"
}

Obter o estado da sessão do agente

GET /v1/agent_session/{id}/state

Leia o estado da sessão.

Defina agent_session_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/agent_session/${ADIOS_AGENT_SESSION_ID}/state" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Obter o plano de sessão do agente

GET /v1/agent_session/{id}/plan

Leia o plano atual da sessão.

Defina agent_session_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/agent_session/${ADIOS_AGENT_SESSION_ID}/plan" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Cancelar a execução do agente

POST /v1/agent_session/{id}/runs/{run_id}/cancel

Solicitar o cancelamento de uma execução ativa na sessão.

Defina agent_session_id, agent_run_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
run_idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/agent_session/${ADIOS_AGENT_SESSION_ID}/runs/${ADIOS_AGENT_RUN_ID}/cancel" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.