# Pureframe AI API Documentation

> Explore guides, API docs, and examples for the Pureframe AI API.

- [Overview](https://docs.pureframe.ai/get-started/overview.md): Video intelligence API — find any moment in your footage with text or an image.
- [Quickstart](https://docs.pureframe.ai/get-started/quickstart.md): Upload your first video and run your first search in under 5 minutes.
- [Authentication](https://docs.pureframe.ai/get-started/authentication.md): Authenticate API requests with a Bearer token.
- [API Keys](https://docs.pureframe.ai/get-started/api-keys.md): API keys authenticate your requests. Create and manage them from the dashboard.
- [Key Concepts](https://docs.pureframe.ai/get-started/key-concepts.md): The five ideas that explain how everything else in the API works.
- [Overview](https://docs.pureframe.ai/search/overview.md): Find any moment in your video library using text, an image, or both.
- [Text Search](https://docs.pureframe.ai/search/text.md): Find moments using a natural language description.
- [Image Search](https://docs.pureframe.ai/search/image.md): Find visually similar moments using a reference image instead of words.
- [Transcript Search](https://docs.pureframe.ai/search/transcript.md): Search only what was said, ignoring visual content.
- [Combined Queries](https://docs.pureframe.ai/search/combined-queries.md): How Pureframe AI merges visual, transcript, scene, and text signals into one ranked result set.
- [Search a Video](https://docs.pureframe.ai/search/search-a-video.md): Working with one specific video once you've found it.
- [Search a Collection](https://docs.pureframe.ai/search/search-a-collection.md): Scope a search to one collection instead of your whole library.
- [Search Results](https://docs.pureframe.ai/search/search-results.md): The shape of a search response — video groups, segments, and every field on them.
- [Exact Timestamps](https://docs.pureframe.ai/search/exact-timestamps.md): What timestamp_start and timestamp_end actually represent, and their real precision.
- [Frame Map](https://docs.pureframe.ai/search/frame-map.md): A visual 2D map of your entire video library, organized by visual similarity.
- [Upload Videos](https://docs.pureframe.ai/video-processing/upload-videos.md): How to upload a video and track its processing status.
- [Processing Lifecycle](https://docs.pureframe.ai/video-processing/processing-lifecycle.md): What happens inside Pureframe AI's pipeline while a video is being indexed.
- [Collections](https://docs.pureframe.ai/video-processing/collections.md): Organize videos into named groups and scope searches to a specific library.
- [Transcripts](https://docs.pureframe.ai/video-processing/transcripts.md): How Pureframe AI transcribes audio, and how to retrieve what was said.
- [Embeddings](https://docs.pureframe.ai/video-processing/embeddings.md): How Pureframe AI turns video frames into searchable vectors.
- [Metadata](https://docs.pureframe.ai/video-processing/metadata.md): Reference for every object field returned by the Pureframe AI API.
- [Processing Status](https://docs.pureframe.ai/video-processing/processing-status.md): Poll a job's status while a video is being indexed.
- [Agent Vision](https://docs.pureframe.ai/agents/agent-vision.md): Give any AI agent the ability to see and search your video library.
- [MCP Overview](https://docs.pureframe.ai/agents/mcp-overview.md): Connect Pureframe AI to any AI agent via the Model Context Protocol.
- [Connect an Agent](https://docs.pureframe.ai/agents/connect-an-agent.md): Per-client setup for the Pureframe AI MCP server.
- [Source-backed Results](https://docs.pureframe.ai/agents/source-backed-results.md): Every answer an agent gives can be traced back to an exact clip.
- [Agent Security](https://docs.pureframe.ai/agents/agent-security.md): What an agent can and can't do with your library, and how to scope it safely.
- [Pureframe AI Agent Setup Instructions](https://docs.pureframe.ai/agent-setup/prompt.md): Machine-readable setup instructions for AI agents connecting to the Pureframe AI MCP server.
- [Webhooks](https://docs.pureframe.ai/production/webhooks.md): Get real-time HTTP notifications when events happen in your account.
- [Rate Limits](https://docs.pureframe.ai/production/rate-limits.md): Per-key request limits and how to handle 429s.
- [Errors](https://docs.pureframe.ai/production/errors.md): Machine-readable error codes returned by the Pureframe AI API.
- [Performance](https://docs.pureframe.ai/production/performance.md): How Pureframe AI keeps search fast, and what affects latency.
- [Usage and Billing](https://docs.pureframe.ai/production/usage-and-billing.md): Free tier limits and Pay as you go plan pricing.
- [Data Handling](https://docs.pureframe.ai/production/data-handling.md): What Pureframe AI stores, for how long, and what happens when you delete something.
- [Security](https://docs.pureframe.ai/production/security.md): What Pureframe AI guarantees today, and what it doesn't yet.
- [Examples](https://docs.pureframe.ai/resources/examples.md): End-to-end walkthroughs combining multiple Pureframe AI features.
- [Use Cases](https://docs.pureframe.ai/resources/use-cases.md): Common ways teams use Pureframe AI to build video-aware applications.
- [Changelog](https://docs.pureframe.ai/resources/changelog.md): What's new in Pureframe AI.
- [FAQ](https://docs.pureframe.ai/resources/faq.md): Frequently asked questions about Pureframe AI.
- [Overview](https://docs.pureframe.ai/api-reference/overview.md): The Pureframe AI REST API — base URL, authentication, and response format.
- [List Collections](https://docs.pureframe.ai/api-reference/collections/list-collections.md): List all collections in the authenticated org, ordered by creation date.
- [Create Collection](https://docs.pureframe.ai/api-reference/collections/create-collection.md): Create a new collection. Collection names must be unique per org.
- [Get Collection](https://docs.pureframe.ai/api-reference/collections/get-collection.md): Get collection details including total video duration and storage usage.
- [Delete Collection](https://docs.pureframe.ai/api-reference/collections/delete-collection.md): Permanently delete a collection and all its videos and indexed segments. This action cannot be undone.
- [Update Collection](https://docs.pureframe.ai/api-reference/collections/update-collection.md): Rename a collection. The new name must not conflict with an existing collection.
- [Upload Video](https://docs.pureframe.ai/api-reference/upload/upload-video.md): Upload a video file to a collection for indexing.
- [Get Job](https://docs.pureframe.ai/api-reference/jobs/get-job.md): Poll the status of a video processing job. Status progresses: `queued` → `processing` → `done` (or `failed`).
- [List Videos](https://docs.pureframe.ai/api-reference/videos/list-videos.md): List all videos in the authenticated org. Filter by collection or processing status (comma-separated).
- [Get Video](https://docs.pureframe.ai/api-reference/videos/get-video.md): Get full details for a single video, including a presigned playback URL and indexed segment count.
- [Delete Video](https://docs.pureframe.ai/api-reference/videos/delete-video.md): Permanently delete a video and all its indexed segments. This action cannot be undone.
- [Get Video Moment](https://docs.pureframe.ai/api-reference/videos/get-video-moment.md): Scene caption/labels covering `timestamp`, if this video has caption enrichment (Pay as you go/Enterprise). This is best-effort context for the player — not every moment has a scene captioned, so an empty result is normal and never a 404.
- [Search](https://docs.pureframe.ai/api-reference/search/search.md): Search for video segments matching a text query, image file, or image URL.
- [Log Search Click](https://docs.pureframe.ai/api-reference/search/log-search-click.md): Implicit relevance signal: which result a user actually opened, at what rank and lane. Rides the existing PostHog pipe (search_result_clicked, unchanged) for CTR analytics, AND now also writes to search_click_logs — the first time click events land in Postgres — so the adaptive threshold tuning job…
- [Submit Search Feedback](https://docs.pureframe.ai/api-reference/search/submit-search-feedback.md)
- [Clear Search Feedback](https://docs.pureframe.ai/api-reference/search/clear-search-feedback.md)
- [Suggest Search](https://docs.pureframe.ai/api-reference/search/suggest-search.md): Search-as-you-type suggestions from indexed dialogue/on-screen text and past queries. Fails open (empty list) on any error — suggestions must never block or error out the search box. Not billable: unlike /v1/search, this does no embedding or Qdrant work.
- [Agent Schema](https://docs.pureframe.ai/api-reference/agent/agent-schema.md): Returns an OpenAI-compatible tool schema for all available agent tools.
- [Agent Call](https://docs.pureframe.ai/api-reference/agent/agent-call.md): Invoke a Pureframe tool by name. Designed for AI agents and LLM tool-calling integrations.
- [Get Framemap](https://docs.pureframe.ai/api-reference/framemap/get-framemap.md)
- [List Endpoints](https://docs.pureframe.ai/api-reference/webhooks/list-endpoints.md)
- [Create Endpoint](https://docs.pureframe.ai/api-reference/webhooks/create-endpoint.md)
- [Delete Endpoint](https://docs.pureframe.ai/api-reference/webhooks/delete-endpoint.md)
- [Update Endpoint](https://docs.pureframe.ai/api-reference/webhooks/update-endpoint.md)
- [Test Endpoint](https://docs.pureframe.ai/api-reference/webhooks/test-endpoint.md)
- [List Deliveries](https://docs.pureframe.ai/api-reference/webhooks/list-deliveries.md)
- [Retry Delivery](https://docs.pureframe.ai/api-reference/webhooks/retry-delivery.md)
- [Python SDK](https://docs.pureframe.ai/sdks/python-sdk.md): Official Python client, generated from the OpenAPI spec.
- [JavaScript SDK](https://docs.pureframe.ai/sdks/javascript-sdk.md): Official TypeScript/Node.js client, generated from the OpenAPI spec.
- [MCP Server](https://docs.pureframe.ai/sdks/mcp-server.md): The @pureframeai/mcp package — install, run, and deploy options.

## OpenAPI Specs

- [openapi](/openapi.json)