Pular para o conteúdo principal
POST
/
consultations
/
v2
/
{DAAI_CONSULTATION_ID}
/
recordings
/
{DAAI_RECORDING_ID}
/
finish
Finalizar consulta
curl --request POST \
  --url https://apim.doctorassistant.ai/api/sandbox/consultations/v2/{DAAI_CONSULTATION_ID}/recordings/{DAAI_RECORDING_ID}/finish \
  --header 'Content-Type: application/json' \
  --header 'x-daai-api-key: <api-key>' \
  --data '
{
  "specialty": "generic"
}
'
{
  "id": "s0q0ud3fi1d9kcwjrt8vs50n",
  "transcription": "",
  "recording": {},
  "report": {
    "specialty": "generic",
    "content": {}
  },
  "metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://documentation.doctorassistant.ai/llms.txt

Use this file to discover all available pages before exploring further.

Autorizações

​
x-daai-api-key
string
header
obrigatório

Chave de API para autenticação

Parâmetros de caminho

​
DAAI_CONSULTATION_ID
string
obrigatório
​
DAAI_RECORDING_ID
string
obrigatório

Corpo

application/json
​
specialty
string
padrão:generic

Especialidade da consulta. Se não informada, será considerada como 'generic'

Exemplo:

"generic"

​
reportSchema
object

Esquema do relatório. Se não informado, será considerado o esquema padrão da especialidade ou o configurado globalmente.

  • O campo schema deve ser um JSON Schema válido, conforme a especificação oficial. Isso garante que o relatório gerado siga a estrutura esperada.
  • O campo fewShots deve conter exemplos que satisfazem o schema definido.

Dica: É possível testar e validar a configuração do relatório customizado diretamente no backoffice, na aba de transformação nas configurações da aplicação. Assim, você pode experimentar diferentes schemas e exemplos antes de aplicar em produção.

Resposta

Consulta finalizada com sucesso

​
id
string
obrigatório

ID da consulta

Exemplo:

"s0q0ud3fi1d9kcwjrt8vs50n"

​
transcription
string
obrigatório

Transcrição da consulta

Exemplo:

""

​
recording
object
obrigatório

Informações da gravação

Exemplo:
{}
​
report
object
obrigatório

Relatório da consulta

​
metadata
object
obrigatório

Metadados da consulta

Exemplo:
{}