Cancel document processing

POST

/api/v1/documents/{id}/cancel

const url = 'https://api.yggy.tech/api/v1/documents/example/cancel';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.yggy.tech/api/v1/documents/example/cancel \
  --header 'Authorization: Bearer <token>'

Cancel an in-flight document processing workflow (pending/running/suspended).

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

required

string

Header Parameters

host

string | null

x-yggy-organization-id

string | null

Responses

200

Document processing cancelled

application/json

object

success

required

boolean

documentId

required

string

invocationId

required

string

status

required

string

Allowed values: cancelled

message

required

string

Example

{
  "status": "cancelled"
}

404

No active workflow found

application/json

object

success

boolean

error

required

string

message

string

Example

{
  "success": false
}

500

Failed to cancel processing

application/json

object

success

boolean

error

required

string

message

string

Example

{
  "success": false
}