Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API doc: Correct Base URL and Dataset URL. #1444

Merged
merged 2 commits into from
Jul 10, 2024
Merged

API doc: Correct Base URL and Dataset URL. #1444

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e35f6f
Correct Base URL and Dataset URL.
cyhasuka Jul 9, 2024
5de8e07
Update docs/references/ragflow_api.md
cyhasuka Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/references/ragflow_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ RAGFlow offers RESTful APIs for you to integrate its capabilities into third-par

## Base URL
```
http://<host_address>/api/v1/
http://<host_address>/v1/api/
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your correction is right.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I understand that in future releases the dataset URL will change to http://<host_address>/api/v1/dataset? Why doesn't it stay synchronized with the base URL?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. Because we want to be consistent with others.

```

## Dataset URL
```
http://<host_address>/api/v1/dataset
http://<host_address>/v1/api/dataset
cyhasuka marked this conversation as resolved.
Show resolved Hide resolved
```

## Authorization
Expand Down