/v1/onboarding/session
Iniciar ou retomar o onboarding com a Renata (idempotente)
Cria a sessão da clínica (uma por clínica) e habilita a Renata para a clínica (assignment do agente onboarding). A Renata recebe o evento onboarding.session.started e responde com a saudação.
Idempotente: a primeira chamada devolve 201 (meta.created = true) e emite o evento uma única vez; as seguintes devolvem 200 com a mesma sessão, sem novo evento. Chamadas simultâneas criam uma sessão só.
Sessão já concluída: devolvida como está (200), sem reabrir nem reabilitar a Renata. Teste grátis vencido → 402 trial_expired. Onboarding desligado no ambiente (ONBOARDING_RENATA_ENABLED=false e clínica fora de ONBOARDING_RENATA_CLINICS) → 409 onboarding_disabled.
onboarding:writeDispara:onboarding.session.startedAutenticaçã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-IdstringOpcionalClí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/session", { method: "PUT", headers: { Authorization: "Bearer <TOKEN>", "X-Clinic-Id": "<clinic_id>", },})if (!res.ok) { const { error } = await res.json() throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()Resposta
{ "data": { "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" }, "meta": { "created": true, "webhooks": [ { "event": "appointment.cancelled", "status": "sent" } ] }}{ "data": { "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" }, "meta": { "created": true, "webhooks": [ { "event": "appointment.cancelled", "status": "sent" } ] }}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.
Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).
Unauthorized — Token ausente, inválido ou expirado.
— Teste grátis encerrado: o painel está em modo somente leitura até a ativação do plano (trial_expired).
Forbidden — Autenticado, mas sem permissão (perfil ou clínica).
Conflict — Conflito de estado (duplicidade, transição inválida, conflito de agenda).
Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).
Too Many Requests — Limite de requisições excedido (veja Retry-After).
Internal Server Error — Erro interno (sem detalhes expostos).
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