Skip to main content
POST
Cancel a batch call

Authorizations

Authorization
string
header
required

A Bearer token. Create keys in the portal under Settings > API keys (https://app.ryvo.so/developers). The token has the form ryvo_live_<64 hex characters> and is shown once.

Header: Authorization: Bearer ryvo_live_...

Path Parameters

id
string<uuid>
required

The Ryvo uuid of the batch call.

Response

The batch status after cancelling.

id
string<uuid>
required
status
enum<string>
required
Available options:
pending,
in_progress,
completed,
cancelled,
failed
Example:

"in_progress"