PATCH
/
sources
/
{source_id}
{
  "source_id": "src_oXiYDg8QOc9JsOk86idRXiywD",
  "source_type": "document",
  "bytes": 1234567,
  "created_at": "2024-03-01T00:00:00Z",
  "updated_at": "2024-05-01T00:00:00Z",
  "title": "Totoy Company Overview",
  "document_file_name": "totoy-company-overview.pdf",
  "backlink": "https://www.totoy.ai/totoy-company-overview.pdf",
  "valid_from": "2024-01-01T00:00:00Z",
  "valid_until": "2027-12-31T23:59:59Z",
  "project_id": "pj_avX7imfLaPcQnv5ckvGlOEBA9",
  "custom_metadata": {
    "internal_tag": "general_documents"
  },
  "knowledge_base_ids": [
    "kb_feMfJbeqbAEj4u8K5HqmKpUbY",
    "kb_2eMfJbeqbAEj4u8K5HqmKpUbY"
  ],
  "status": "completed",
  "pages": 27
}

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

Body

Request body for modifying a document Source.

document_file
file

A document file (not file name) to replace the original document file of the Source. Supported file types are .pdf, .jpg, and .png.

title
string

Title of the document.

Maximum length: 512
backlink
string

A url to the document source that can be used by clients to link back to the original document.

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.

project_id
string | null

The unique identifier of the project this Source should be assigned to. Sources can only be used by resources with the same project_id. If no project_id is set, the Source will be assigned to the default project. A Source can only be assigned to a different Project, if no Knowledge Bases are using the Source.

Maximum length: 28
custom_metadata
object

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

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.

Deletes a Source.Retrieves the content of a Source.