Generate alt text

Queues a description of an image, written to be read aloud. Returns a task; the text arrives on its result.

POST/image/alt

AuthAPI keyorOAuth tokenHow to send it

Request body#

urlstringrequired

Response#

Image alt text task created

dataobjectrequired

estimatedCoststringrequired: Estimated cost in USD reserved for this task. Failed tasks are not charged.
e.g. "0.0002"
taskIdstringrequired: Task ID
e.g. "tsk_01KE7XWWEQ4MCGWKBQKJ1G47RP"

Errors#

A failed call names what went wrong in code, with a sentence in message. The codes, which of them are worth retrying, and how to read a validation failure are on Errors.

Request

curl -X POST https://api.mynth.io/image/alt \
  -H "Authorization: Bearer $MYNTH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "string"
  }'

Response

{
  "data": {
    "estimatedCost": "0.0002",
    "taskId": "tsk_01KE7XWWEQ4MCGWKBQKJ1G47RP"
  }
}