API Documentation

Explore Our API

Welcome to the AI Quick Transcript API documentation. You can explore the available endpoints, understand request/response formats, and test the API directly using the interactive interfaces below.

Authentication is required for most endpoints and is handled via API Keys passed in the X-API-Key header. You can manage your API keys from the API Keys page after logging in.

Interactive API Docs (Swagger UI) Alternative API Docs (ReDoc)

Getting Started

  1. Sign Up/Log In: Access the main application to create an account or log in.
  2. Get API Key: Navigate to the API Keys section (requires login) to generate your unique API key.
  3. Authenticate: Include your API key in the X-API-Key header for all API requests that require authentication (e.g., X-API-Key: vdz_your_key_here).
  4. Explore Endpoints: Use the Swagger UI or ReDoc links above to see detailed information about each endpoint, including request parameters and response schemas.
  5. Manage Credits: Transcription and summarization consume credits. Manage your balance and purchase more credits through the application interface or relevant API endpoints (like /payments/packages and /payments/create-checkout).

Authentication

Most API endpoints require authentication using an API key. Generate your keys on the API Keys page (login required). Include the key in the X-API-Key HTTP header with each request.

Example using curl: 

curl -X GET "https://quicktranscript.app/api/auth/test" -H "X-API-Key: vdz_your_api_key"

The /api/auth/test endpoint verifies an API key using only the X-API-Key header. No email address is required. A valid key returns 200 OK: 

{
  "authenticated": true,
  "user_email": null
}

user_email is optional and is included when it is available for the account.

Check Credit Balance

Use GET /api/credits to check the authenticated account's current balance without spending credits. No email address is required. 

curl "https://quicktranscript.app/api/credits" -H "X-API-Key: vdz_your_api_key"
{"credits": 12}

Accounts without a credit balance return {"credits": 0}. Missing or invalid authentication returns 401 Unauthorized.

Create a Transcription

Submit an audio or video file to POST /api/transcriptions. By default, the job returns both a transcription and an AI-generated summary. 

curl -X POST "https://quicktranscript.app/api/transcriptions" \
  -H "X-API-Key: vdz_your_api_key" \
  -F "file=@meeting.mp3"

For transcription only, set the optional summarize query parameter to false: 

curl -X POST "https://quicktranscript.app/api/transcriptions?summarize=false" \
  -H "X-API-Key: vdz_your_api_key" \
  -F "file=@meeting.mp3"

Both requests return a task ID for polling. Transcription-only results contain the full transcription and return summary_html: null. Omitting the parameter is equivalent to summarize=true.

Remote MCP Server

AI agents and other Model Context Protocol (MCP) clients can use QuickTranscript through a hosted MCP server. It uses the same API keys and credits as the REST API. Configure your MCP client with these connection settings:

SettingValue
URLhttps://quicktranscript.app/mcp/ (include the trailing slash)
TransportStreamable HTTP
AuthenticationHeader X-API-Key: vdz_your_api_key, or Authorization: Bearer vdz_your_api_key for clients that only send bearer tokens. Sent with every request. OAuth connectors use an OAuth access token instead (see below).

The server provides four tools:

To transcribe a local file, agents that can run shell commands or send HTTP requests call create_upload_url, POST the file to the returned URL with the returned token, then poll the task ID with get_transcription_status. Chat-only apps still need a public URL. Clients that let you set a custom header or a bearer token can use your API key directly. This works with developer tools such as Claude Code, the Claude API MCP connector, the OpenAI Responses API, Cursor, and the MCP SDKs.

OAuth connectors (claude.ai, ChatGPT): in Claude, connect the official QuickTranscript connector from the Claude directory. In ChatGPT, or as a Claude custom connector, add the same URL, https://quicktranscript.app/mcp/, with OAuth. The client discovers and registers itself, then opens a QuickTranscript approval page where you paste an existing API key (create one on the API keys page) and click Approve. Approving lets the client submit media-URL transcriptions that spend your credits, read your tasks' status and results, and read your credit balance. Ticking Also allow starting meeting bots additionally lets it start, check, and stop Teams or Zoom meeting bots. Access tokens last 1 hour and refresh automatically; after 30 days, reconnect. To disconnect, revoke the API key; use a dedicated key per connector. The server must be reachable over public HTTPS, and connector availability depends on your plan, workspace, and admin policies.

OAuth details: discovery at /.well-known/oauth-protected-resource and /.well-known/oauth-authorization-server; endpoints /authorize, /token, /register (Dynamic Client Registration), and /revoke; authorization code with PKCE S256; scope mcp. Unauthenticated MCP requests return 401 with WWW-Authenticate: Bearer resource_metadata="https://quicktranscript.app/.well-known/oauth-protected-resource/mcp/", scope="mcp".

The Swagger UI, ReDoc, and /openapi.json describe the REST API only, not the MCP tools. MCP clients discover tool input and output schemas with tools/list. See the LLM Integration Guide for tool contracts, error handling, and a complete Python example.

Zapier Integration

Our API supports Zapier integration, allowing you to automatically connect completed transcriptions to thousands of apps. The following endpoints are specifically designed for Zapier workflows:

Popular Zapier Workflows:

To set up Zapier integration, you'll need to create a Zapier app using our API endpoints. Contact us for developer documentation and setup assistance.

If you encounter any issues or have questions, please refer to the main application or contact support if applicable.