Skip to main content
POST
/
api
/
v1
/
appuid
/
{appUid}
/
contexts
Create a new context
curl --request POST \
  --url https://a.api.mindset.ai/api/v1/appuid/{appUid}/contexts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "externalId": "<string>",
  "externalTenantId": "<string>",
  "isSynced": true
}
'
{
  "uid": "<string>",
  "name": "<string>",
  "description": "<string>",
  "externalId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "isSynced": true,
  "externalTenantId": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

appUid
string
required

Your application's uid

Minimum string length: 1

Body

application/json
name
string
required

Name of the context

Required string length: 1 - 100
description
string

Description of the context

Maximum string length: 100
externalId
string

Optional External ID of the context

externalTenantId
string

External tenant identifier (optional, immutable after creation)

isSynced
boolean

Is the context synced

Response

Context created successfully

uid
string

Unique ID of the context

name
string
description
string
externalId
string

Optional External ID of the context

createdAt
string<date-time>

Creation timestamp (ISO 8601)

isSynced
boolean

Is the context synced

externalTenantId
string

External tenant identifier