m4Mindset docs

Mindset v3 / Deploy in your app / Context Files

View as Markdown

Retrieve context files

Mindset v3 REST API reference: Context Files.

GET /api/v1/appuid/{appUid}/contexts/{contextUid}/files

Base URL

Requests go to your region's API host, for example https://a.api.mindset.ai. Hosts: https://a.api.mindset.ai, https://b.api.mindset.ai, https://c.api.mindset.ai, https://d.api.mindset.ai.

Authorization

x-api-keystringheaderrequired

Your API key.

Path parameters

appUidstringpathrequired

Your application's uid

contextUidstringpathrequired

Your context's uid

Query parameters

startAfterstringquery

Start after the given createdAt timestamp (ISO 8601) for pagination

runIdstringquery

Filter results to a specific runId

statusstringquery

Filter results for a specific processing status

Responses

200

Successful retrieval

json
{
  "files": [
    {
      "uid": "string",
      "externalId": "string",
      "createdAt": "string",
      "name": "string",
      "status": "string",
      "statusMessage": "string",
      "runId": "string",
      "mimeType": "string",
      "autoPublish": true,
      "hideContentSegments": true,
      "labels": [
        "string"
      ],
      "contentHash": "string",
      "knownAs": "string",
      "externalUrl": "string",
      "viewOriginalSource": true,
      "thumbnailUpdatedByAdmin": true
    }
  ]
}

401

Unauthorized

403

Forbidden

404

ContextFiles not found

500

Internal Server Error

Example request

bash
curl -X GET "https://a.api.mindset.ai/api/v1/appuid/{appUid}/contexts/{contextUid}/files" \
  -H "x-api-key: <your-api-key>"