Authorizations
Path Parameters
Your application's uid
1
Your context's uid
1
Unique externalId of the file
Body
Name of the file
100
Allows the agent to refer to knowledge ingested from this document without ever revealing the source doc
How the agent can refer to this file. eg 'video', 'discussion', 'sales pitch'
200
An external URL to direct an end user to the file for this document
2048
Instruct agent UI to launch the externalUrl provided
Array of label uids (max 10)
10
An external URL for a custom thumbnail for this file. It must point to an image of less than 3MB
2048
A base64 encoded image to use as a thumbnail for this file.
65536
Response
Successful update
Unique identifier
Optional External ID of the file
Creation timestamp (ISO 8601)
Name to display to the end user
Status of the resource
Run identifier (if specified on ingestion)
MIME type of the file
Whether this file will be automatically made available after successful ingestion
Flag to hide file segments in agent responses. Does not hide the knowledge from the agent
Array of label UIDs to associate wth the file
10
Externally provided content hash string to enable decisions on when to replace the file
How the agent can refer to this item. Eg webinar, presentation, paper, specification etc
External URL to launch when aa user wishes to view this file
Flag to view using the provided externalUrl. Otherwise inbuilt player will be used
If a thumbnail has been changed by an admin this boolean will allow automated updates to skip replacing the thumbnail