ai

Describe an image. POST { imageUrl, instruction? }. Returns...

Describe an image. POST { imageUrl, instruction? }. Returns { imageUrl, altText (5-15 word accessibility text), description (2-3 sentences), contentType (photograph|illustration|screenshot|diagram|document|mixed|other), text (verbatim OCR transcription, "" if none), mainObjects[], dominantColors[] (hex) }. Accepts JPEG, PNG, GIF, WebP. 1MB image size cap. Billing: payment settles before this endpoint runs (paid upstream), so an error after settlement IS charged — the error response then carries the payment receipt (PAYMENT-RESPONSE) and X-2s-Charged: true. upto-scheme payments settle only after success.

post/api/ai/describe-image

Request

  • Base URL: https://2s.io
  • URL: https://2s.io/api/ai/describe-image
  • Auth: API key in header PAYMENT-SIGNATURE

Query parameters

trial1

Try before you buy. Set to 1 for one free real call per endpoint per hour — no wallet or payment needed — to verify the endpoint before paying. Equivalent to sending the "X-2s-Trial: 1" request header. Listed only on operations that offer a trial; the others always answer 402.

Request body

imageUrlstring uri required

HTTPS URL of a JPEG, PNG, GIF, or WebP image (≤1MB).

instructionstring

Optional caller-supplied focus hint, e.g. "describe the chart axes".

Response

(unresolved $ref)

Changes

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