Get document processing status

GET

/api/v1/documents/{id}/status

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

Get the current processing status of a document, including progress and any errors.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

required

string

Header Parameters

host

string | null

x-yggy-organization-id

string | null

Responses

200

Document processing status

application/json

object

documentId

required

string

step

string

progress

required

number

<= 100

message

string

paused

boolean

completed

required

boolean

failed

required

boolean

stored

boolean

awaitingOntologyReview

boolean

ontologyReviewId

string

ontologyProposalCount

number

error

string

code

string

failureMessage

string

status

string

Allowed values: pending running suspended failed

workflowError

string

retryable

boolean

triplesExtracted

number

inputTokens

number

outputTokens

number

extractionTier

string

Allowed values: fast balanced accurate

extractionMode

string

Allowed values: structured

estimatedRemainingMs

number

steps

Array<object>

object

required

string

name

required

string

status

required

string

Allowed values: pending running completed failed cancelled paused

startedAt

number

completedAt

number

durationMs

number

message

string

current

number

total

number

unit

string

stages

Array<object>

object

required

string

name

required

string

status

required

string

Allowed values: pending running completed failed cancelled paused

startedAt

number

completedAt

number

durationMs

number

message

string

current

number

total

number

unit

string

invocationId

string

updatedAt

required

number

Example

{
  "status": "pending",
  "extractionTier": "fast",
  "extractionMode": "structured",
  "steps": [
    {
      "status": "pending"
    }
  ],
  "stages": [
    {
      "status": "pending"
    }
  ]
}