Extract Text

cURL

curl --request GET \
  --url https://api.simplex.sh/extract-text \
  --header 'X-API-Key: <api-key>'

{
  "succeeded": true,
  "text": "<string>",
  "error": "<string>"
}

cURL

curl --request GET \
  --url https://api.simplex.sh/extract-text \
  --header 'X-API-Key: <api-key>'

{
  "succeeded": true,
  "text": "<string>",
  "error": "<string>"
}

Extracts text from an element based on a natural language description.

X-API-Key

string

header

required

Simplex API Key

element_description

string

required

A natural language description of the text to extract.

Example:

"the first search result"

session_id

string<uuid>

Optional ID of the session to connect to.

Extract text response

The response is of type object.