POST
/
interactions
curl --request POST \
  --url https://api.{environment}.corti.app/v2/interactions/ \
  --header 'Content-Type: application/json' \
  --data '{
  "assignedUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "encounter": {
    "identifier": "<string>",
    "status": "planned",
    "type": "first_consultation",
    "period": {
      "startedAt": "2023-11-07T05:31:56Z",
      "startedAtTzoffset": "+00:00",
      "endedAt": "2023-11-07T05:31:56Z",
      "endedAtTzoffset": "+00:00"
    },
    "title": "<string>"
  },
  "patient": {
    "identifier": "<string>",
    "name": "<string>",
    "gender": "male",
    "birthDate": "2023-11-07T05:31:56Z",
    "pronouns": "<string>"
  }
}'
{
  "interactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "websocketUrl": "<string>"
}

Headers

​
Tenant-Name
string

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

Example:

"copiloteu"

Body

application/json
​
encounter
object
required

Details about the encounter.

​
assignedUserId
string

A unique identifier for the medical professional responsible for this interaction.

​
patient
object

Optional patient details.

Response

201
application/json
Returns the newly created interaction with its assigned ID and WebSocket URL for real-time data streaming.
​
interactionId
string

Unique identifier for the interaction.

​
websocketUrl
string

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

Was this page helpful?

List All InteractionsGet Existing Interaction