📝 docs(async-api.mdx): add response example for async API request to improve documentation clarity
This commit is contained in:
parent
af35ae315e
commit
868515958e
1 changed files with 16 additions and 0 deletions
|
|
@ -27,6 +27,22 @@ curl -X POST \
|
|||
-d '{"inputs": {"text": ""}, "tweaks": {}, "sync": false}'
|
||||
```
|
||||
|
||||
Response:
|
||||
|
||||
```json
|
||||
{
|
||||
"result": {
|
||||
"output": "..."
|
||||
},
|
||||
"task": {
|
||||
"id": "...",
|
||||
"href": "api/v1/task/<task_id>"
|
||||
},
|
||||
"session_id": "...",
|
||||
"backend": "..." // celery or anyio
|
||||
}
|
||||
```
|
||||
|
||||
## Checking Task Status
|
||||
|
||||
You can check the status of an asynchronous task by making a GET request to the `/task/{task_id}` endpoint.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue