Parameters full description
POST - Create a new file in a context
documentContent
sourceUrl
documentContent
documentContent
sourceUrl
sourceUrl
sourceUrl
documentContent
sourceUrl
sourceUrl
sourceUrl
sourceUrl
and documentContent
sourcdocumentContenteUrl
and sourceUrl
viewOriginalSource
is true then when a user is present with this content through discovery as a citation or source then this URL will be opened in a browser tab.This URL can contain variables which will be replaced with specific values for the current user.This URL does not need to be unrestricted. If your agent is embedded in a site requiring a log in and this URL is also on that site the logged in (to your site) user will have a seamless experience.The ingestion process does not use this URL to extract any content.thumbnailUrl
and thumbnail
thumbnailUrl
and thumbnail
externalUrl
in a new tab when a user access a content card, segment or citation from this content item.If the externalUrl
is missing or invalid then the end user will see an error when they try to access a citation / source etc from this filePATCH - Update some data for a file that has already been created
GET - Query for multiple files in a context
createdAt
startAfter
parameter and provide the createdAt
string of the last file in the current results setWhen there are no more results you will receive an empty array in the response and a 404 status coderunId
parameter to POSTDELETE - Delete a file within a context by providing the file uid
RESPONSE DATA
text/html
files that are to be gathered from web pages, the file actually processed will be a PDF generated by printing that web pageviewOriginalSource
is true, the agent suggests this file as relevant to its reply and the user clicks on that segment / citation / source in the UI then the UI will open this URL.externalUrl
FAQs
contentHash
string you sent originally with the appropriate value for you file now.If they are different then you can delete the current file and create a new one for the same externalIdIf you wish you can copy over values for knownAs, name, etc to the newly created file.It is not yet possible to copy over the thumbnail.