Skip to main content
POST
/
ai
/
v1
/
ingest
Start ingestion workflow
curl --request POST \
  --url https://api.{workspaceId}.clinia.cloud/ai/v1/ingest \
  --header 'Content-Type: multipart/form-data' \
  --form 'patientId=<string>' \
  --form file='@example-file'
{
  "runId": "<string>",
  "status": "started"
}

Headers

​
X-User-Id
string

The ID of the user making the request. Used to associate the request with a specific user.

Body

​
patientId
string
required
Minimum string length: 1
​
file
file
required

Unstructured document with MIME type of: [application/pdf, image/tiff]

Response

Ingestion accepted

Ingestion workflows are async, this response only indicates how to poll the workflow status, not the status of the ingestion itself. Typically, ingesting unstructured documents can take several minutes, while ingesting structured FHIR bundles should complete within seconds (depending on size).

​
runId
string
required

The ID of the ingestion workflow

Minimum string length: 1
​
status
enum<string>
required
Available options:
started