Scribe

Create scribe template

Creates an organization-scoped scribe template for public API job creation, storing reusable prompt text from `structurePrompt` when supplied or from `template` otherwise.

POSTPublic reference baselineLocal writeScribeoperationId: createScribeTemplatehttps://dev-api.quickintell.com/api/v1/scribe/templates

Public reference baselineLocal writePrior auth and clinical

Route status

Public reference baseline

Generated endpoint contract may be shown with caveats, but external publication still needs route registry and release evidence.

Publication status

Baseline reference only

Requires E6 route registry and E9 release evidence before external publication. Also requires E2 side-effect policy before production recipes, SDK inclusion, or try-out access.

Authentication

Bearer API key declared

OpenAPI declares bearer API-key security for this operation.

Tenant context

API-key organization

API-key organization context is authoritative; request organizationId is not a public tenant selector.

Side-effect summary

Local write

May mutate QuickRCM records. It does not prove live payer, EHR, clearinghouse, payment, or communication execution.

Source artifact

docs/openapi/openapi.json

OpenAPI 3.1.0; API 1.0.0.

When to use this endpoint

Use this page as an internal baseline for the prior auth and clinical contract generated for POST /api/v1/scribe/templates. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Documents the generated POST /api/v1/scribe/templates contract as a local write baseline endpoint.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Mutating behavior still needs side-effect and retry evidence.

Not public from this page

Live external side effects, file contents, credentials, webhooks, SDK promises, and production recipes are still gated.

Headers and tenancy

Current headers and tenant authority. Target headers stay labeled as future until OpenAPI and release evidence declare them.

Header	Required	Current status	Notes
Authorization	Yes	Current	Bearer <QUICKRCM_API_KEY>. OpenAPI security: bearerAuth.
Idempotency-Key	No	Target/future	Do not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-Id	No	Target/future	Use for support correlation only after approved; not declared as a standard OpenAPI header today.

Required scopes

Unclassified until E6 route metadata exists; do not infer scopes from route names.

Wrong-org behavior

Tenant-safe 404, empty list, or 403 is endpoint-specific and remains an evidence gap until E1 is closed.

Actor and audit

No public actor, audit, or correlation contract is published from OpenAPI alone.

Idempotency and retries

Retry behavior is documented conservatively because universal idempotency headers are not declared.

Topic	Status	Guidance
Current idempotency	No idempotency mechanism is declared.	Do not retry blindly. Check resource, status, batch, or job state before repeating the request.
Universal header	Not declared	Do not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behavior	Unresolved	Same-key changed-payload, in-flight retry, fingerprint scope, and TTL behavior remain endpoint-specific evidence gaps.

Async jobs and polling

Queued work is accepted work, not proof of completed workflow execution.

Topic	Status	Guidance
Immediate response	No 202 response declared	OpenAPI does not declare HTTP 202 for this operation.
Polling and terminal states	Endpoint-specific	Use only operation-specific status endpoints visible in OpenAPI; generic job behavior, cancellation, retries, and retention are unresolved.
Later side effects	Not proven	Do not infer background execution beyond the documented response.

Files and artifacts

File-like routes need content-class, ownership, scanning, retention, and URL policy evidence before public recipes.

Topic	Status	Guidance
Content class	No file/artifact class inferred	OpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keys	Not applicable unless a file field is present	Tenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retention	Unresolved unless endpoint-specific evidence exists	Short-lived URLs, MIME limits, checksums, scanner status, retention, expiration, and legal hold behavior are not implied by OpenAPI examples.

Publication warnings

Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Side-Effect Modes Idempotency

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Public reference baseline from documentation classification overlay.	E6 route registry evidence is still required before external publication.
Example validation	Generated examples are internal baseline aids.	No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewed	Implementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.	Refresh this evidence for release workspaces.
Release evidence	E9 required.	No SDK readiness, production readiness, or expanded external docs claim from this endpoint page.

Scribe public API.

Scribe public APIs expose organization-scoped clinical documentation job and template workflows for the AI Clinical Scribe module. The existing module docs describe Scribe as an ambient AI scribe that transcribes encounters and drafts SOAP notes; the public API surface narrows that product workflow to ten bearer-authenticated endpoints for jobs, file metadata attachment, asynchronous processing, attestation, and reusable templates. Tenant context comes from the bearer API key. Public callers should not send `organizationId` or `orgId` tenant selectors. Read endpoints require Scribe read-capable credentials (`scribe:read` or `scribe:write`), while create, update, attach, attest, process, and template-write endpoints require `scribe:write` credentials. The job lifecycle is asynchronous. `createScribeJob` creates a local job in `UPLOADING` status and immediately attempts to enqueue processing with the supplied audio reference. status=QUEUED`. Neither endpoint performs inline transcription, inline note generation, or synchronous clinical validation. The public contract is intentionally conservative around clinical data and files. List responses return job summaries and `hasFinalNote` indicators, not raw transcripts, final notes, audio URLs, signed URLs, storage references, or vendor payloads. Detail and write responses can include `finalNote`, so examples and guidance must treat it as clinical documentation that can contain Protected Health Information (PHI). File attachment records metadata for an already-uploaded organization-scoped audio file and returns sanitized file metadata; it does not upload file bytes, create presigned URLs, or echo storage references. Template endpoints manage reusable prompt configuration and should not be documented as patient-specific note content.

What this endpoint does

Use case

Use this endpoint when an integration needs to define reusable note structure or prompting configuration before creating scribe jobs.

Before calling

Authenticate with a Scribe write-capable API key. Choose a tenant-local template name and decide whether to send `template` or `structurePrompt`. The request requires name plus at least one of template or structurePrompt.

Request and response behavior

Request guidance

`name` is required and capped at 200 characters. `template` and `structurePrompt` are each capped at 10000 characters, `specialty` is nullable and capped at 100 characters, and `isDefault` defaults to false. Keep template content generic and do not include real patient details, transcripts, credentials, tokens, storage references, or vendor payloads.

The endpoint requires template or structurePrompt.
If both template and structurePrompt are supplied, implementation stores structurePrompt.
Template prompts should be reusable configuration, not patient-specific note content.
isDefault defaults to false when omitted.

Response semantics

HTTP 201 returns data.template and meta.organizationId. The response template object includes id, organizationId, name, template, specialty, isDefault, and createdAt. It does not return structurePrompt as a distinct field; the stored prompt is returned as `template`.

The response returns the created template object under data.template.
structurePrompt is not returned as a separate field in the OpenAPI response schema.
No scribe job, transcript, audio URL, or final note is created by this endpoint.

Errors and retries

Treat 400 as invalid template input, including missing template or structurePrompt content, 401/403 as credential or tenant authorization failure, and 429 as a backoff signal. Avoid duplicate template creation in client retries.

400 can indicate missing template or structurePrompt content or field length violations.
Retried POST calls can create duplicate templates unless the client deduplicates.
429 should be retried with backoff.

Template boundary before examples

The route class, authentication state, tenancy rule, side-effect mode, idempotency status, async behavior, file policy, warnings, links, and evidence above are part of the endpoint contract. Treat generated examples below as internal baseline aids until release evidence closes.

Path parameters

This endpoint does not define path parameters.

Query parameters

This endpoint does not define query parameters.

OpenAPI-declared header parameters

Standard platform header guidance appears in the governance panel. This table only lists operation-specific headers declared in OpenAPI.

This endpoint does not define operation-specific header parameters.

Request body

JSON fields from the generated OpenAPI schema with pilot enrichment applied where available. Nested object fields are shown with dotted paths.

Name	Location	Required	Type	Description	Validation and safety notes
name	body	Yes	string	Required template display name, capped at 200 characters.	Minimum length: 1. Maximum length: 200.
template	body	No	string	Reusable scribe template text, capped at 10000 characters. Used when structurePrompt is absent.	Minimum length: 1. Maximum length: 10000.
structurePrompt	body	No	string	Reusable structure prompt for generated note organization, capped at 10000 characters. Stored preferentially when supplied and returned through the public `template` response field.	Minimum length: 1. Maximum length: 10000.
specialty	body	No	string	Optional specialty label for filtering and display, capped at 100 characters.	Minimum length: 1. Maximum length: 100.
isDefault	body	No	boolean	Boolean flag requesting default-template behavior. Defaults to false.	Default: false.

Generated request example

Generated examples are baseline contract aids only. They are not external publication evidence and must not include real PHI, credentials, raw vendor payloads, raw EDI, transcripts, storage keys, or signed URLs.

{
  "name": "Example scribe_template",
  "template": "example-template",
  "structurePrompt": "example-structureprompt",
  "specialty": "example-specialty",
  "isDefault": false
}

Successful responses

Generated response examples show the baseline OpenAPI contract. Tenant identifier echo, PHI redaction, pagination, money, date/time, and enum semantics remain endpoint-specific publication checks.

201

Created organization-scoped scribe template.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "template": {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "name": "Example scribe_template",
      "template": "example-template",
      "specialty": "example-specialty",
      "isDefault": true,
      "createdAt": "2026-06-08T10:15:30Z"
    }
  },
  "meta": {
    "organizationId": "00000000-0000-4000-8000-000000000001"
  }
}

Error responses

Errors must remain sanitized. Do not include raw payer, EHR, SFTP, SMTP, Stripe, LLM/OCR, browser automation, file, transcript, EDI, worker, or vendor payloads.

400

Invalid request.