Skip to main content
GET
/
image
/
{image_id}
Get image details
curl --request GET \
  --url https://api.videodb.io/image/{image_id} \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "data": {
    "id": "img-12345",
    "name": "image.jpg",
    "collection_id": "default",
    "width": 1920,
    "height": 1080,
    "size": 262144,
    "url": "https://assets.videodb.io/img/12345.jpg",
    "created_at": "2023-11-07T05:31:56Z"
  }
}
Retrieves detailed information about a specific image including its name, URL, and collection association.
import videodb

conn = videodb.connect(api_key="your_api_key")
coll = conn.get_collection()

image = coll.get_image("i-xyz789")
print(f"Name: {image.name}")
print(f"URL: {image.url}")
print(f"Collection ID: {image.collection_id}")
  • Requires the collection_id parameter to be passed with the request
  • Returns an Image object with properties: id, name, url, and collection_id
  • Image ID must be valid and belong to the specified collection

Authorizations

x-access-token
string
header
required

API key for authentication (sk-xxx format)

Path Parameters

image_id
string
required
Example:

"img-12345"

Query Parameters

collection_id
string
Example:

"default"

Response

200 - application/json

Image details

success
boolean
Example:

true

data
object