Skip to main content
POST
/
extract
/
detect
Start detect extraction
curl --request POST \
  --url https://apigcp.trynia.ai/v2/extract/detect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "source_id": "<string>",
  "page_range": "<string>",
  "include_symbols": false,
  "filter_pattern": "<string>"
}
'
{
  "id": "<string>",
  "status": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "progress": 0,
  "type": "detect",
  "url": "<string>",
  "source_display_name": "<string>",
  "page_range": "<string>",
  "result": {},
  "page_count": 0,
  "error": "<string>"
}

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Body

application/json
url
string | null

URL of the PDF to detect elements from

source_id
string | null

Source ID of an already-indexed document

page_range
string | null

Page range to process (e.g. "1-10", "5,8,12")

include_symbols
boolean
default:false

Include symbol-level detection for technical documents

filter_pattern
string | null

Regex pattern to filter detected element types

Response

Successful Response

id
string
required

Detection job ID

status
string
required

Job status: queued, processing, completed, failed

created_at
string
required
updated_at
string
required
progress
integer
default:0

Processing progress percentage (0-100)

type
string
default:detect
url
string | null
source_display_name
string | null
page_range
string | null
result
Result · object

Detection results with bounding boxes and classifications

page_count
integer
default:0
error
string | null