API Overview
Contexts API
Parameters full description
Note
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 play with the API, please see the Contexts API playground.
If you want to play with the API, please see the Contexts API playground.
POST - Create a new context
POST - Create a new context
Parameters:
name String
Displayed name of the contextdescription String
Description of the contextexternalId String
Unique Identifier of the context you can optionally provideisSynced 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 - Update an existing context
PATCH - Update an existing context
GET - Query the list of contexts or get context individually
GET - Query the list of contexts or get context individually
DELETE - Delete a context by providing its uid
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
RESPONSE DATA
You will get the same response data when calling POST, PATCH or GETNote: When retrieving a collection of contexts, the response will be an array of objects.