Contexts API

POST

Create a new context

name [String]

Displayed name of the context

description [String]

Description of the context

externalId [String]

Unique Identifier of the context you can optionally provide

isSynced [Boolean]

When a context is synced, files ingestion are synced with automatic mechanism (external process). Hence, the files ingested in the context cannot be managed manually via the Mindset App admin portal.

PATCH

This method and endpoints using it are used for updating a context values.

name [String]

Displayed name of the context

description [String]

Description of the context

GET

You can call the main GET endpoint to query the list of contexts or get context individually

startAfter - Querying for “the next page” [String]

Use the startAfter parameter and provide the createdAt string of the last context in the current results set

When there are no more results you will receive an empty array in the response and a 404 status code

DELETE

You can delete a context by providing its uid Note: You cannot delete a context containing files. You will receive a 422 response code if you try.

RESPONSE DATA

You will get the same response data when calling POST, PATCH or GET

uid [String]

Mindset internal context uid

externalId [String]

Unique Identifier of the context you can optionally provide

name [String]

Displayed name of the context

description [String]

Description of the context

createdAt [ISO timestamp]

Context creation date

isSynced [Boolean]