Generate a metered schema draft that coexists with page-owned JSON-LD

Requires schemas:generate and an explicit site grant. The page ID supplies the captured URL; arbitrary URLs and user/company IDs are not accepted. New integrations must explicitly receive this scope. A positive company credit balance is required before dispatch. Actual worker usage, including model/tool calls and the existing schema resource multiplier, is charged when recorded. No fixed generation price and no browser-user exemption or grace discount applies. No approval or production replacement occurs. Reuse the same Idempotency-Key and identical body on retries; a replay returns the same job without another dispatch. Poll the returned status_url. An uncertain dispatch is retained for reconciliation; never retry with a new key to bypass it.

More context and worked examples are in the developer guide.

Example request

curl --fail-with-body --request POST \
  'https://satelliteai.io/api/v1/sites/123/pages/4567/schemas/generations' \
  -H 'Idempotency-Key: IDEMPOTENCY-KEY' \
  -H 'Content-Type: application/json' \
  --data '{"language":"auto","coexist_existing":true}' \
  -H "Authorization: Bearer $SATELLITE_API_KEY"

Replace the example IDs with values returned by the discovery endpoints. Example values are placeholders, not real records.

Parameters

Unknown or repeated query parameters return 400.

JSON request body

Send Content-Type: application/json. The request body is required. Fields below describe the request; response fields follow separately.

Data dictionary

Generation intent recorded and a job identity returned. No generation result is approved or published.

202: Generation intent recorded and a job identity returned. No generation result is approved or published.

[] marks an array element. nullable means the value can be null; treat it as unknown, not zero. always present means the key is always included in the object.

Response metadata

Error responses

Errors return {"error": {"code", "message", "request_id"}}. See error handling for retry guidance.