Authorizations

X-API-Key
string
header
required

Simplex API Key to authenticate requests. We provision API keys after a quick meeting with us. You can book that meeting here.

Body

application/json
element_description
string
required

A natural language description of the text to extract.

session_id
string
required

The ID of the session to connect to.

use_vision
boolean
default:
false

Whether to use vision to find the text. Helpful if Simplex struggles to find the text when use_vision = False, otherwise not necessary.

Response

200 - application/json
extracted_text
string

The text that was extracted.

succeeded
boolean

Indicates if the text was successfully extracted.