mirror of
https://github.com/QuivrHQ/quivr.git
synced 2024-09-11 14:36:35 +03:00
docs(API): update api creation path
This commit is contained in:
parent
9a69b4bd83
commit
09c3022c6d
@ -9,25 +9,30 @@ sidebar_position: 1
|
|||||||
**Swagger**: https://api.quivr.app/docs
|
**Swagger**: https://api.quivr.app/docs
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
This documentation outlines the key points and usage instructions for interacting with the API backend. Please follow the guidelines below to use the backend services effectively.
|
This documentation outlines the key points and usage instructions for interacting with the API backend. Please follow the guidelines below to use the backend services effectively.
|
||||||
|
|
||||||
## Usage Instructions
|
## Usage Instructions
|
||||||
|
|
||||||
1. Standalone Backend
|
1. Standalone Backend
|
||||||
|
|
||||||
- The backend can now be used independently without the frontend application.
|
- The backend can now be used independently without the frontend application.
|
||||||
- Users can interact with the API endpoints directly using API testing tools like Postman.
|
- Users can interact with the API endpoints directly using API testing tools like Postman.
|
||||||
|
|
||||||
2. Generating API Key
|
2. Generating API Key
|
||||||
|
|
||||||
- To access the backend services, you need to sign in to the frontend application.
|
- To access the backend services, you need to sign in to the frontend application.
|
||||||
- Once signed in, navigate to the `/config` page to generate a new API key.
|
- Once signed in, navigate to the `/user` page to generate a new API key.
|
||||||
- The API key will be required to authenticate your requests to the backend.
|
- The API key will be required to authenticate your requests to the backend.
|
||||||
|
|
||||||
3. Authenticating Requests
|
3. Authenticating Requests
|
||||||
|
|
||||||
- When making requests to the backend API, include the following header:
|
- When making requests to the backend API, include the following header:
|
||||||
- `Authorization: Bearer {api_key}`
|
- `Authorization: Bearer {api_key}`
|
||||||
- Replace `{api_key}` with the generated API key obtained from the frontend.
|
- Replace `{api_key}` with the generated API key obtained from the frontend.
|
||||||
|
|
||||||
4. Future Plans
|
4. Future Plans
|
||||||
|
|
||||||
- The development team has plans to introduce additional features and improvements.
|
- The development team has plans to introduce additional features and improvements.
|
||||||
- These include the ability to delete API keys and view the list of active keys.
|
- These include the ability to delete API keys and view the list of active keys.
|
||||||
- The GitHub roadmap will provide more details on upcoming features, including addressing active issues.
|
- The GitHub roadmap will provide more details on upcoming features, including addressing active issues.
|
||||||
|
Loading…
Reference in New Issue
Block a user