API Reference
Getting Started
The FrameQuery API allows you to programmatically upload, analyze, and search video content. To use the API, you'll need an API key, which you can generate in your account settings.
Base URL
All API requests should be made to the following base URL:
https://api.framequery.com/v1
Authentication
All API requests require authentication. Include your API key in the request headers:
Authorization: Bearer YOUR_API_KEY
Rate Limiting
API requests are rate-limited to 100 requests per second. If you exceed this limit, you'll receive a 429 Too Many Requests response.
Authentication
Endpoints for authenticating with the FrameQuery API
/api/auth/tokenGenerate an API token
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| secret | string | Yes | Your secret key |
Videos
Endpoints for managing and analyzing videos
/api/videosList all videos in your account
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number for pagination |
| limit | integer | No | Number of results per page |
| status | string | No | Filter by video status (new, processing, processed) |
/api/videos/signed-urlRetrieve a signed URL for uploading a video
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| file name | string | Yes | The name of the video file to upload |
/api/videos/uploadUpload a new video for analysis
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| file | file | Yes | The video file to upload |
/api/videos/{id}Get details for a specific video
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | The video ID |
/api/videos/{id}Delete a video
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | The video ID |
Search
Endpoints for searching video content
/api/searchSearch across all videos
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| q | string | Yes | Search query |
| type | string | No | Search type (transcript, object, scene, all) |
| page | integer | No | Page number for pagination |
| limit | integer | No | Number of results per page |
/api/videos/{id}/searchSearch within a specific video
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | The video ID |
| q | string | Yes | Search query |
| type | string | No | Search type (transcript, object, scene, all) |