API Reference

Totoy Logo

Support

Returns a list of Knowledge Base Sources.

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

CustomMetadata

The unique identifier of the `Knowledge Base` that the `Knowledge Base Source` is associated with.

The indexing status of the Knowledge Base Source. The status `completed` indicates that the source is ready for use.

The `Knowledge Base Source` represents a link to a `Source` (.pdf, .jpg, .png or plain-text) that has been added to a `Knowledge Base`, so it can be retrieved as context for a `Knowledge Base Chat`.

KnowledgeBaseSource

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

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).

Size of the document file or text, in bytes.

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

List of `Knowledge Base` identifiers where this `Source` is used.

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

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

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.

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

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`.

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`.

Source

ApiKeyAuth

An example for a list of `Knowledge Base Sources`.

A list of `Knowledge Base Sources` that are used by a `Knowledge Base` for Retrieval.

KnowledgeBaseSourcesList

A Response Body for HTTP Problem Details in RFC 9457 format.

Problem

Explains a given document Source in any language in a specified output language and language level.

Explains a document in any language

Returns a list of Knowledge Bases.

Creates a Knowledge Base.

Retrieves a Knowledge Base.

Deletes a Knowledge Base.

Modifies a Knowledge Base.

Creates a Knowledge Base Chat Response for the given Messages.

Links one or multiple Sources to the Knowledge Base as new Knowledge Base Sources.

Adds Sources to a Knowledge Base.

Retrieves a Knowledge Base Source.

Removes a Knowledge Base Source (the link to a Source) from a Knowledge Base. This operation does not delete the Source itself.

Removes a Knowledge Base Source from a Knowledge Base.

Returns a list of Sources.

Creates a Document or Text Source that can be added to Knowledge Bases as a Knowledge Base Source or used as context for an Explanation. Upload a file that can be used across various endpoints. Individual document files can be up to 100 MB, text Sources can be up to 1000000 characters long, and the size of all Sources uploaded by one `Organization` can be up to 100 GB Document `Sources` are submitted as multipart/form-data and Text `Sources` as application/json.

Explanation

Knowledge Bases

Sources

Projects

Organization

Returns a list of Knowledge Base Sources.

Authorizations

Path Parameters

Response