GET
/
sources
/
{source_id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

source_id
string
required

Unique identifier for a Source that was uploaded to Totoy.

Maximum length: 29

Response

200 - application/json

The Source object represents a document source (.pdf, .jpg, .png) or text source (plain-text) that has been uploaded to Totoy.

source_id
string
required

Unique identifier for the Source.

Maximum length: 29
source_type
enum<string>
required

Type for this source (document or text).

Available options:
document,
text
bytes
integer
required

Size of the document file or text, in bytes.

created_at
string
required

Date-time for when the Source was created, in ISO 8601 format.

updated_at
string
required

Date-time for when the Source was last modified, in ISO 8601 format.

project_id
string
required

The unique identifier of the project this Source is assigned to. Sources can only be used by resources with the same project_id.

Maximum length: 28
title
string

Title of the document or text.

Maximum length: 512
document_file_name
string | null

The file name of a Source document.

Maximum length: 255
backlink
string

An external url to the Source that can be used by clients to link back to the original document or text (i.e. a web page containing that text).

Maximum length: 512
valid_from
string | null

From what time the Source can be used by a Knowledge Base or an Explanation. If no valid_from is set, the Source is valid from the time it is added to Sources.

valid_until
string | null

Until when the Source can be used by a Knowledge Base or an Explanation. If no valid_until is set, the Source is valid until it is removed from Sources.

custom_metadata
object

Custom optional metadata for a Source provided by a client. Up to 10 key-value pairs.

knowledge_base_ids
string[] | null

List of Knowledge Base identifiers where this Source is used.

status
enum<string>

The parsing status of the Document Source. The status completed indicates that the source is ready for use. The status parameter is only available for Document Sources.

Available options:
in_progress,
completed,
failed
pages
integer

The number of pages of the Document Source. The pages parameter is only available for Document Sources.

Creates a Document or Text SourceDeletes a Source.