Totoy Api
Explanation
Knowledge Bases
- GETReturns a list of Knowledge Bases.
- POSTCreates a Knowledge Base.
- GETRetrieves a Knowledge Base.
- DELDeletes a Knowledge Base.
- PATCHModifies a Knowledge Base.
- POSTCreates a Knowledge Base Chat Response for the given Messages.
- GETReturns a list of Knowledge Base Sources.
- POSTAdds Sources to a Knowledge Base.
- GETRetrieves a Knowledge Base Source.
- DELRemoves a Knowledge Base Source from a Knowledge Base.
Sources
Projects
Organization
Returns a list of Sources.
curl --request GET \
--url https://api.totoy.ai/v1/sources \
--header 'Authorization: Bearer <token>'{
"data": [
{
"source_id": "src_oXiYDg8QOc9JsOk86idRXiywD",
"source_type": "document",
"bytes": 1234567,
"created_at": "2024-03-01T00:00:00Z",
"updated_at": "2024-03-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": "2026-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
},
{
"source_id": "src_qoY7rSGkiWtn4NP8kPXc7xzrq",
"source_type": "text",
"bytes": 44,
"created_at": "2024-04-01T00:00:00Z",
"updated_at": "2024-04-01T00:00:00Z",
"title": "Foundation Date",
"backlink": "https://www.totoy.ai/general-info",
"valid_from": "2024-01-01T00:00:00Z",
"valid_until": "2026-12-31T23:59:59Z",
"project_id": "pj_avX7imfLaPcQnv5ckvGlOEBA9",
"custom_metadata": {
"internal_tag": "text_snippets"
},
"knowledge_base_ids": [
"kb_feMfJbeqbAEj4u8K5HqmKpUbY",
"kb_2eMfJbeqbAEj4u8K5HqmKpUbY"
]
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
A list of Sources that were uploaded to Totoy.
A list of Sources.
Unique identifier for the Source.
29Type for this source (document or text).
document, text Size of the document file or text, in bytes.
Date-time for when the Source was created, in ISO 8601 format.
Date-time for when the Source was last modified, in ISO 8601 format.
The unique identifier of the project this Source is assigned to. Sources can only be used by resources with the same project_id.
28Title of the document or text.
512The file name of a Source document.
255An 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).
512From 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.
Custom optional metadata for a Source provided by a client. Up to 10 key-value pairs.
List of Knowledge Base identifiers where this Source is used.
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.
in_progress, completed, failed The number of pages of the Document Source. The pages parameter is only available for Document Sources.
curl --request GET \
--url https://api.totoy.ai/v1/sources \
--header 'Authorization: Bearer <token>'{
"data": [
{
"source_id": "src_oXiYDg8QOc9JsOk86idRXiywD",
"source_type": "document",
"bytes": 1234567,
"created_at": "2024-03-01T00:00:00Z",
"updated_at": "2024-03-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": "2026-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
},
{
"source_id": "src_qoY7rSGkiWtn4NP8kPXc7xzrq",
"source_type": "text",
"bytes": 44,
"created_at": "2024-04-01T00:00:00Z",
"updated_at": "2024-04-01T00:00:00Z",
"title": "Foundation Date",
"backlink": "https://www.totoy.ai/general-info",
"valid_from": "2024-01-01T00:00:00Z",
"valid_until": "2026-12-31T23:59:59Z",
"project_id": "pj_avX7imfLaPcQnv5ckvGlOEBA9",
"custom_metadata": {
"internal_tag": "text_snippets"
},
"knowledge_base_ids": [
"kb_feMfJbeqbAEj4u8K5HqmKpUbY",
"kb_2eMfJbeqbAEj4u8K5HqmKpUbY"
]
}
]
}