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 Projects.
curl --request GET \
--url https://api.totoy.ai/v1/projects \
--header 'Authorization: Bearer <token>'{
"data": [
{
"project_id": "pj_avX7imfLaPcQnv5ckvGlOEBA9",
"name": "Totoy GmbH Project",
"created_at": "2023-07-05T12:34:13Z",
"updated_at": "2024-01-05T12:00:00Z",
"knowledge_base_ids": [
"kb_feMfJbeqbAEj4u8K5HqmKpUbY",
"kb_kfjd34sfgsd2gfskijuh23zgt"
],
"source_ids": [
"src_oXiYDg8QOc9JsOk86idRXiywD",
"src_qoY7rSGkiWtn4NP8kPXc7xzrq"
],
"is_default": false,
"usage": {
"assistant_messages": {
"knowledge_bases_chats": 1354,
"explanations": 1234,
"total": 2588
},
"document_sources_pages": 2534,
"text_sources": 3756
}
},
{
"project_id": "pj_bxW8jnfoMbRQow6dlHmPIRCA2",
"name": "Default Project",
"created_at": "2023-07-05T12:34:13Z",
"updated_at": "2023-07-05T12:34:13Z",
"knowledge_base_ids": [],
"source_ids": [],
"is_default": true,
"usage": {
"assistant_messages": {
"knowledge_bases_chats": 4321,
"explanations": 5634,
"total": 9955
},
"document_sources_pages": 5342,
"text_sources": 7563
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
A list of Projects.
A list of Projects.
The unique identifier of a Project
28The name of the Project
256Date-time of when the Project was created, in ISO 8601 format
Date-time of when the Project was last modified, in ISO 8601 format
A list of knowledge_base_ids that are assigned to the Project. One Project can have multiple Knowledge Bases.
A list of source_ids of Sources that are assigned to the Project.
Whether the Project is the default Project for the Organization. The default Project is used when no Project is specified in an API request. The default Project cannot be deleted.
The usage of the Project.
The number of Messages with the role assistant, used by the Project in the current billing period.
The number of Knowledge Base Chat Messages with the role assistant, used by the Project in the current billing period.
The number of Explanation Messages with the role assistant, used by the Project in the current billing period.
The total number of Messages with the role assistant, used by the Project in the current billing period.
The number of Document Sources pages stored in the Project.
The amount of Text Sources stored in the Project.
curl --request GET \
--url https://api.totoy.ai/v1/projects \
--header 'Authorization: Bearer <token>'{
"data": [
{
"project_id": "pj_avX7imfLaPcQnv5ckvGlOEBA9",
"name": "Totoy GmbH Project",
"created_at": "2023-07-05T12:34:13Z",
"updated_at": "2024-01-05T12:00:00Z",
"knowledge_base_ids": [
"kb_feMfJbeqbAEj4u8K5HqmKpUbY",
"kb_kfjd34sfgsd2gfskijuh23zgt"
],
"source_ids": [
"src_oXiYDg8QOc9JsOk86idRXiywD",
"src_qoY7rSGkiWtn4NP8kPXc7xzrq"
],
"is_default": false,
"usage": {
"assistant_messages": {
"knowledge_bases_chats": 1354,
"explanations": 1234,
"total": 2588
},
"document_sources_pages": 2534,
"text_sources": 3756
}
},
{
"project_id": "pj_bxW8jnfoMbRQow6dlHmPIRCA2",
"name": "Default Project",
"created_at": "2023-07-05T12:34:13Z",
"updated_at": "2023-07-05T12:34:13Z",
"knowledge_base_ids": [],
"source_ids": [],
"is_default": true,
"usage": {
"assistant_messages": {
"knowledge_bases_chats": 4321,
"explanations": 5634,
"total": 9955
},
"document_sources_pages": 5342,
"text_sources": 7563
}
}
]
}