Alt Text Generation

GET api/v1/generations/alt-text?url=https://assets.imgix.net/photo.jpg&language=en,fr

{
  "alt_text": {
    "en": "a havanese puppy sitting on a wooden floor, looking up at the camera",
    "fr": "un chiot havanais assis sur un parquet, regardant l'objectif"
  },
  "failed_languages": [],
  "overridden_languages": []
}

POST api/v1/generations/alt-text
{
  "url": "https://assets.imgix.net/photo.jpg",
  "alt_text": {
    "en": "Maya the havanese puppy sitting on a wooden floor, looking up at the camera",
    "fr": null
  }
}

{
  "alt_text": {
    "en": "Maya the havanese puppy sitting on a wooden floor, looking up at the camera"
  },
  "removed_languages": ["fr"]
}

curl -X GET "https://api.imgix.com/api/v1/generations/alt-text?url=https://assets.imgix.net/photo.jpg&language=en,es" \
  -H "Authorization: Bearer YOUR_API_KEY"
# Response:
# {
#   "alt_text": {
#     "en": "a havanese puppy sitting on a wooden floor, looking up at the camera",
#     "es": "un cachorro habanero sentado en un suelo de madera, mirando a la cámara"
#   },
#   "failed_languages": [],
#   "overridden_languages": []
# }

# To run:
# $ python3 demo.py
# Ensure to export your API key into your environment
import os
import requests
 
IMGIX_API_KEY = os.environ.get("IMGIX_API_KEY")
if not IMGIX_API_KEY:
    raise ValueError(
r"""
An Imgix API Key is required, export it or
use dotenv to load it from an .env file
""")
 
resp = requests.get(
    url="https://api.imgix.com/api/v1/generations/alt-text",
    headers={"Authorization": f"Bearer {IMGIX_API_KEY}"},
    params={
        "url": "https://assets.imgix.net/photo.jpg",
        "language": "en,es",
    },
)
 
if resp.status_code in [401, 403]:
    raise ValueError(
        "You do not have permission, ensure alt text generation is enabled for your source."
    )
 
data = resp.json()
print(data["alt_text"])
if data["failed_languages"]:
    print(f"failed languages: {data['failed_languages']}")

curl -X POST "https://api.imgix.com/api/v1/generations/alt-text" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://assets.imgix.net/photo.jpg",
    "alt_text": {
      "en": "Maya the havanese puppy sitting on a wooden floor, looking up at the camera"
    }
  }'
# Response:
# {
#   "alt_text": {
#     "en": "Maya the havanese puppy sitting on a wooden floor, looking up at the camera"
#   },
#   "removed_languages": []
# }

# To run:
# $ python3 demo.py
# Ensure to export your API key into your environment
import os
import requests
 
IMGIX_API_KEY = os.environ.get("IMGIX_API_KEY")
if not IMGIX_API_KEY:
    raise ValueError(
r"""
An Imgix API Key is required, export it or
use dotenv to load it from an .env file
""")
 
resp = requests.post(
    url="https://api.imgix.com/api/v1/generations/alt-text",
    headers={"Authorization": f"Bearer {IMGIX_API_KEY}"},
    json={
        "url": "https://assets.imgix.net/photo.jpg",
        "alt_text": {
            "en": "Maya the havanese puppy sitting on a wooden floor, looking up at the camera",
        },
    },
)
 
if resp.status_code == 409:
    raise ValueError(
        "No generated alt text exists for this image yet; generate it first with a GET request."
    )
if resp.status_code in [401, 403]:
    raise ValueError(
        "You do not have permission, ensure alt text generation is enabled for your source."
    )
 
data = resp.json()
print(data["alt_text"])
if data["removed_languages"]:
    print(f"removed overrides: {data['removed_languages']}")