sources

Get source details

Changed on

Gets detailed information about a specific source. This endpoint currently supports local_file source IDs. Crawl source IDs returned by /search or GET /contents/{id} are separate IDs and are not accepted here; use GET /sources/{source_id}/raw to download the stored crawl file content.

Required scope: `knowledge:read`

get/sources/{source_id}

Request

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

Path parameters

source_idstring required

Source ID

Response

Successful retrieval of source

idstring required

Source ID (file ID)

source_group_idstring required

Parent source group ID

namestring required

Name of the source (file name)

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'

The type of the source file

file_sizeinteger

File size in bytes

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

  • 756b9db55259Revision changes
    • warning

      added the new datetime enum value to the /// response property for the response status