Images

Retrieve information about an existing image

get/images/{asset_id}

Request

  • Base URL: https://alttext.ai/api/v1
  • URL: https://alttext.ai/api/v1/images/{asset_id}
  • Auth: API key in header X-API-Key

Path parameters

asset_idstring required

The asset ID of the image to retrieve.

Response

Successful retrieval of the image data

asset_idstring

The unique ID of the image.

urlstring

The URL of the image. Will be null if the image was added via raw file upload.

alt_textstring

The assigned alt text of the image.

alt_textsobject

Alt text in requested languages, with language codes as keys.

metadataobject

Any custom information you want to store. This will be passed back on all API requests and webhooks.

created_atinteger

Creation date of the image, in seconds since epoch.

errorsobject

Any errors associated with this image. Note - This will be an empty object for valid images.

error_code'insufficient_credits' | 'invalid_params' | 'general'

An identifier describing the type of error, if any.

Changes

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