Mindset v3 / Deploy in your app / API Overview

Contexts API

Parameters full description

You can find below the full description of Parameters for each POST/PATCH/GET/DELETE methods and also what parameters you can expect from the API responses.

If you want to test the API, please see the Contexts API playground.

Contexts API reference →

POST - Create a new context

Parameters:

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.

externalTenantId String

External tenant identifier. Valid characters are A-Za-z0-9_-. (optional, immutable after creation)

PATCH - Update an existing context

Parameters:

name String

Displayed name of the context

description String

Description of the context

externalTenantId String

External tenant identifier. Valid characters are A-Za-z0-9_-. (optional, immutable after creation)

GET - Query the list of contexts or get context individually

Parameters:

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.

externalTenantId String

Filter results to a specific externalTenantId

DELETE - 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

Note: When retrieving a collection of contexts, the response will be an array of objects.

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

Set to True when you need to syncronize the context files with an ingestion integrated process (Via Cyclr)