Orbit

Get slideshows for a keyword search

Retrieves slideshows (image carousels) linked to a keyword search with filtering, pagination, and sorting.

get/v1/orbit/{orbit_id}/slideshows

Request

  • Base URL: https://api.virlo.ai
  • URL: https://api.virlo.ai/v1/orbit/{orbit_id}/slideshows
  • Auth: HTTP bearer

Path parameters

orbit_idstring required

Orbit search ID (UUID) returned when the search was created.

Query parameters

limitnumber
Example:50

Maximum number of items to return. Values above 100 are clamped to 100 rather than rejected.

pagenumber
Example:1

Page number for pagination

min_viewsnumber
Example:10000

Minimum view count filter

platformsstring[]

Filter by platform(s)

start_datestring
Example:2024-01-01T00:00:00Z

Filter videos published after this date (ISO date string)

end_datestring
Example:2024-12-31T23:59:59Z

Filter videos published before this date (ISO date string)

order_by'publish_date' | 'views' | 'created_at'
Example:publish_date

Field to sort by

sort'asc' | 'desc'
Example:desc

Sort direction

intent_matchboolean

Filter videos by intent match result. Only applies when the search used intent + data_intelligence_enabled. Pass true to get only matching videos, false for non-matching.

Response

Successfully retrieved slideshows

Example response

{
  "data": {
    "orbit_id": "550e8400-e29b-41d4-a716-446655440000",
    "total": 210,
    "limit": 50,
    "slideshows": [
      {
        "url": "https://www.tiktok.com/@user/photo/123",
        "platform": "tiktok",
        "views": 250000,
        "likes": 12000,
        "shares": 500,
        "comments": 340,
        "bookmarks": 1200,
        "publish_date": "2026-01-15T10:30:00.000Z",
        "hashtags": [
          "fyp",
          "viral"
        ],
        "images": [
          {
            "image_url": "https://storage.example.com/slideshow-images/abc.webp"
          }
        ],
        "author": {
          "username": "creator_handle",
          "avatar_url": "https://auth.virlo.ai/storage/v1/object/public/avatars/abc.jpg",
          "followers": 160726,
          "country": "US"
        },
        "keyword_found_by": "fitness tips",
        "region": "US",
        "intelligence_status": "pending"
      }
    ]
  }
}

Changes

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