Image description

Image description

ParseRail evaluates an image and returns accessible alt text, a caption, tags, and any text found inside it. One call supports accessibility and catalogs.

Cost: 3 credits ($0.03) — charged only on success.

post/v1/describe

Request

  • Base URL: https://api.thecompound.tech
  • URL: https://api.thecompound.tech/v1/describe
  • 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

imageUrlstring uri
purpose'alt' | 'caption' | 'product' | 'detailed'

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.