QuivrHQ/quivr
1
1
Fork 0
mirror of https://github.com/QuivrHQ/quivr.git synced 2024-12-15 09:32:22 +03:00
Code Issues Packages Projects Releases Wiki Activity

feat: 🎸 docs

Browse Source 
added api doc
This commit is contained in:
Stan Girard 2023-12-25 16:08:28 +01:00
parent 74e1cac1a8
commit 4a7f162405
52 changed files with 289 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/api-reference/api-key/create-api-key.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /api-key
---

3
docs/api-reference/api-key/delete-api-key.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: delete /api-key/{key_id}
---

3
docs/api-reference/api-key/get-api-keys.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /api-keys
---

3
docs/api-reference/brain/accept-invitation.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /brains/{brain_id}/subscription/accept
---

3
docs/api-reference/brain/create-new-brain.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /brains/
---

3
docs/api-reference/brain/decline-invitation.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /brains/{brain_id}/subscription/decline
---

3
docs/api-reference/brain/get-question-context-for-brain.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /brains/{brain_id}/documents
---

3
docs/api-reference/brain/retrieve-all-brains-for-user.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /brains/
---

3
docs/api-reference/brain/retrieve-brain-by-id.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /brains/{brain_id}/
---

3
docs/api-reference/brain/retrieve-default-brain.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /brains/default/
---

3
docs/api-reference/brain/retrieve-public-brains.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /brains/public
---

3
docs/api-reference/brain/set-brain-as-default.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /brains/{brain_id}/default
---

3
docs/api-reference/brain/update-existing-brain-secrets.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: put /brains/{brain_id}/secrets-values
---

3
docs/api-reference/brain/update-existing-brain.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: put /brains/{brain_id}/
---

3
docs/api-reference/brainsubscription/get-user-invitation.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /brains/{brain_id}/subscription
---

3
docs/api-reference/brainsubscription/invite-users-to-brain.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /brains/{brain_id}/subscription
---

3
docs/api-reference/chat/add-question-and-answer-handler.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /chat/{chat_id}/question/answer
---

3
docs/api-reference/chat/create-chat-handler.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /chat
---

3
docs/api-reference/chat/create-question-handler.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /chat/{chat_id}/question
---

3
docs/api-reference/chat/create-stream-question-handler.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /chat/{chat_id}/question/stream
---

3
docs/api-reference/chat/delete-chat.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: delete /chat/{chat_id}
---

3
docs/api-reference/chat/get-chat-history-handler.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /chat/{chat_id}/history
---

3
docs/api-reference/chat/get-chats.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /chat
---

3
docs/api-reference/chat/update-chat-metadata-handler.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: put /chat/{chat_id}/metadata
---

3
docs/api-reference/crawl/crawl-endpoint.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /crawl
---

3
docs/api-reference/get-users-with-brain-access.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /brains/{brain_id}/users
---

3
docs/api-reference/health/healthz-1.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /crawl/healthz
---

3
docs/api-reference/health/healthz-2.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /healthz
---

3
docs/api-reference/health/healthz-3.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /upload/healthz
---

3
docs/api-reference/health/healthz.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /chat/healthz
---

4
docs/api-reference/introduction.mdx Normal file
View File

@ -0,0 +1,4 @@
---
title: 'Introduction'
description: 'Example section for showcasing API endpoints'
---

3
docs/api-reference/knowledge/delete-endpoint.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: delete /knowledge/{knowledge_id}
---

3
docs/api-reference/knowledge/generate-signed-url-endpoint.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /knowledge/{knowledge_id}/signed_download_url
---

3
docs/api-reference/knowledge/list-knowledge-in-brain-endpoint.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /knowledge
---

3
docs/api-reference/notification/get-notifications.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /notifications/{chat_id}
---

3
docs/api-reference/onboarding/get-user-onboarding-handler.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /onboarding
---

3
docs/api-reference/onboarding/update-user-onboarding-handler.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: put /onboarding
---

3
docs/api-reference/post-contact.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /contact
---

3
docs/api-reference/prompt/create-prompt-route.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /prompts
---

3
docs/api-reference/prompt/get-prompt.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /prompts/{prompt_id}
---

3
docs/api-reference/prompt/get-prompts.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /prompts
---

3
docs/api-reference/prompt/update-prompt.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: put /prompts/{prompt_id}
---

3
docs/api-reference/remove-user-subscription.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: delete /brains/{brain_id}/subscription
---

3
docs/api-reference/root.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /
---

3
docs/api-reference/subscription/subscribe-to-brain-handler.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /brains/{brain_id}/subscribe
---

3
docs/api-reference/subscription/unsubscribe-from-brain-handler.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /brains/{brain_id}/unsubscribe
---

3
docs/api-reference/update-brain-subscription.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: put /brains/{brain_id}/subscription
---

3
docs/api-reference/upload/upload-file.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: post /upload
---

3
docs/api-reference/user/get-user-endpoint.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /user
---

3
docs/api-reference/user/get-user-identity-route.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: get /user/identity
---

3
docs/api-reference/user/update-user-identity-route.mdx Normal file
View File

@ -0,0 +1,3 @@
---
openapi: put /user/identity
---

140
docs/mint.json
View File

@ -3,12 +3,12 @@
"name": "Quivr",
"favicon": "/favicon.svg",
"colors": {
"primary": "#6142D4",
"light": "#F6F4FF",
"dark": "#13ABBA",
"primary": "#0D9373",
"light": "#07C983",
"dark": "#0D9373",
"anchors": {
"from": "#6142D4",
"to": "#F6F4FF"
"from": "#0D9373",
"to": "#07C983"
}
},
"topbarLinks": [
@ -25,6 +25,10 @@
{
"name": "Developer Guide",
"url": "developers"
},
{
"name": "API Reference",
"url": "api-reference"
}
],
"anchors": [
@ -99,6 +103,126 @@
]
}
]
},
{
"group": "API Reference",
"pages": [
{
"group": "Brain",
"pages": [
"api-reference/brain/retrieve-all-brains-for-user",
"api-reference/brain/create-new-brain",
"api-reference/brain/retrieve-public-brains",
"api-reference/brain/retrieve-default-brain",
"api-reference/brain/retrieve-brain-by-id",
"api-reference/brain/update-existing-brain",
"api-reference/brain/update-existing-brain-secrets",
"api-reference/brain/set-brain-as-default",
"api-reference/brain/get-question-context-for-brain",
"api-reference/brain/accept-invitation",
"api-reference/brain/decline-invitation"
]
},
{
"group": "Health",
"pages": [
"api-reference/health/healthz",
"api-reference/health/healthz-1",
"api-reference/health/healthz-2",
"api-reference/health/healthz-3"
]
},
{
"group": "Chat",
"pages": [
"api-reference/chat/get-chats",
"api-reference/chat/create-chat-handler",
"api-reference/chat/delete-chat",
"api-reference/chat/update-chat-metadata-handler",
"api-reference/chat/create-question-handler",
"api-reference/chat/create-stream-question-handler",
"api-reference/chat/get-chat-history-handler",
"api-reference/chat/add-question-and-answer-handler"
]
},
{
"group": "Crawl",
"pages": [
"api-reference/crawl/crawl-endpoint"
]
},
{
"group": "Onboarding",
"pages": [
"api-reference/onboarding/get-user-onboarding-handler",
"api-reference/onboarding/update-user-onboarding-handler"
]
},
"api-reference/root",
{
"group": "Upload",
"pages": [
"api-reference/upload/upload-file"
]
},
{
"group": "User",
"pages": [
"api-reference/user/get-user-endpoint",
"api-reference/user/get-user-identity-route",
"api-reference/user/update-user-identity-route"
]
},
{
"group": "API Key",
"pages": [
"api-reference/api-key/create-api-key",
"api-reference/api-key/delete-api-key",
"api-reference/api-key/get-api-keys"
]
},
{
"group": "BrainSubscription",
"pages": [
"api-reference/brainsubscription/get-user-invitation",
"api-reference/brainsubscription/invite-users-to-brain"
]
},
"api-reference/update-brain-subscription",
"api-reference/remove-user-subscription",
"api-reference/get-users-with-brain-access",
{
"group": "Subscription",
"pages": [
"api-reference/subscription/subscribe-to-brain-handler",
"api-reference/subscription/unsubscribe-from-brain-handler"
]
},
{
"group": "Prompt",
"pages": [
"api-reference/prompt/get-prompts",
"api-reference/prompt/create-prompt-route",
"api-reference/prompt/get-prompt",
"api-reference/prompt/update-prompt"
]
},
{
"group": "Notification",
"pages": [
"api-reference/notification/get-notifications"
]
},
{
"group": "Knowledge",
"pages": [
"api-reference/knowledge/list-knowledge-in-brain-endpoint",
"api-reference/knowledge/delete-endpoint",
"api-reference/knowledge/generate-signed-url-endpoint"
]
},
"api-reference/post-contact"
]
}
],
"footerSocials": {
@ -112,5 +236,11 @@
"thumbsRating": true,
"raiseIssue": true,
"suggestEdit": true
},
"api": {
"baseUrl": "https://api.quivr.app",
"auth": {
"method": "bearer"
}
}
}