Get workflow detail for a document

GET

/api/v1/workflows/documents/{documentId}

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

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

documentId

required

string

Header Parameters

host

string | null

x-yggy-organization-id

string | null

Responses

200

Workflow detail

application/json

object

documentId

required

string

title

required

string

invocationId

required

string | null

ownerId

required

string | null

documentStatus

required

string

Allowed values: PENDING PROCESSING COMPLETED FAILED

status

required

string | null

Allowed values: pending scheduled ready running paused backing-off suspended completed failed cancelled

step

required

string | null

progress

required

number

error

required

string | null

extractionTier

string | null

Allowed values: fast balanced accurate

tierDowngrade

object

requested

required

string

Allowed values: accurate

reason

required

string

Allowed values: org_setting plan

modelUsed

string | null

extractionMode

string | null

Allowed values: structured

inputTokens

number | null

outputTokens

number | null

ontologyRejectedTripleCount

integer

createdAt

required

string

updatedAt

required

string

timing

required

object

startedAt

required

string

updatedAt

required

string

elapsedMs

required

number

invocation

required

object

required

string

target

required

string

targetServiceName

required

string

targetHandlerName

required

string

status

required

string

Allowed values: pending scheduled ready running paused backing-off suspended completed

createdAt

required

string

modifiedAt

required

string

completedAt

string | null

pinnedDeploymentId

string | null

journalSize

required

number

idempotencyKey

string | null

completionRetention

string | null

journalRetention

string | null

completionResult

string | null

completionFailure

string | null

lastFailure

string | null

traceId

string | null

journal

required

Array<object>

object

index

required

number

entryType

required

string

name

string

completed

boolean

invokedId

string | null

invokedTarget

string | null

appendedAt

string | null

subJournal

Array

retention

required

object

available

required

boolean

expiresAt

required

string | null

steps

Array<object> | null

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

isCancellable

boolean

Example

{
  "documentStatus": "PENDING",
  "status": "pending",
  "extractionTier": "fast",
  "tierDowngrade": {
    "requested": "accurate",
    "reason": "org_setting"
  },
  "extractionMode": "structured",
  "ontologyRejectedTripleCount": 0,
  "invocation": {
    "status": "pending"
  },
  "steps": [
    {
      "status": "pending"
    }
  ],
  "isCancellable": false
}

404

Workflow not found