Skip to main content
GET
/
image
List images
curl --request GET \
  --url https://api.videodb.io/image/ \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "data": {
    "images": [
      {
        "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"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.videodb.io/llms.txt

Use this file to discover all available pages before exploring further.

Retrieves all images in a collection. Returns a list of image objects with metadata like name, URL, and ID. 
import videodb

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

images = coll.get_images()
for image in images:
    print(f"Image: {image.name} (ID: {image.id})")
  • Returns all images in the collection specified by the collection_id parameter
  • Image IDs have an i- prefix (e.g., i-a1b2c3d4)
  • Each image has properties: id, collection_id, name, and url

Collection Guide

Learn how to organize images in collections

Get Image Details

Retrieve a specific image

Authorizations

​
x-access-token
string
header
required

API key for authentication (sk-xxx format)

Query Parameters

​
collection_id
string
Example:

"default"

Response

200 - application/json

List of images

​
success
boolean
Example:

true

​
data
object