Sign in

v1

latestOpenAPI 3.1.02026-07-1255227258.8 KB
entities

Get Instruction Entity Extraction Logs

List entity extraction logs for an instruction. Results are attempt-level and include both successful and unsuccessful extraction outcomes. Results are sorted by created_at in descending order and paginated. Historical extraction attempts before 2026-03-06 are unavailable in this endpoint.

get/instructions/{instruction_id}/entity-extraction-logs

Path parameters

instruction_idstring uuid required

The ID of the instruction.

Example:00000000-0000-0000-0000-000000000000

The ID of the instruction.

Query parameters

cursorstring nullable

An opaque cursor for pagination

An opaque cursor for pagination

page_sizeinteger

The number of items per page (must be greater than 0 and less than or equal to 100)

The number of items per page (must be greater than 0 and less than or equal to 100)

document_idsstring[] nullable

Optional document IDs to filter extraction logs to.

Optional document IDs to filter extraction logs to.

status'extracted' | 'not_found' | 'error' nullable

Optional extraction status filter. Supported values are extracted, not_found, and error.

Optional extraction status filter. Supported values are extracted, not_found, and error.

created_afterstring date-time nullable

Optional ISO 8601 timestamp. Includes only logs with created_at >= created_after.

Optional ISO 8601 timestamp. Includes only logs with created_at >= created_after.

created_beforestring date-time nullable

Optional ISO 8601 timestamp. Includes only logs with created_at < created_before.

Optional ISO 8601 timestamp. Includes only logs with created_at < created_before.

Headers

partitionstring nullable

An optional partition to scope the request to. If omitted, accounts created after 1/9/2025 will have the request scoped to the default partition, while older accounts will have the request scoped to all partitions. Older accounts may opt in to strict partition scoping by contacting support@ragie.ai. Older accounts using the partitions feature are strongly recommended to scope the request to a partition.

Example:acme_customer_id

An optional partition to scope the request to. If omitted, accounts created after 1/9/2025 will have the request scoped to the default partition, while older accounts will have the request scoped to all partitions. Older accounts may opt in to strict partition scoping by contacting support@ragie.ai. Older accounts using the partitions feature are strongly recommended to scope the request to a partition.

Response

Successful Response