POST /v1/embed-jobs/{id}/cancel
This API allows users to cancel an active embed job. Once invoked, the embedding process will be terminated, and users will be charged for the embeddings processed up to the cancellation point. It's important to note that partial results will not be available to users after cancellation.
Servers
- https://api.cohere.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
The ID of the embed job to cancel. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
X-Client-Name |
String | No |
The name of the project that is making the request. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.