Pular para o conteúdo
MyClinicAPI Docs
GET

/v1/onboarding/agent/context

Contexto da Renata antes de responder (token de serviço)

Somente token de serviço com X-Agent-Key: onboarding (permissão onboarding:agent). Pessoa → 403 service_only; outro agente → 403 agent_mismatch; Renata sem assignment na clínica → 403 agent_not_enabled.

Devolve a sessão, as últimas 20 mensagens (ordem crescente), os fatos do perfil (o aprovado em vigor e a proposta aberta de cada chave) e um resumo da clínica (nome, área, tamanho da equipe, cidade, fuso). Nada de conversa de paciente.

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

Authorization: Bearer <TOKEN>X-Clinic-Id: <clinic_id>

Parâmetros

Cabeçalhos

  • X-Clinic-IdstringOpcional

    Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): ^[A-Za-z0-9._-]{1,64}$

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/onboarding/agent/context", {  method: "GET",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "X-Agent-Key": "<agent_key>",  },})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Sucesso.
JSON
{  "data": {    "session": {      "id": "<id>",      "status": "ativa",      "step": "boas_vindas",      "percent": 1,      "version": 1,      "turn": 0,      "awaitingReply": {        "messageId": "<messageId>",        "since": "2026-09-18T14:00:00.000Z",        "stale": true      },      "stepState": {},      "startedAt": "2026-09-18T14:00:00.000Z",      "lastMessageAt": "2026-09-18T14:00:00.000Z",      "completedAt": "2026-09-18T14:00:00.000Z",      "createdAt": "2026-09-18T14:00:00.000Z",      "updatedAt": "2026-09-18T14:00:00.000Z"    },    "recentMessages": [      {        "id": "<id>",        "sessionId": "<sessionId>",        "role": "user",        "turn": 0,        "part": 1,        "seq": 0,        "text": "<text>",        "clientMessageId": "<clientMessageId>",        "inReplyTo": "<inReplyTo>",        "eventId": "<eventId>",        "delivery": "pendente",        "outcome": "ok",        "final": true,        "authorName": "<authorName>",        "sentAt": "2026-09-18T14:00:00.000Z"      }    ],    "facts": [      {        "key": "<key>",        "factId": "<factId>",        "value": "<value>",        "status": "<status>",        "version": 1      }    ],    "clinic": {      "name": "<name>",      "specialty": "<specialty>",      "teamSize": "<teamSize>",      "city": "<city>",      "timezone": "<timezone>"    }  }}

Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.

Códigos de erro

Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

404

Not Found — Recurso não encontrado na clínica ativa.

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites

Testar no Swagger(abre em nova aba)