Get image description

February 24, 2025

Table of contents

  1. Request Headers
  2. Path parameter
  3. Responses
  4. Model
  5. Examples
  6. Try It

Extract a text image description that can be adjusted and used as a starting point for the prompt in POST frames/create.

This endpoint is available for all Runway accounts, including free ones.

https://api.useapi.net/v1/runwayml/frames/describe/image_assetId

Request Headers
Authorization: Bearer {API token}
Content-Type: application/json
Path parameter
  • image_assetId is required. Specify the image asset. You can upload an image via POST assets, you can get a list of all image assets via GET assets.
Responses
  • 200 OK

    {
        "prompt": "Subject: A woman wearing an elegant Greco-Roman style ivory silk dress with ornate golden embellishments at the neckline and waist. Multiple golden bangles adorn her wrists as she stands in a graceful pose with one hand extended to touch a column.\n\nScene: Ancient stone columns with weathered surfaces frame a shadowy interior space. The architectural elements suggest a classical temple or palace setting with fluted pillars and worn stone textures visible in the warm lighting.\n\nStyle: Dramatic chiaroscuro lighting creates deep shadows while highlighting the luxurious fabric draping and metallic details. The composition emphasizes classical beauty through careful attention to form, texture, and light interplay. Professional fashion photography meets fine art painting aesthetic. Classical, dramatic lighting, textile-focused, painterly, architectural."
    }
    
  • 400 Bad Request

    {
        "error": "<Error message>",
        "code": 400
    }
    
  • 401 Unauthorized

    {
      "error": "Unauthorized",
      "code": 401
    }
    
Model
{ // TypeScript, all fields are optional
    prompt: string
    error: string
    code: number
}
Examples
  • curl "https://api.useapi.net/v1/runwayml/frames/describe/image_assetId" \
       -H "Accept: application/json" \
       -H "Authorization: Bearer …" 
    
  • const token = "API token";
    const image_assetId = "image_assetId to retrieve"; 
    const apiUrl = `https://api.useapi.net/v1/runwayml/frames/describe/${image_assetId}`; 
    const response = await fetch(apiUrl, {
      headers: {
        "Authorization": `Bearer ${token}`,
      },
    });
    const result = await response.json();
    console.log("response", {response, result});
    
  • import requests
    token = "API token"
    image_assetId = "image_assetId to retrieve"
    apiUrl = f"https://api.useapi.net/v1/runwayml/frames/describe/{image_assetId}"
    headers = {
        "Content-Type": "application/json", 
        "Authorization" : f"Bearer {token}"
    }
    response = requests.get(apiUrl, headers=headers)
    print(response, response.json())
    
Try It