Images

Describe / caption an image (sync)

Generate a natural-language description or caption (e.g. alt text) for an image in your library. Synchronous - the description is returned directly in the response.

post/v1/images/describe

Request

  • Base URL: https://contentmaschine.ai/api
  • URL: https://contentmaschine.ai/api/v1/images/describe
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://contentmaschine.ai/api/oauth/authorize, token URL https://contentmaschine.ai/api/oauth/token)

Request body

file_uuidstring required

UUID of an image already in your library.

promptstring

Optional instruction to steer the description.

Example request

{
  "prompt": "Write concise SEO alt text"
}

Response

Description generated

successboolean

Example response

{
  "success": true
}

Changes

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