Pureframe AI API Documentation

All clients below use the same underlying local server, started via npx -y @pureframeai/mcp, with one required environment variable: PUREFRAME_API_KEY (see API Keys). Use a read_only key for agent integrations that only need to search.

Run this once:

claude mcp add pureframe -- npx -y @pureframeai/mcp

Or add it manually to ~/.claude.json:

{
  "mcpServers": {
    "pureframe": {
      "command": "npx",
      "args": ["-y", "@pureframeai/mcp"],
      "env": { "PUREFRAME_API_KEY": "pf_..." }
    }
  }
}

Try it: “Search my videos for a customer mentioning pricing objections.”

Add to ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "pureframe": {
      "command": "npx",
      "args": ["-y", "@pureframeai/mcp"],
      "env": { "PUREFRAME_API_KEY": "pf_..." }
    }
  }
}

Restart Claude Desktop. Try it: “List my video collections.”

Add to .cursor/mcp.json:

{
  "mcpServers": {
    "pureframe": {
      "command": "npx",
      "args": ["-y", "@pureframeai/mcp"],
      "env": { "PUREFRAME_API_KEY": "pf_..." }
    }
  }
}

Try it: “Find a clip of someone pointing at a whiteboard.”

Add to .vscode/mcp.json. Note the root key is servers, not mcpServers:

{
  "servers": {
    "pureframe": {
      "command": "npx",
      "args": ["-y", "@pureframeai/mcp"],
      "env": { "PUREFRAME_API_KEY": "pf_..." }
    }
  }
}

Open Copilot Chat, switch to Agent mode, and try it: “Search our demo videos for the pricing slide.”

Add to ~/.codex/config.toml:

[mcp_servers.pureframe]
command = "npx"
args = ["-y", "@pureframeai/mcp"]

[mcp_servers.pureframe.env]
PUREFRAME_API_KEY = "pf_..."

Try it: “Get details on the video with the highest storage usage.”

Add to opencode.json in your project root:

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "pureframe": {
      "type": "local",
      "command": ["npx", "-y", "@pureframeai/mcp"],
      "environment": { "PUREFRAME_API_KEY": "pf_..." }
    }
  }
}

Try it: “Search my footage for a whiteboard diagram.”

Config file locations

Client	Config file	Root key
Claude Code	`~/.claude.json`	`mcpServers`
Claude Desktop	`~/Library/Application Support/Claude/claude_desktop_config.json`	`mcpServers`
Cursor	`.cursor/mcp.json`	`mcpServers`
VS Code	`.vscode/mcp.json`	`servers`
Codex	`~/.codex/config.toml`	`mcp_servers.<name>` (TOML table)
OpenCode	`opencode.json`	`mcp`

Remote MCP (no install)

For clients that support remote MCP endpoints, including Claude.ai, connect directly to the hosted endpoint:

{
  "mcpServers": {
    "pureframe": {
      "url": "https://mcp.pureframe.ai",
      "headers": { "Authorization": "Bearer pf_..." }
    }
  }
}

The remote endpoint can’t read your local filesystem, so upload_video is available only on the local npx server.

Scoping to a collection

Pass collection_id to search_videos to limit results to one library. Call list_collections first to discover available IDs:

{
  "tool": "search_videos",
  "input": {
    "query": "customer objection about pricing",
    "collection_id": "col_abc123",
    "limit": 5
  }
}

Rate limits

Agent tool calls share the same limits as the REST API: 30 requests/minute for search_videos. See Rate Limits.

Troubleshooting

Client doesn’t detect the server: restart the client after editing its config file. For Claude Code, confirm with claude mcp list. “Invalid API key” errors: check that PUREFRAME_API_KEY (or the Authorization header for remote MCP) is set correctly and hasn’t been revoked in API Keys. No results returned: confirm the target video is searchable and collection_id identifies the intended collection. Try a more concrete query or a different search mode. Image searches can omit collection_id; text-only searches require it. npx command not found: the local server requires Node.js. Install it, or use the remote MCP endpoint instead, which requires no local runtime.

Get Started

Search

Video Processing

Agents

Production

Resources

Connect an Agent

Config file locations

Remote MCP (no install)

Scoping to a collection

Rate limits

Troubleshooting

​Config file locations

​Remote MCP (no install)

​Scoping to a collection

​Rate limits

​Troubleshooting

Config file locations

Remote MCP (no install)

Scoping to a collection

Rate limits

Troubleshooting