Schema structuring

Schema structuring

ParseRail takes any messy input, including text, HTML, or an email, plus YOUR JSON schema, and returns output shaped to it. It validates the output against your required fields and property types, performs an automatic corrective retry, and returns a valid flag.

Cost: 6 credits ($0.06) — charged only on success.

post/v1/structure

Request

  • Base URL: https://api.thecompound.tech
  • URL: https://api.thecompound.tech/v1/structure
  • Auth: HTTP bearer

Headers

ParseRail-Dry-Run'1' | 'true'

Send 1 to dry-run the call. ParseRail runs auth, the throttle, body validation and the balance precheck. It returns 200 with the cost and the status a live call would get. No model runs and nothing is charged, so a key with a zero balance works. Dry runs count against the per-key rate limit.

Idempotency-Keystring

Key for one logical operation. Same body replays the result for 24 hours; a different body with the same key returns 409.

Request body

inputstring required

Provide any messy input, including text, HTML, an email, or a JSON blob.

schemaobject required

Provide the JSON Schema that the output must conform to.

instructionsstring

Optional extra guidance.

Response

The call succeeded. The response contains result fields and a usage envelope. With ParseRail-Dry-Run: 1 the body is a DryRun object instead.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.