Skip to main content
POST
Extract JSON

Authorizations

Authorization
string
header
required

Use Authorization: Bearer YOUR_API_KEY

Headers

Idempotency-Key
string

Optional client-chosen key for this request (any string up to 255 characters, e.g. a UUID). Every Croma operation is an idempotent lookup: repeating a request with the same body returns the same result and creates nothing, so retrying after a timeout or network failure is always safe. The key is echoed back in the Idempotency-Key response header so you can correlate a retry with its first attempt. Each attempt that reaches the API counts against the rate limit.

Maximum string length: 255
Example:

"0f8e9a42-6b7c-4d1e-9a3f-2c5d7e8f9a0b"

Body

application/json
url
string<uri>
required

Public http or https URL of the page to read. Loopback and private addresses are not accepted.

Maximum string length: 2000
json_schema
object
required

JSON Schema for the object to return. Field names and nesting are yours; describe each field so it can be located on the page.

effort
enum<string>
default:standard

Effort to spend on the page: min is fastest and may serve a recent copy, standard is the balanced default, max always reads the page live and handles pages that render themselves in the browser.

Available options:
min,
standard,
max

Response

Successful response

data
object
required