Skip to content

docs: add http service info #95

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

Merged
hustcc merged 3 commits into from
Jun 13, 2025
Merged

docs: add http service info #95

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53c1846
docs: add http service info
hustcc Jun 13, 2025
e715d4c
chore: fix type
hustcc Jun 13, 2025
6866342
chore: typo
hustcc Jun 13, 2025
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,13 @@ Options:

You can use AntV's project [GPT-Vis-SSR](https://github.com/antvis/GPT-Vis/tree/main/bindings/gpt-vis-ssr) to deploy an HTTP service in a private environment, and then pass the URL address through env `VIS_REQUEST_SERVER`.

- **Method**: `POST`
- **Parameter**: Which will be passed to `GPT-Vis-SSR` for renderring. Such as, `{ "type": "line", "data": [{ "time": "2025-05", "value": "512" }, { "time": "2025-06", "value": "1024" }] }`.
- **Return**: The return object of HTTP service.
- **success**: `boolean` Whether generate chart image successfully.
- **resultObj**: `string` The chart image url.
- **errorMessage**: `string` When `success = false`, return the error message.


## 🔨 Development

Expand Down