images

Image understanding (image_to_text)

post/v1/images/responses

Request

Base URL: https://api.beatra.ai (the document declares no server; this is the origin it was published from)
URL: https://api.beatra.ai/v1/images/responses
Auth: none declared. Required headers: Idempotency-Key

x-request-idstring nullable

Idempotency-Keystring required

authorizationstring nullable

metadataobject nullable

Caller-supplied metadata; ≤16 keys, key ≤64 chars, value ≤512 chars

callback_urlstring nullable

HTTPS URL beatra will POST the final Task envelope to when the Task reaches a terminal state

callback_signing_key_idstring nullable

Optional standalone callback signing key. Omit for unsigned callback delivery; requires callback_url when provided.

modelstring required

promptstring required

detail'default' | 'low' | 'high'

Visual detail preference. It does not change Beatra's per-image price.

response_format'text' | 'json' nullable

temperaturenumber nullable

Task accepted

object'task'

task_idstring required

status'queued' | 'running' | 'succeeded' | 'failed' | 'canceled' required

capabilitystring required

workload_type'model' | 'social_operation'

modelstring nullable

Caller-requested model verbatim (may be 'auto'). Null for social_operation tasks.

resolved_modelstring nullable

Actual model that ran (null until execution starts; equals model for explicit-model calls)

model_selection_reasonunknown

metadataobject nullable

inputobject nullable

outputobject nullable

created_atstring date-time required

started_atstring date-time nullable

deadline_atstring date-time nullable

completed_atstring date-time nullable

cancel_requested_atstring date-time nullable

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