m4Mindset docs

Mindset v3 / Deploy in your app / Context Files

View as Markdown

Retrieve a file by externalId

Mindset v3 REST API reference: Context Files.

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

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

externalIdstringpathrequired

Unique externalId of the file

Responses

200

Successful retrieval

json
{
  "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
}

404

Context or File not found

Example request

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