Async visit jobs
Queue text or audio and poll or use webhooks
Async visit jobs
Use jobs when you prefer not to hold an HTTP connection open for transcription + note generation.
Create a visit job
POST /api/v1/jobs/visits with the same fields you would send to POST /api/v1/notes (template_id, conversation_text, and/or audioUrl, optional context).
Optional header:
Idempotency-Key— safe retries return the same job
Response (201):
Poll status
GET /api/v1/jobs/{jobId}
Statuses: queued → processing → completed or failed. Failures include a plain-English error field.
Webhooks
When a project webhook URL is configured, you receive visit.completed or visit.failed instead of polling. See Webhooks.
Sync path unchanged
POST /api/v1/notes behaves exactly as before; jobs are optional.