Skip to main content
Start extraction
Operation ID: http.graph.extractions.start

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org
string
required
project
string
required

Body

application/json
idempotency_key
string
required

Caller-chosen key for this extraction. Repeating the same key replays the same admitted run instead of paying for a second one.

Required string length: 1 - 200
mode
string
required
Allowed value: "shape"
shape
string
required

The one published Shape name or id whose complete analytical perspective governs this operation.

Required string length: 1 - 200
file_ids
string<uuid>[]

Native File UUIDs from list_files or search_files. Each File's current version and extracted text are pinned at admission; never a Workspace path. Give exactly one of file_ids or collection_id.

Required array length: 1 - 256 elements
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
collection_id
string<uuid>

A Files collection to extract from, in place of file_ids. The collection's Files and their current versions are read once when the extraction starts; Files added or changed later are not part of this run. Give exactly one of file_ids or collection_id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
level
enum<string>

How thorough: standard (items are double-checked before you review them) or fast (one read, no double-check). Omit for the project's default.

Available options:
standard,
fast,
deep

Response

2XX - application/json

Success.

data
object
required