embedJobs

Cancel an Embed Job

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.

post/v1/embed-jobs/{id}/cancel

Request

  • Base URL: https://api.cohere.com
  • URL: https://api.cohere.com/v1/embed-jobs/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

The ID of the embed job to cancel.

Headers

X-Client-Namestring

The name of the project that is making the request.

Response

OK

EmbedJobsCancelResponse200 required

Empty response body

Changes

No recorded changes to this operation across all 1 revision of this API.