Create an SDK patient connection

Starts a connection-oriented Curae Connect flow for the SDK app's authenticated user coordinate. The response returns a durable `connection.id` used as `connectionId` in subsequent SDK gateway request bodies. If user action is required, `nextAction` contains a Curae-hosted webview URL to open.

POST/api/sdk/v1/connections

Starts a connection-oriented Curae Connect flow for the SDK app's authenticated user coordinate. The response returns a durable connection.id used as connectionId in subsequent SDK gateway request bodies. If user action is required, nextAction contains a Curae-hosted webview URL to open.

Authorization

platformApiKey

AuthorizationBearer <token>

CuraeAI Platform API key using the format Bearer . Keys are opaque credentials such as cae_live_..., not JWTs.

In: header

Header Parameters

Idempotency-Key*string

Required idempotency key for safe connection-create retries.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

appUserId*string

dataPackages*array<>

Requested connection data packages. signals may be combined with record packages, but a connection must include at least one records package (clinical_summary, labs, conditions, or immunizations). When signals is present, signalTypes is required.

filters?

signalTypes?array<>

handoffReturnUrl?|

deviceKeyCnf?|null

refreshTokenHash?|

sessionTtlSeconds?integer

authorizationTtlSeconds?integer

preferSignup?boolean

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/api/sdk/v1/connections" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "appUserId": "string",    "dataPackages": [      "clinical_summary"    ]  }'

{  "connection": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "customerAccountId": "d8c60791-7301-441c-98e8-5bea9a162d9b",    "appUserId": "string",    "status": "PENDING",    "dataPackages": [      "clinical_summary"    ],    "authorizedAt": "2019-08-24T14:15:22Z",    "expiresAt": "2019-08-24T14:15:22Z",    "revokedAt": "2019-08-24T14:15:22Z",    "actionRequiredReason": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "nextAction": {    "type": "open_webview",    "url": "http://example.com",    "expiresAt": "2019-08-24T14:15:22Z"  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "code": "string",  "details": {},  "retryable": true}