Retry document processing

POST

/api/v1/documents/{id}/retry

const url = 'https://api.yggy.tech/api/v1/documents/example/retry';
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/retry \
  --header 'Authorization: Bearer <token>'

Re-trigger processing for a document. Purges the old invocation, resets the document status to PENDING, and re-triggers the workflow using the already-stored file.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

required

string

Header Parameters

host

string | null

x-yggy-organization-id

string | null

Responses

202

Document requeued for processing

application/json

object

success

required

boolean

documentId

required

string

invocationId

required

string

status

required

string

Allowed values: queued

message

required

string

Example

{
  "status": "queued"
}

400

No stored file available for retry

application/json

object

success

boolean

error

required

string

message

string

Example

{
  "success": false
}

404

Document not found

application/json

object

success

boolean

error

required

string

message

string

Example

{
  "success": false
}

409

Document is already being processed

application/json

object

success

boolean

error

required

string

message

string

Example

{
  "success": false
}