# Scribiz docs

> Use Scribiz from the web, a command-line tool on npm, an MCP server or an HTTP API. The Mac app is not published yet. Every page is also raw Markdown: add .md to the path.

## Start

- [Overview](https://scribiz.com/docs/overview.md): What a Context is, the four layers it holds, and how Auto, Listen, Watch and Both decide what runs.
- [Quickstart](https://scribiz.com/docs/quickstart.md): Run your first Context in about a minute, from the web, an MCP client, the command line or the API.
- [Authentication](https://scribiz.com/docs/authentication.md): Sign in on the web or from the CLI, create API keys, and use your own Gemini key. Which credential wins, and what logout does.
- [Minutes and billing](https://scribiz.com/docs/minutes-and-billing.md): How minutes are counted, what each mode costs, what the plans include, and where to see your usage.
- [Sources and limits](https://scribiz.com/docs/sources-and-limits.md): Which links and files work where, why Instagram and sites that block servers work best from your own machine, and the size and length limits.
- [Privacy and data handling](https://scribiz.com/docs/privacy-and-data.md): What leaves your device, what Scribiz keeps and for how long, what Google sees, and how to delete a result.

## CLI

- [Install the CLI](https://scribiz.com/docs/cli.md): Install the scribiz command with npm, sign in to a free account or add your own Gemini key, check it with scribiz doctor, and find its files.
- [CLI commands](https://scribiz.com/docs/cli/commands.md): Every scribiz command, what it prints and where it writes, and the exit codes a script can rely on.
- [CLI flags](https://scribiz.com/docs/cli/flags.md): Every scribiz flag with its values and defaults, grouped by what it does.
- [Output formats](https://scribiz.com/docs/cli/formats.md): SRT, VTT, TXT, Markdown, Context and JSON, with a real sample of each and what the options change.
- [The JSON protocol](https://scribiz.com/docs/cli/json-protocol.md): The newline-delimited JSON the CLI prints with --json, so you can run it from your own tool.
- [Config and env](https://scribiz.com/docs/cli/config.md): The config file, the environment variables, the cache, and which setting wins.
- [CLI recipes](https://scribiz.com/docs/cli/recipes.md): Subtitles for an editor, a folder of recordings, chapters, a pipe into an LLM, screen recordings and CI.
- [CLI troubleshooting](https://scribiz.com/docs/cli/troubleshooting.md): What to do when a tool is missing, a link is blocked, sign-in fails, a key is rejected, minutes run out or a result looks incomplete.

## MCP

- [MCP overview](https://scribiz.com/docs/mcp.md): Give Claude, Cursor, Codex or any MCP client the context of a video, so it can search it, read parts of it and answer questions with timestamps.
- [MCP install per client](https://scribiz.com/docs/mcp/install.md): Add the Scribiz MCP server to Claude Code, Cursor, VS Code, Codex, Claude Desktop and claude.ai. No key to start, or run it locally with your account.
- [MCP connection modes](https://scribiz.com/docs/mcp/connection-modes.md): Remote without a key, remote with an API key, the local server with your account or Gemini key, and OAuth coming later. What each can do and which to pick.
- [MCP tools reference](https://scribiz.com/docs/mcp/tools.md): get_video_context, get_transcript, ask_video, search_video and get_job. Parameters, output shapes, detail levels, token budgets and citation links.
- [MCP recipes](https://scribiz.com/docs/mcp/recipes.md): Summarize a talk and find where a topic comes up, compare two videos, pull the steps out of a tutorial, and work on a local recording.
- [MCP limits and cost](https://scribiz.com/docs/mcp/limits.md): What each tool call costs in minutes, how long a call can take, the limits on the remote server, and what the errors mean.
- [MCP security](https://scribiz.com/docs/mcp/security.md): Transcripts are untrusted text. What the server sends and receives, how to protect your keys, and how to revoke access.

## API

- [API overview](https://scribiz.com/docs/api.md): The base URL, how jobs work, versioning, idempotency and where to find each endpoint. Everything the web tool does, over HTTP.
- [API authentication](https://scribiz.com/docs/api/authentication.md): Send an API key as a bearer token. How keys look, what scopes they have, how to rotate one, and what is not allowed.
- [API quickstart](https://scribiz.com/docs/api/quickstart.md): Create a job, wait for it, and read the Context, in curl, TypeScript and Python. Then stream progress and upload a file.
- [API endpoints](https://scribiz.com/docs/api/endpoints.md): Every route with its parameters, responses and status codes. Create jobs, follow them, upload files, ask questions, read your account and your keys.
- [The Context object](https://scribiz.com/docs/api/context-object.md): Every field of the Context: metadata, transcript, on-screen notes, summary, chapters, coverage, warnings and usage.
- [API errors and limits](https://scribiz.com/docs/api/errors.md): The error object, HTTP statuses, every error code with its CLI exit code, rate limits, quotas, upload limits and how to retry safely.

## Apps

- [Mac app](https://scribiz.com/docs/apps/mac.md): The Mac app is not published yet. How it will work: drop in a file or a link, pick a mode, add your own key, and export. License and scribiz:// links.