Skip to main content
POST
/
interactions
cURL
curl --request POST \
  --url https://api.{environment}.corti.app/v2/interactions/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-Name: <tenant-name>' \
  --data '
{
  "encounter": {
    "identifier": "<string>",
    "status": "planned",
    "type": "first_consultation",
    "period": {
      "startedAt": "2023-11-07T05:31:56Z",
      "endedAt": "2023-11-07T05:31:56Z"
    },
    "title": "<string>"
  },
  "assignedUserId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "patient": {
    "identifier": "<string>",
    "name": "<string>",
    "gender": "male",
    "birthDate": "2023-11-07T05:31:56Z",
    "pronouns": "<string>"
  }
}
'
{
  "interactionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "websocketUrl": "<string>"
}

Authorizations

​
Authorization
string
header
required

Input your token

Headers

​
Tenant-Name
string
required

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

Example:

"base"

Body

application/json
​
encounter
object
required

Details about the encounter.

​
assignedUserId
string<uuid>

A unique identifier for the medical professional responsible for this interaction. If nulled, automatically set to a uuid.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
patient
object

Optional patient details.

Response

Returns the newly created interaction with its assigned ID and WebSocket URL for real-time data streaming.

​
interactionId
string<uuid>
required

Unique identifier for the interaction.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

​
websocketUrl
string
required

WebSocket URL for streaming real-time interactions. Append a token in the format: /interactions/{interactionID}/streams?token=Bearer token-value-here