Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-03 23:15:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update API-docs.md

Browse Source
This commit is contained in:
Rahul Kumar 2023-10-17 08:28:13 +05:30 committed by GitHub
parent 06cc4b07ab
commit a9fb61bbd6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/pages/Developing/API-docs.md
View File

@ -2,7 +2,7 @@
# API Endpoints Documentation
### /api/answer
### 1. /api/answer
**Description:**
This endpoint is used to request answers to user-provided questions.
@ -44,7 +44,7 @@ In response, you will get a JSON document containing the answer,query and the re
}
```
### /api/docs_check
### 2. /api/docs_check
**Description:**
@ -78,7 +78,7 @@ In response, you will get a JSON document like this one indicating whether the d
```
### /api/combine
### 3. /api/combine
**Description:**
This endpoint provides information about available vectors and their locations with a simple GET request.
@ -127,7 +127,7 @@ HTML example:
JSON response with a status and a task ID that can be used to check the task's progress.
### /api/task_status
### 4. /api/task_status
**Description:**
This endpoint is used to get the status of a task (`task_id`) from `/api/upload`
@ -182,7 +182,7 @@ There are two types of responses:
}
```
### /api/delete_old
### 5. /api/delete_old
**Description:**
This endpoint is used to delete old Vector Stores.