Skip to main content
GET
/
api
/
v1
/
appuid
/
{appUid}
/
contexts
/
{contextUid}
/
files
/
externalId
/
{externalId}
Retrieve a file by externalId
curl --request GET \
  --url https://a.api.mindset.ai/api/v1/appuid/{appUid}/contexts/{contextUid}/files/externalId/{externalId} \
  --header 'x-api-key: <api-key>'
{
  "uid": "<string>",
  "externalId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "status": "<string>",
  "runId": "<string>",
  "mimeType": "<string>",
  "autoPublish": true,
  "hideContentSegments": true,
  "labels": [
    "<string>"
  ],
  "contentHash": "<string>",
  "knownAs": "<string>",
  "externalUrl": "<string>",
  "viewOriginalSource": true,
  "thumbnailUpdatedByAdmin": true
}

Authorizations

x-api-key
string
header
required

Path Parameters

appUid
string
required

Your application's uid

Minimum length: 1
contextUid
string
required

Your context's uid

Minimum length: 1
externalId
string
required

Unique externalId of the file

Response

Successful retrieval

uid
string

Unique identifier

externalId
string

Optional External ID of the file

createdAt
string<date-time>

Creation timestamp (ISO 8601)

name
string

Name to display to the end user

status
string

Status of the resource

runId
string

Run identifier (if specified on ingestion)

mimeType
string

MIME type of the file

autoPublish
boolean

Whether this file will be automatically made available after successful ingestion

hideContentSegments
boolean

Flag to hide file segments in agent responses. Does not hide the knowledge from the agent

labels
string[]

Array of label UIDs to associate wth the file

Maximum length: 10
contentHash
string

Externally provided content hash string to enable decisions on when to replace the file

knownAs
string

How the agent can refer to this item. Eg webinar, presentation, paper, specification etc

externalUrl
string<uri>

External URL to launch when aa user wishes to view this file

viewOriginalSource
boolean

Flag to view using the provided externalUrl. Otherwise inbuilt player will be used

thumbnailUpdatedByAdmin
boolean

If a thumbnail has been changed by an admin this boolean will allow automated updates to skip replacing the thumbnail

I