Generate alternative text for an image

Generates alternative text from the stored 400-pixel JPEG thumbnail and optional post text used as untrusted context, then saves it only when the media still has no alternative text.

POST/media/{id}/alt-text/generate

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Media ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

locale?string

BCP 47 locale for the generated alt text; defaults to English

Match^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$

Lengthlength <= 35

post_context?string

Optional post text used only to disambiguate details visible in the image

Lengthlength <= 1000

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/media/string/alt-text/generate" \  -H "Content-Type: application/json" \  -d '{}'

{  "$schema": "https://example.com/api/v1/schemas/GenerateMediaAltTextOutputBody.json",  "alt_text": "string",  "generated": true,  "model": "string"}

Generate alternative text for an image

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/problem+json

403application/problem+json

404application/problem+json

422application/problem+json

429application/problem+json

500application/problem+json

502application/problem+json

503application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`