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.

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.

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:

• Authentication Test: GET /api/auth/test - Verify API key authentication
• Completed Transcriptions: GET /api/transcriptions/completed - Poll for new completed transcriptions
• Create Transcription: POST /api/transcriptions - Submit new transcription jobs
• Check Status: GET /api/transcriptions/{task_id} - Monitor transcription progress

Popular Zapier Workflows:

• 📊 Google Sheets: Automatically add completed transcriptions to a spreadsheet
• 💬 Slack: Send transcription summaries to team channels
• 📧 Email: Get notified when transcriptions complete
• 📝 Notion: Save transcriptions to your knowledge base
• 🗂️ Airtable: Organize transcriptions in a database

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.