content

Get content

Changed on

Get through indexed content.

Required scope: `knowledge:read`

get/contents/{id}

Request

  • Base URL
    https://developer.qaip.com/api/v1
  • URL
    https://developer.qaip.com/api/v1/contents/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring uuid required

Query parameters

authz_policystring

(reserved for future use) Name of the registered authz policy to evaluate when fetching the content. Defaults to the reserved "default" policy when omitted. Ignored when authz is disabled.

principal_idstring

Identifier of the end-user (principal) on whose behalf the content is fetched. Used to look up authz subject attributes. Empty subject when omitted. Ignored when authz disabled.

Response

Successful get content

idstring required

Content ID

textstring required

Content chunk from the source

urlstring required

Source URL of the content

titlestring required

Title of the content or document

timestampinteger required

Unix timestamp when the content was indexed

file_type'html' | 'pdf' | 'ppt' | 'pptx' | 'pptm' | 'doc' | 'docx' | 'docm' | 'xls' | 'xlsx' | 'xlsm' | 'md' | 'txt' | 'jsonl' | 'png' | 'jpg' | 'webp' | 'heic' | 'heif' | 'wav' | 'mp3' | 'aiff' | 'aac' | 'm4a' | 'ogg' | 'flac' | 'mp4' | 'mpg' | 'mov' | 'avi' | 'flv' | 'webm' | 'wmv' | '3gp' | 'notion_page' required

The type of the source file

page_numberinteger required

Page number for paginated documents like PDFs. Set to 0 for sources without page numbers

source_type'crawl' | 'local_file' | 'google_drive' | 'github' | 'notion' required

The type of the source

source_idstring

Optional source ID for the original source. For crawl content, use this value with GET /sources/{source_id}/raw to download the stored crawl file content. For local_file content, use GET /sources/{source_id} for source details.

keywordsstring[]

Changes

  • 2489c6f1a9d8Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • dda59d58227cRevision changes
    • info

      added the optional property to the response with the status