Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/onboarding/agent/replies

Resposta da Renata (token de serviço, idempotente por turno e parte)

Somente token de serviço com X-Agent-Key: onboarding (permissão onboarding:agent); pessoa → 403 service_only, outro agente → 403 agent_mismatch.

inReplyTo: null = saudação (turno 0, responde onboarding.session.started); senão, o id da mensagem do usuário (responde onboarding.message.created). eventId precisa ser o do evento respondido (422 event_mismatch). Até 4 partes (part 0–3); final: true encerra o turno e libera o próximo envio do usuário. outcome: "failed" = a IA falhou (mande um texto curto e final: true); nesse caso nextStep/percent são ignorados.

Idempotência por (turno, parte): repetição idêntica → 200 com Idempotent-Replayed: true; mesma parte com outro conteúdo → 409 idempotency_key_reused. Turno que já terminou ou foi superado (ex.: saudação depois da primeira mensagem) → 409 stale_reply (descarte). Onboarding concluído → 409 onboarding_closed (descarte).

`proposedFacts`: cada item vira um fato proposto (idempotente pelo hash de chave, valor e mensagem de origem; a proposta nova substitui a aberta da mesma chave; 3 tentativas em conflito de versão). sourceMessageId precisa ser uma mensagem do usuário desta sessão. Itens com problema voltam em rejectedFacts (unknown_fact_key, invalid_fact_value, looks_like_personal_data, invalid_source_message, version_conflict) sem derrubar a resposta. Nada entra no contexto dos agentes antes da aprovação de uma pessoa da clínica.

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}$

Corpo da requisição

application/json · obrigatório

  • eventIdstringObrigatório

    event_id do evento respondido (onboarding.session.started na saudação; onboarding.message.created nos turnos).

  • inReplyTostring | nullObrigatório

    Mensagem do usuário respondida; null = saudação (turno 0). · Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

  • partintegerObrigatório

    Parte da resposta (0–3). Idempotência por (turno, parte). · Entre 0 e 3

  • textstringObrigatório

    Entre 1 e 4000 caracteres · Padrão (regex): \S

  • outcomestringObrigatório

    failed = a IA falhou; mande um texto curto e final: true. · Valores: ok, failed

  • finalbooleanObrigatório

    true = última parte do turno: libera o próximo envio do usuário.

  • nextStepstringOpcional

    Passo da entrevista (concluido só pela conclusão, feita por um humano membro da clínica). · Valores: boas_vindas, servicos, horarios, precos, convenios, politica_cancelamento, tom_de_voz, endereco, revisao

  • percentintegerOpcional

    Entre 0 e 100

  • proposedFactsobject[]Opcional

    Propostas de fato (até 10), gravadas como proposto para a pessoa da clínica aprovar. Idempotentes (mesma chave, valor e mensagem de origem). Uma proposta nova substitui a aberta da mesma chave. Itens com problema voltam em rejectedFacts, sem derrubar a resposta. · Até 10 itens

  • keystringObrigatório
    proposedFacts[].key

    Chave do fato: servicos, horarios, precos, convenios, politica_cancelamento, tom_de_voz, endereco. Desconhecida → item em rejectedFacts (unknown_fact_key). · Entre 1 e 64 caracteres

  • valueanyObrigatório
    proposedFacts[].value

    Valor proposto, no formato da chave (veja os esquemas Fato* em PUT /v1/onboarding/facts/{key}).

  • sourceMessageIdstringObrigatório
    proposedFacts[].sourceMessageId

    Mensagem DO USUÁRIO desta sessão que sustenta o fato. · Entre 1 e 64 caracteres

  • evidencestringObrigatório
    proposedFacts[].evidence

    Trecho citado da mensagem. · Até 280 caracteres

  • confidencenumberObrigatório
    proposedFacts[].confidence

    Entre 0 e 1

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/replies", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "X-Agent-Key": "<agent_key>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "eventId": "<eventId>",    "inReplyTo": "<inReplyTo>",    "part": 1,    "text": "<text>",    "outcome": "ok",    "final": true,    "nextStep": "boas_vindas",    "percent": 1  }),})​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": {    "message": {      "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"    },    "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"    },    "facts": [      {        "key": "<key>",        "factId": "<factId>",        "status": "proposto",        "version": 1      }    ],    "rejectedFacts": [      {        "key": "<key>",        "code": "unknown_fact_key",        "message": "<message>"      }    ]  },  "meta": {    "idempotent": true  }}
201Created — Sucesso.
JSON
{  "data": {    "message": {      "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"    },    "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"    },    "facts": [      {        "key": "<key>",        "factId": "<factId>",        "status": "proposto",        "version": 1      }    ],    "rejectedFacts": [      {        "key": "<key>",        "code": "unknown_fact_key",        "message": "<message>"      }    ]  },  "meta": {    "idempotent": true  }}

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.

409

Conflict — Conflito de estado (duplicidade, transição inválida, conflito de agenda).

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)