Queue a connection-scoped records export
Creates a durable export job for authorized records covered by the SDK connection. The response contains job status and metadata; artifact materialization is asynchronous.
/api/sdk/v1/records/exportsCreates a durable export job for authorized records covered by the SDK connection. The response contains job status and metadata; artifact materialization is asynchronous.
Authorization
platformApiKey CuraeAI Platform API key using the format Bearer . Keys are opaque credentials such as cae_live_..., not JWTs.
In: header
Header Parameters
Required idempotency key for safe records-export retries.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
curl -X POST "https://example.com/api/sdk/v1/records/exports" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d" }'{ "export": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d", "status": "QUEUED", "resourceTypes": [ "Observation" ], "format": "fhir_ndjson", "includeRawFhir": true, "artifact": { "sha256": "string", "byteSize": "string" }, "errorCode": "string", "queuedAt": "2019-08-24T14:15:22Z", "startedAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "failedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string", "code": "string", "details": {}, "retryable": true}Ingest a connection-scoped SDK-derived signal POST
Persists an SDK-derived signal under the APP tenant when the presented API key has signal:write scope and the SDK connection allows the requested signal type. Signal payloads are limited to JSON objects no larger than 64 KiB and are validated against the namespace's payload schema (shallow event shape — scalars, shallow arrays/objects of scalars; SDK_SIGNAL_PAYLOAD_SCHEMA_MISMATCH on violation). Payloads MUST NOT contain PHI: no identifiers (names, emails, phone numbers, MRNs, external patient ids), free-text clinical notes, diagnoses, or document content — the subject is identified by the connection, and clinical facts belong on the FHIR surfaces. Requests must include Idempotency-Key for safe retries.
Get a connection-scoped records export GET
Returns status and metadata for a durable records export job created by the same SDK connection.