# Table of Contents - [Introduction - Fireflies.ai API Documentation](#introduction-fireflies-ai-api-documentation) - [Explore with Fireflies AI Assistant - Fireflies.ai API Documentation](#explore-with-fireflies-ai-assistant-fireflies-ai-api-documentation) - [Join the Developer Program - Fireflies.ai API Documentation](#join-the-developer-program-fireflies-ai-api-documentation) - [MCP Server Configuration - Fireflies.ai API Documentation](#mcp-server-configuration-fireflies-ai-api-documentation) - [General concepts - Fireflies.ai API Documentation](#general-concepts-fireflies-ai-api-documentation) - [LLM-based Development - Fireflies.ai API Documentation](#llm-based-development-fireflies-ai-api-documentation) - [Limits - Fireflies.ai API Documentation](#limits-fireflies-ai-api-documentation) - [API Examples Overview - Fireflies.ai API Documentation](#api-examples-overview-fireflies-ai-api-documentation) - [Introspection - Fireflies.ai API Documentation](#introspection-fireflies-ai-api-documentation) - [Super Admin - Fireflies.ai API Documentation](#super-admin-fireflies-ai-api-documentation) - [Authorization - Fireflies.ai API Documentation](#authorization-fireflies-ai-api-documentation) - [Errors - Fireflies.ai API Documentation](#errors-fireflies-ai-api-documentation) - [Basic API Examples - Fireflies.ai API Documentation](#basic-api-examples-fireflies-ai-api-documentation) - [AI Apps Schema - Fireflies.ai API Documentation](#ai-apps-schema-fireflies-ai-api-documentation) - [Realtime API Overview - Fireflies.ai API Documentation](#realtime-api-overview-fireflies-ai-api-documentation) - [AIFilter Schema - Fireflies.ai API Documentation](#aifilter-schema-fireflies-ai-api-documentation) - [App Output Schema - Fireflies.ai API Documentation](#app-output-schema-fireflies-ai-api-documentation) - [Channel Schema - Fireflies.ai API Documentation](#channel-schema-fireflies-ai-api-documentation) - [Realtime API Events Schema - Fireflies.ai API Documentation](#realtime-api-events-schema-fireflies-ai-api-documentation) - [Quickstart - Fireflies.ai API Documentation](#quickstart-fireflies-ai-api-documentation) - [AudioUploadStatus Schema - Fireflies.ai API Documentation](#audiouploadstatus-schema-fireflies-ai-api-documentation) - [MeetingAnalytics Schema - Fireflies.ai API Documentation](#meetinganalytics-schema-fireflies-ai-api-documentation) - [Realtime API Guide - Fireflies.ai API Documentation](#realtime-api-guide-fireflies-ai-api-documentation) - [MeetingInfo Schema - Fireflies.ai API Documentation](#meetinginfo-schema-fireflies-ai-api-documentation) - [Speaker Schema - Fireflies.ai API Documentation](#speaker-schema-fireflies-ai-api-documentation) - [Sentiments Schema - Fireflies.ai API Documentation](#sentiments-schema-fireflies-ai-api-documentation) - [Analytics Schema - Fireflies.ai API Documentation](#analytics-schema-fireflies-ai-api-documentation) - [Advanced API Examples - Fireflies.ai API Documentation](#advanced-api-examples-fireflies-ai-api-documentation) - [Summary Section Schema - Fireflies.ai API Documentation](#summary-section-schema-fireflies-ai-api-documentation) - [Sentence Schema - Fireflies.ai API Documentation](#sentence-schema-fireflies-ai-api-documentation) - [Summary Schema - Fireflies.ai API Documentation](#summary-schema-fireflies-ai-api-documentation) - [User Groups Schema - Fireflies.ai API Documentation](#user-groups-schema-fireflies-ai-api-documentation) - [Deprecated - Fireflies.ai API Documentation](#deprecated-fireflies-ai-api-documentation) - [Webhooks - Fireflies.ai API Documentation](#webhooks-fireflies-ai-api-documentation) - [API Documentation](#api-documentation) - [MeetingAttendee Schema - Fireflies.ai API Documentation](#meetingattendee-schema-fireflies-ai-api-documentation) - [User Group Member Schema - Fireflies.ai API Documentation](#user-group-member-schema-fireflies-ai-api-documentation) - [User Schema - Fireflies.ai API Documentation](#user-schema-fireflies-ai-api-documentation) - [Transcript Schema - Fireflies.ai API Documentation](#transcript-schema-fireflies-ai-api-documentation) - [What's New - Fireflies.ai API Documentation](#what-s-new-fireflies-ai-api-documentation) - [Error codes - Fireflies.ai API Documentation](#error-codes-fireflies-ai-api-documentation) - [Language codes - Fireflies.ai API Documentation](#language-codes-fireflies-ai-api-documentation) - [Changelog - Fireflies.ai API Documentation](#changelog-fireflies-ai-api-documentation) - [Unknown](#unknown) - [Page Not Found](#page-not-found) - [Page Not Found](#page-not-found) - [Create bite - Fireflies.ai API Documentation](#create-bite-fireflies-ai-api-documentation) - [Upload Audio - Fireflies.ai API Documentation](#upload-audio-fireflies-ai-api-documentation) - [Page Not Found](#page-not-found) - [Page Not Found](#page-not-found) - [Page Not Found](#page-not-found) - [MeetingAttendance Schema - Fireflies.ai API Documentation](#meetingattendance-schema-fireflies-ai-api-documentation) - [Transcript query - Fireflies.ai API Documentation](#transcript-query-fireflies-ai-api-documentation) - [AI Apps query - Fireflies.ai API Documentation](#ai-apps-query-fireflies-ai-api-documentation) - [User Groups query - Fireflies.ai API Documentation](#user-groups-query-fireflies-ai-api-documentation) - [Add to Live - Fireflies.ai API Documentation](#add-to-live-fireflies-ai-api-documentation) - [UpdateMeetingPrivacyInput Schema - Fireflies.ai API Documentation](#updatemeetingprivacyinput-schema-fireflies-ai-api-documentation) - [AudioUploadInput Schema - Fireflies.ai API Documentation](#audiouploadinput-schema-fireflies-ai-api-documentation) - [Transcripts query - Fireflies.ai API Documentation](#transcripts-query-fireflies-ai-api-documentation) - [Update Meeting Title - Fireflies.ai API Documentation](#update-meeting-title-fireflies-ai-api-documentation) - [Bite query - Fireflies.ai API Documentation](#bite-query-fireflies-ai-api-documentation) - [Delete Transcript - Fireflies.ai API Documentation](#delete-transcript-fireflies-ai-api-documentation) - [Bites query - Fireflies.ai API Documentation](#bites-query-fireflies-ai-api-documentation) - [Users query - Fireflies.ai API Documentation](#users-query-fireflies-ai-api-documentation) - [Set User Role - Fireflies.ai API Documentation](#set-user-role-fireflies-ai-api-documentation) - [Update Meeting Privacy - Fireflies.ai API Documentation](#update-meeting-privacy-fireflies-ai-api-documentation) - [Analytics query - Fireflies.ai API Documentation](#analytics-query-fireflies-ai-api-documentation) - [User query - Fireflies.ai API Documentation](#user-query-fireflies-ai-api-documentation) - [Attendee Schema - Fireflies.ai API Documentation](#attendee-schema-fireflies-ai-api-documentation) - [UpdateMeetingTitleInput Schema - Fireflies.ai API Documentation](#updatemeetingtitleinput-schema-fireflies-ai-api-documentation) - [Role Schema - Fireflies.ai API Documentation](#role-schema-fireflies-ai-api-documentation) - [Page Not Found](#page-not-found) --- # Introduction - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/getting-started/introduction#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... Ctrl K Search... Navigation Getting Started Introduction On this page * [Introduction](https://docs.fireflies.ai/getting-started/introduction#introduction) * [Overview of the API](https://docs.fireflies.ai/getting-started/introduction#overview-of-the-api) * [Advantages of Using GraphQL](https://docs.fireflies.ai/getting-started/introduction#advantages-of-using-graphql) * [Additional Resources](https://docs.fireflies.ai/getting-started/introduction#additional-resources) We are actively working to expose more functionality via our API. If you have specific requests, please [reach out to us](https://guide.fireflies.ai/) . [​](https://docs.fireflies.ai/getting-started/introduction#introduction) Introduction ======================================================================================== [​](https://docs.fireflies.ai/getting-started/introduction#overview-of-the-api) Overview of the API ------------------------------------------------------------------------------------------------------ The Fireflies API is built on top of GraphQL, a powerful interface designed to provide you with efficient and flexible access to your data. This API allows you to retrieve exactly the data you need in a structured format. Whether you are building a web application, a mobile app, or a complex software system, our API caters to a wide range of data requirements. Our API covers various functionalities, including queries for fetching data as well as uploading meeting audio. It is designed to be intuitive and easy to use, ensuring that you can start fetching and manipulating data with minimal setup. [​](https://docs.fireflies.ai/getting-started/introduction#advantages-of-using-graphql) Advantages of Using GraphQL ---------------------------------------------------------------------------------------------------------------------- **1\. Precise Data Fetching:** One of the key strengths of GraphQL is its ability to return exactly what you request and nothing more. This precision eliminates the over-fetching of data, common in traditional REST APIs, leading to more efficient network utilization and faster response times. **2\. Single Endpoint:** Unlike REST APIs, which often require multiple endpoints for different data needs, GraphQL operates through a single endpoint. This simplification streamlines interactions with the API and makes maintaining and managing the API more straightforward. **3\. Flexibility and Scalability:** GraphQL APIs are incredibly flexible, allowing for queries that can evolve with your needs. This flexibility, combined with efficient data retrieval, makes GraphQL an ideal choice for both small projects and large-scale applications. In the following sections, we will guide you through the essential components of our API, provide detailed examples, and offer best practices to help you make the most of our API. Whether you’re a new user or an experienced developer, this documentation is designed to assist you in seamlessly integrating the API into your applications. [​](https://docs.fireflies.ai/getting-started/introduction#additional-resources) Additional Resources -------------------------------------------------------------------------------------------------------- [Quickstart\ ----------\ \ Make your first request in under 5 minutes](https://docs.fireflies.ai/getting-started/quickstart) [Concepts\ --------\ \ Foundational guide to the core aspects of the Fireflies API](https://docs.fireflies.ai/fundamentals/concepts) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/getting-started/introduction.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/getting-started/introduction) [Quickstart](https://docs.fireflies.ai/getting-started/quickstart) Ctrl+I Assistant Responses are generated using AI and may contain mistakes. --- # Explore with Fireflies AI Assistant - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/getting-started/ask-docs#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Getting Started Chat with Fireflies AI Assistant On this page * [Overview](https://docs.fireflies.ai/getting-started/ask-docs#overview) * [Explore with Fireflies AI Assistant](https://docs.fireflies.ai/getting-started/ask-docs#explore-with-fireflies-ai-assistant) * [How to Use Fireflies AI Assistant](https://docs.fireflies.ai/getting-started/ask-docs#how-to-use-fireflies-ai-assistant) [​](https://docs.fireflies.ai/getting-started/ask-docs#overview) Overview ---------------------------------------------------------------------------- Welcome to the Fireflies.ai Documentation, your essential guide to unlocking the full potential of our API. We understand that diving into a new API can be daunting, and finding the specific information you need shouldn’t add to that challenge. That’s why we’ve designed our documentation to be both comprehensive and user-friendly, ensuring you get the answers you need without the hassle. [​](https://docs.fireflies.ai/getting-started/ask-docs#explore-with-fireflies-ai-assistant) Explore with Fireflies AI Assistant ---------------------------------------------------------------------------------------------------------------------------------- With our AI assistant, navigating the documentation becomes as intuitive as having a conversation. Whether you’re looking for detailed API endpoints, integration guides, or troubleshooting tips, our integrated AI assistant is here to assist you every step of the way. ### [​](https://docs.fireflies.ai/getting-started/ask-docs#how-to-use-fireflies-ai-assistant) How to Use Fireflies AI Assistant Getting started is simple: 1. **Access the Search Bar:** Click on the search bar at the top of the page, or use the shortcut `CMD + K` (for Mac users) or `Ctrl + K` (for Windows and Linux users) to jump straight to it. 2. **Ask Your Question:** Type in your question just as you would when talking to ChatGPT. Whether it’s a broad query about API capabilities or a specific request for code examples, the AI Assistant is ready to provide you with precise answers. [Quickstart\ ----------\ \ Foundational guide to the core aspects of the Fireflies API](https://docs.fireflies.ai/getting-started/quickstart) [Developer Program\ -----------------\ \ Join the Developer Program to build integrations with Fireflies.ai](https://docs.fireflies.ai/getting-started/developer-program) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/getting-started/ask-docs.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/getting-started/ask-docs) [Quickstart](https://docs.fireflies.ai/getting-started/quickstart) [Join the Developer Program](https://docs.fireflies.ai/getting-started/developer-program) ⌘I --- # Join the Developer Program - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/getting-started/developer-program#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Getting Started Join the Developer Program On this page * [Overview](https://docs.fireflies.ai/getting-started/developer-program#overview) * [Program Benefits](https://docs.fireflies.ai/getting-started/developer-program#program-benefits) * [How to Apply](https://docs.fireflies.ai/getting-started/developer-program#how-to-apply) * [Application Requirements](https://docs.fireflies.ai/getting-started/developer-program#application-requirements) * [Program Terms](https://docs.fireflies.ai/getting-started/developer-program#program-terms) * [Additional Resources](https://docs.fireflies.ai/getting-started/developer-program#additional-resources) [​](https://docs.fireflies.ai/getting-started/developer-program#overview) Overview ------------------------------------------------------------------------------------- Welcome to the Fireflies.ai Developer Program! This exclusive program offers developers a chance to explore, test, and integrate with our APIs for a limited period of three months. This program is tailored for developers eager to create seamless integrations and unlock the full capabilities of Fireflies.ai. Participants will gain access to premium features and higher rate limits, ensuring a swift and successful project development. [​](https://docs.fireflies.ai/getting-started/developer-program#program-benefits) Program Benefits ----------------------------------------------------------------------------------------------------- As a member of the Fireflies.ai Developer Program, you’ll enjoy: * **Full Business Tier Access**: Complimentary access to all Business Tier features, tools, and resources * **Integration Support**: Get guidance on how to connect the API seamlessly with your application * **Enhanced API Access**: Enjoy expanded rate limits and access to premium features designed for high-demand integrations * **Community and Updates**: Be part of our developer community and receive the latest updates, tutorials, and API news [​](https://docs.fireflies.ai/getting-started/developer-program#how-to-apply) How to Apply --------------------------------------------------------------------------------------------- Interested in joining? Follow these simple steps to apply for the program: 1. **Fill Out the Application Form**: [Apply here](https://fireflies-developer.paperform.co/) 2. **Verification**: Once you submit the form, our team will review your application. Please note that this process is manual and may take a few business days 3. **Approval Notification**: If your application is approved, you’ll receive a confirmation email with details about your program access [​](https://docs.fireflies.ai/getting-started/developer-program#application-requirements) Application Requirements --------------------------------------------------------------------------------------------------------------------- To qualify for the Developer Program, please ensure you have: * **A clear project plan**: Briefly describe how Fireflies.ai will integrate with your application * **A company email**: A company email is preferred for verification purposes * **GitHub Repository**: Optionally, include a GitHub link to your code or previous work to help us understand your technical expertise * **Additional Comments**: Any additional information that can help us assess your project’s alignment with our platform goals [​](https://docs.fireflies.ai/getting-started/developer-program#program-terms) Program Terms ----------------------------------------------------------------------------------------------- * **Duration**: The complimentary Business Tier access lasts for three months from the date of approval * **Feedback**: We may reach out for feedback to better understand your experience and how we can enhance our API We look forward to seeing what you’ll build and are excited to support your development journey! [​](https://docs.fireflies.ai/getting-started/developer-program#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------------------- [Introduction\ ------------\ \ Welcome to Fireflies public API documentation](https://docs.fireflies.ai/getting-started/introduction) [Authorization\ -------------\ \ Authenticating your requests with the Fireflies API](https://docs.fireflies.ai/fundamentals/authorization) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/getting-started/developer-program.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/getting-started/developer-program) [Chat with Fireflies AI Assistant](https://docs.fireflies.ai/getting-started/ask-docs) [MCP Server Configuration](https://docs.fireflies.ai/getting-started/mcp-configuration) ⌘I --- # MCP Server Configuration - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/getting-started/mcp-configuration#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Getting Started MCP Server Configuration On this page * [Overview](https://docs.fireflies.ai/getting-started/mcp-configuration#overview) * [What is MCP?](https://docs.fireflies.ai/getting-started/mcp-configuration#what-is-mcp%3F) * [Getting Started](https://docs.fireflies.ai/getting-started/mcp-configuration#getting-started) * [Prerequisites](https://docs.fireflies.ai/getting-started/mcp-configuration#prerequisites) * [Installation](https://docs.fireflies.ai/getting-started/mcp-configuration#installation) * [Use Cases](https://docs.fireflies.ai/getting-started/mcp-configuration#use-cases) * [Additional Resources](https://docs.fireflies.ai/getting-started/mcp-configuration#additional-resources) ### [​](https://docs.fireflies.ai/getting-started/mcp-configuration#overview) Overview The Fireflies MCP Server enables AI tools to connect directly to your meeting data without switching platforms or copying transcript excerpts. This integration allows you to ask questions like “What were the main objections in this week’s sales calls?” or “Create a summary of all product feedback from user interviews this month” directly from your AI coding tools. ### [​](https://docs.fireflies.ai/getting-started/mcp-configuration#what-is-mcp%3F) What is MCP? Model Context Protocol (MCP) is an open standard that enables AI applications to securely connect to external data sources and tools. With Fireflies MCP Server, your AI tools can access meeting transcripts, summaries, action items, and insights directly from your Fireflies account. ### [​](https://docs.fireflies.ai/getting-started/mcp-configuration#getting-started) Getting Started #### [​](https://docs.fireflies.ai/getting-started/mcp-configuration#prerequisites) Prerequisites * Active Fireflies.ai account * AI tool that supports MCP (such as Claude, OpenAI Connector, Cursor, Devin, or other MCP-compatible applications) #### [​](https://docs.fireflies.ai/getting-started/mcp-configuration#installation) Installation 1. **Configure your AI tool** Add the Fireflies MCP server to your AI tool’s configuration. The remote server URL is [https://api.fireflies.ai/mcp](https://api.fireflies.ai/mcp) which uses OAuth with your Fireflies account. The exact steps depend on your specific AI application. For specific AI tools, you can also configure directly through: * [Claude Settings](https://claude.ai/settings/connectors) * [Devin MCP Marketplace](https://app.devin.ai/settings/mcp-marketplace/setup/fireflies) 2. **Use your Fireflies API key on Claude Desktop** (Optional): 1. Add this config to your `claude_desktop_config.json` file: Copy Ask AI { "mcpServers": { "fireflies": { "command": "npx", "args": [\ "mcp-remote",\ "https://api.fireflies.ai/mcp",\ "--header",\ "Authorization: Bearer YOUR_API_KEY_HERE"\ ] } } } 2. Get your API Key from Fireflies * Go to **Settings > Developer Settings** and **Copy your API key** * [See how to get your API key →](https://guide.fireflies.ai/hc/en-us/articles/360020249198-How-to-access-the-Fireflies-API-key) * Once you have the API key, paste it in your claude\_desktop\_config.json * Replace `YOUR_API_KEY_HERE` with your actual API key 3. Restart Claude Desktop 3. **Start querying your data** Once configured, you can ask your AI tool questions about your meeting data directly. ### [​](https://docs.fireflies.ai/getting-started/mcp-configuration#use-cases) Use Cases * **Sales Analysis**: “What were the common objections in this week’s sales calls?” * **Product Feedback**: “Summarize all product feedback from user interviews this month” * **Meeting Insights**: “What action items were assigned to John across all meetings?” * **Trend Analysis**: “How has customer sentiment changed over the past quarter?” ### [​](https://docs.fireflies.ai/getting-started/mcp-configuration#additional-resources) Additional Resources [LLM-based Development\ ---------------------\ \ Enhance your AI coding experience with LLM readable documentation](https://docs.fireflies.ai/getting-started/llm-development) [Authorization\ -------------\ \ Authenticating your requests with the Fireflies API](https://docs.fireflies.ai/fundamentals/authorization) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/getting-started/mcp-configuration.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/getting-started/mcp-configuration) [Join the Developer Program](https://docs.fireflies.ai/getting-started/developer-program) [LLM-based Development](https://docs.fireflies.ai/getting-started/llm-development) ⌘I --- # General concepts - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/fundamentals/concepts#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Fundamentals General concepts On this page * [Overview](https://docs.fireflies.ai/fundamentals/concepts#overview) * [Host](https://docs.fireflies.ai/fundamentals/concepts#host) * [Authorization](https://docs.fireflies.ai/fundamentals/concepts#authorization) * [GraphQL API Concepts](https://docs.fireflies.ai/fundamentals/concepts#graphql-api-concepts) * [Queries](https://docs.fireflies.ai/fundamentals/concepts#queries) * [Mutations](https://docs.fireflies.ai/fundamentals/concepts#mutations) * [Schema and Types](https://docs.fireflies.ai/fundamentals/concepts#schema-and-types) * [Schema Definition](https://docs.fireflies.ai/fundamentals/concepts#schema-definition) * [Understanding GraphQL Schema](https://docs.fireflies.ai/fundamentals/concepts#understanding-graphql-schema) * [Data Types](https://docs.fireflies.ai/fundamentals/concepts#data-types) * [Best Practices](https://docs.fireflies.ai/fundamentals/concepts#best-practices) * [Additional Resources](https://docs.fireflies.ai/fundamentals/concepts#additional-resources) [​](https://docs.fireflies.ai/fundamentals/concepts#overview) Overview ------------------------------------------------------------------------- This section serves as a primer on the essential features of the Fireflies API. It covers the requirements to make authenticated requests to the Fireflies API, key GraphQL concepts and a breakdown of core components like queries, mutations, schema and data types. ### [​](https://docs.fireflies.ai/fundamentals/concepts#host) Host The Fireflies API is hosted at [https://api.fireflies.ai](https://api.fireflies.ai/) ### [​](https://docs.fireflies.ai/fundamentals/concepts#authorization) Authorization The Fireflies API requires a valid API key for all requests. Please see [Authorization](https://docs.fireflies.ai/fundamentals/authorization) for more information [​](https://docs.fireflies.ai/fundamentals/concepts#graphql-api-concepts) GraphQL API Concepts ------------------------------------------------------------------------------------------------- Welcome to our GraphQL API! GraphQL is a powerful query language designed for APIs, offering clients the ability to request exactly what they need and nothing more. ### [​](https://docs.fireflies.ai/fundamentals/concepts#queries) Queries Queries are used to fetch data in GraphQL. They are akin to the `GET` request in REST. A basic query might look like this: Queries are read-only and won’t modify your data. graphql Copy Ask AI query { user(id: "1") { name email } } ### [​](https://docs.fireflies.ai/fundamentals/concepts#mutations) Mutations Mutations allow you to modify data – create, update, or delete. Mutations should be used with caution as they change server-side data. graphql Copy Ask AI mutation { setUserRole(user_id: "1", role: "user") { id name } } [​](https://docs.fireflies.ai/fundamentals/concepts#schema-and-types) Schema and Types ----------------------------------------------------------------------------------------- ### [​](https://docs.fireflies.ai/fundamentals/concepts#schema-definition) Schema Definition The schema defines the API’s capabilities, including types, queries, mutations, and more. ### [​](https://docs.fireflies.ai/fundamentals/concepts#understanding-graphql-schema) Understanding GraphQL Schema The schema is a contract between client and server, defining how clients can access data. #### [​](https://docs.fireflies.ai/fundamentals/concepts#data-types) Data Types **Standard Types:** Int, Float, String, Boolean, ID. **Custom Types:** Defining complex data structures. Custom types are user-defined and can include combinations of standard types. #### [​](https://docs.fireflies.ai/fundamentals/concepts#best-practices) Best Practices 1. Optimize query performance by requesting for only necessary data. 2. Use variables in queries to enhance readability and flexibility [​](https://docs.fireflies.ai/fundamentals/concepts#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------- For more in-depth information, visit [GraphQL Documentation](https://graphql.org/learn/) . [Quickstart\ ----------\ \ Make your first request in under 5 minutes](https://docs.fireflies.ai/getting-started/quickstart) [Introspection\ -------------\ \ Query generation and API exploration](https://docs.fireflies.ai/fundamentals/introspection) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/fundamentals/concepts.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/fundamentals/concepts) [What's New](https://docs.fireflies.ai/getting-started/whats-new) [Limits](https://docs.fireflies.ai/fundamentals/limits) ⌘I --- # LLM-based Development - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/getting-started/llm-development#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Getting Started LLM-based Development On this page * [Overview](https://docs.fireflies.ai/getting-started/llm-development#overview) * [How to Use llms.txt Files](https://docs.fireflies.ai/getting-started/llm-development#how-to-use-llms-txt-files) * [For Tools with Limited Agentic Capabilities](https://docs.fireflies.ai/getting-started/llm-development#for-tools-with-limited-agentic-capabilities) * [For Advanced, Agentic Coding Tools](https://docs.fireflies.ai/getting-started/llm-development#for-advanced%2C-agentic-coding-tools) * [Additional Tips](https://docs.fireflies.ai/getting-started/llm-development#additional-tips) * [Additional Resources](https://docs.fireflies.ai/getting-started/llm-development#additional-resources) ### [​](https://docs.fireflies.ai/getting-started/llm-development#overview) Overview Welcome to the guide on utilizing our specialized `llms.txt` files to enhance your LLM-based coding workflow. Whether you’re using Replit, Cursor, Devin, or any other AI coding tool, this page will assist you in leveraging our resources to debug and refine code generated by Fireflies. Our platform seamlessly integrates with a variety of AI coding tools. While the generated code may not always be perfect, this guide outlines how to effectively use our `llms.txt` files to improve the debugging process, ensuring your development workflow remains smooth and efficient. ### [​](https://docs.fireflies.ai/getting-started/llm-development#how-to-use-llms-txt-files) How to Use `llms.txt` Files #### [​](https://docs.fireflies.ai/getting-started/llm-development#for-tools-with-limited-agentic-capabilities) For Tools with Limited Agentic Capabilities If your coding tool does not support web querying or autonomous resource fetching: * **Download the File** Access the complete file by visiting [this link](https://docs.fireflies.ai/llms-full.txt) and download it to your local machine. * **Upload and Debug** Upload the downloaded file to your AI coding tool. Instruct your tool to analyze and debug the code using the content of this file. This manual intervention guides the tool in identifying and fixing errors in generated code. #### [​](https://docs.fireflies.ai/getting-started/llm-development#for-advanced%2C-agentic-coding-tools) For Advanced, Agentic Coding Tools If your coding tool is sophisticated and capable of querying the web independently: * **Provide the URL Directly** Instead of downloading the full file, supply your tool with the URL [https://docs.fireflies.ai/llms-full.txt](https://docs.fireflies.ai/llms-full.txt) . * **Let It Decide** Your advanced tool will automatically determine which parts of the file to use and where to look, streamlining the debugging process without additional manual steps. ### [​](https://docs.fireflies.ai/getting-started/llm-development#additional-tips) Additional Tips * **Tool Configuration:** Ensure that your AI coding tool is configured to handle file uploads or URL-based inputs effectively. * **Experiment and Adapt:** Different tools may interact with our resources in unique ways. Experiment with both methods to find the approach that best suits your workflow. * **Support and Documentation:** If you encounter any challenges or need further assistance, please contact our support team. Happy coding! [​](https://docs.fireflies.ai/getting-started/llm-development#additional-resources) Additional Resources ----------------------------------------------------------------------------------------------------------- [MCP Configuration\ -----------------\ \ Connect your AI tools directly to your meeting data](https://docs.fireflies.ai/getting-started/mcp-configuration) [Concepts\ --------\ \ Foundational guide to the core aspects of the Fireflies API](https://docs.fireflies.ai/fundamentals/concepts) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/getting-started/llm-development.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/getting-started/llm-development) [MCP Server Configuration](https://docs.fireflies.ai/getting-started/mcp-configuration) [What's New](https://docs.fireflies.ai/getting-started/whats-new) ⌘I --- # Limits - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/fundamentals/limits#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Fundamentals Limits On this page * [Overview](https://docs.fireflies.ai/fundamentals/limits#overview) * [Upload Limits](https://docs.fireflies.ai/fundamentals/limits#upload-limits) * [Understanding Upload Limits](https://docs.fireflies.ai/fundamentals/limits#understanding-upload-limits) * [API Rate Limits](https://docs.fireflies.ai/fundamentals/limits#api-rate-limits) * [Add to Live API Rate Limit](https://docs.fireflies.ai/fundamentals/limits#add-to-live-api-rate-limit) * [Navigating API Rate Limits](https://docs.fireflies.ai/fundamentals/limits#navigating-api-rate-limits) * [Additional Resources](https://docs.fireflies.ai/fundamentals/limits#additional-resources) [​](https://docs.fireflies.ai/fundamentals/limits#overview) Overview ----------------------------------------------------------------------- Understanding the limitations of our API is crucial for efficient and uninterrupted usage. Below you’ll find detailed information about the upload limits for different file types and the rate limits applicable to various subscription plans. [​](https://docs.fireflies.ai/fundamentals/limits#upload-limits) Upload Limits --------------------------------------------------------------------------------- The Fireflies API accommodates a range of file sizes for different user types. Here’s a breakdown of the maximum file sizes for audio and video uploads: | Upload Type | Free User Limit | Pro / Business / Enterprise Limit | | --- | --- | --- | | Audio Files | Up to 200MB | Up to 200MB | | Video Files | Up to 100MB | Up to 1.5GB | ### [​](https://docs.fireflies.ai/fundamentals/limits#understanding-upload-limits) Understanding Upload Limits * **Audio Files:** All users can upload an audio file no greater than 200MB, ensuring ample capacity for high-quality audio content. * **Video Files for Free Users:** Free users have a maximum upload limit of 100MB for video files, suitable for short clips and previews. * **Video Files for Pro/Business/Enterprise Users:** Higher-tier users can upload larger video files up to 1.5GB, accommodating longer and higher resolution content. [​](https://docs.fireflies.ai/fundamentals/limits#api-rate-limits) API Rate Limits ------------------------------------------------------------------------------------- To maintain the quality of service and availability for all users, our API enforces rate limits based on the type of subscription plan. | Plan | API Rate Limit | | --- | --- | | Free / Pro | 50 requests per day | | Business / Enterprise | 60 requests per min | ### [​](https://docs.fireflies.ai/fundamentals/limits#add-to-live-api-rate-limit) Add to Live API Rate Limit The Add to Live API has a rate limit of 3 requests per 20 minutes. ### [​](https://docs.fireflies.ai/fundamentals/limits#navigating-api-rate-limits) Navigating API Rate Limits * **Free and Pro Plans:** These plans are ideal for light to moderate usage, with a cap of 50 API requests per day. This rate is suitable for testing and small-scale applications. * **Business and Enterprise Plans:** Designed for more demanding use cases, these plans allow up to 60 requests per minute, providing ample capacity for larger applications and higher volume demands. [​](https://docs.fireflies.ai/fundamentals/limits#additional-resources) Additional Resources ----------------------------------------------------------------------------------------------- [Upload Audio\ ------------\ \ Use the API to upload audio to Fireflies.ai](https://docs.fireflies.ai/graphql-api/mutation/upload-audio) [Authorization\ -------------\ \ Authenticating your requests with the Fireflies API](https://docs.fireflies.ai/fundamentals/authorization) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/fundamentals/limits.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/fundamentals/limits) [General concepts](https://docs.fireflies.ai/fundamentals/concepts) [Errors](https://docs.fireflies.ai/fundamentals/errors) ⌘I --- # API Examples Overview - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/examples/overview#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Examples Overview On this page * [Overview](https://docs.fireflies.ai/examples/overview#overview) * [Fireflies.ai Replit](https://docs.fireflies.ai/examples/overview#fireflies-ai-replit) * [Additional Resources](https://docs.fireflies.ai/examples/overview#additional-resources) [​](https://docs.fireflies.ai/examples/overview#overview) Overview --------------------------------------------------------------------- This part of the documentation is designed to provide developers with practical insights into integrating and maximizing the Fireflies.ai API in various applications. By visiting our Replit page at Fireflies.ai on Replit, you can directly access and interact with these examples, making your learning process interactive and engaging. [​](https://docs.fireflies.ai/examples/overview#fireflies-ai-replit) Fireflies.ai Replit ------------------------------------------------------------------------------------------- Explore a wide array of examples where we have created code snippets that allows you to interact with the Fireflies API. To view, please visit [replit.com/@firefliesai](https://replit.com/@firefliesai) You can also view the list of examples at the links [Basic examples](https://docs.fireflies.ai/examples/basic) and [Advanced examples](https://docs.fireflies.ai/examples/advanced) [​](https://docs.fireflies.ai/examples/overview#additional-resources) Additional Resources --------------------------------------------------------------------------------------------- [Basic examples\ --------------\ \ Basic usage examples](https://docs.fireflies.ai/examples/basic) [Advanced examples\ -----------------\ \ Advanced usage examples](https://docs.fireflies.ai/examples/advanced) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/examples/overview.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/examples/overview) [Super Admin](https://docs.fireflies.ai/fundamentals/super-admin) [Basic](https://docs.fireflies.ai/examples/basic) ⌘I --- # Introspection - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/fundamentals/introspection#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Fundamentals Introspection On this page * [Overview](https://docs.fireflies.ai/fundamentals/introspection#overview) * [Requirements](https://docs.fireflies.ai/fundamentals/introspection#requirements) * [Introspection using Apollo Sandbox](https://docs.fireflies.ai/fundamentals/introspection#introspection-using-apollo-sandbox) * [Introspection using Postman](https://docs.fireflies.ai/fundamentals/introspection#introspection-using-postman) * [Additional Resources](https://docs.fireflies.ai/fundamentals/introspection#additional-resources) [​](https://docs.fireflies.ai/fundamentals/introspection#overview) Overview ------------------------------------------------------------------------------ Introspection is a feature that allows querying a GraphQL server to discover its schema. This capability is crucial for developers to understand available queries, mutations, and the structure of the data they can work with, facilitating seamless API interaction and exploration. ### [​](https://docs.fireflies.ai/fundamentals/introspection#requirements) Requirements You will need a Fireflies.ai API key to use introspection. For more details, please visit [Authorization](https://docs.fireflies.ai/fundamentals/authorization#acquiring-a-token) ### [​](https://docs.fireflies.ai/fundamentals/introspection#introspection-using-apollo-sandbox) Introspection using Apollo Sandbox For introspection using our builtin Apollo Sandbox, visit [api.fireflies.ai/graphql](https://api.fireflies.ai/graphql) and enter your `api_key` in the Headers section as a Bearer token ### [​](https://docs.fireflies.ai/fundamentals/introspection#introspection-using-postman) Introspection using Postman Create a new Graphql Request in Postman with the url [api.fireflies.ai/graphql](https://api.fireflies.ai/graphql) and enter your `api_key` in the Headers section as a Bearer token [​](https://docs.fireflies.ai/fundamentals/introspection#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------------ [Concepts\ --------\ \ Foundational guide to the core aspects of the Fireflies API](https://docs.fireflies.ai/fundamentals/concepts) [Authorization\ -------------\ \ Authenticating your requests with the Fireflies API](https://docs.fireflies.ai/fundamentals/authorization) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/fundamentals/introspection.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/fundamentals/introspection) [Authorization](https://docs.fireflies.ai/fundamentals/authorization) [Super Admin](https://docs.fireflies.ai/fundamentals/super-admin) ⌘I --- # Super Admin - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/fundamentals/super-admin#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Fundamentals Super Admin On this page * [Overview](https://docs.fireflies.ai/fundamentals/super-admin#overview) * [Super Admin Webhooks](https://docs.fireflies.ai/fundamentals/super-admin#super-admin-webhooks) * [Setting up Super Admin Webhooks](https://docs.fireflies.ai/fundamentals/super-admin#setting-up-super-admin-webhooks) * [Privacy Settings Bypass](https://docs.fireflies.ai/fundamentals/super-admin#privacy-settings-bypass) * [Requirements](https://docs.fireflies.ai/fundamentals/super-admin#requirements) * [Additional Resources](https://docs.fireflies.ai/fundamentals/super-admin#additional-resources) [​](https://docs.fireflies.ai/fundamentals/super-admin#overview) Overview ---------------------------------------------------------------------------- The Super Admin API offers advanced features such as team-wide webhooks and privacy setting bypass, providing enhanced control and flexibility for managing your data. This is only available on the enterprise tier for company admins - [learn more](https://guide.fireflies.ai/hc/en-us/articles/30453010621585-Learn-about-the-Super-Admin-role) . [​](https://docs.fireflies.ai/fundamentals/super-admin#super-admin-webhooks) Super Admin Webhooks ---------------------------------------------------------------------------------------------------- The Super Admin webhook notifies you of all team meetings owned by your team, allowing you to automate workflows, integrate with other tools, and maintain an overview of your team’s meetings with a single webhook. ### [​](https://docs.fireflies.ai/fundamentals/super-admin#setting-up-super-admin-webhooks) Setting up Super Admin Webhooks Follow the steps below to set up the Super Admin webhook: 1 Visit the [Fireflies.ai dashboard settings](https://app.fireflies.ai/settings) 2 Navigate to the Developer settings tab 3 Enter a valid https URL in the webhooks field and save It is highly suggested to use [webhook auth](https://docs.fireflies.ai/graphql-api/webhooks) to secure your servers. ### [​](https://docs.fireflies.ai/fundamentals/super-admin#privacy-settings-bypass) Privacy Settings Bypass The Super Admin functionality allows you to bypass your team’s privacy settings, allowing you to query all data in your team’s account. ### [​](https://docs.fireflies.ai/fundamentals/super-admin#requirements) Requirements Super Admin API is only available to teams on the Enterprise plan. [Learn more here](https://guide.fireflies.ai/hc/en-us/articles/30453010621585-Learn-about-the-Super-Admin-role) and reach out to us with questions [​](https://docs.fireflies.ai/fundamentals/super-admin#additional-resources) Additional Resources ---------------------------------------------------------------------------------------------------- [Webhooks\ --------\ \ Create notifications using webhooks](https://docs.fireflies.ai/graphql-api/webhooks) [Authorization\ -------------\ \ Authenticating your requests with the Fireflies API](https://docs.fireflies.ai/fundamentals/authorization) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/fundamentals/super-admin.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/fundamentals/super-admin) [Introspection](https://docs.fireflies.ai/fundamentals/introspection) [Overview](https://docs.fireflies.ai/examples/overview) ⌘I --- # Authorization - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/fundamentals/authorization#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Fundamentals Authorization On this page * [Overview](https://docs.fireflies.ai/fundamentals/authorization#overview) * [Token-Based Authentication](https://docs.fireflies.ai/fundamentals/authorization#token-based-authentication) * [Acquiring a Token](https://docs.fireflies.ai/fundamentals/authorization#acquiring-a-token) * [Making an Authenticated Request](https://docs.fireflies.ai/fundamentals/authorization#making-an-authenticated-request) * [Example of an Authenticated Request Header](https://docs.fireflies.ai/fundamentals/authorization#example-of-an-authenticated-request-header) * [Example request with Authorization header](https://docs.fireflies.ai/fundamentals/authorization#example-request-with-authorization-header) * [Best Practices for Token Security](https://docs.fireflies.ai/fundamentals/authorization#best-practices-for-token-security) * [Troubleshooting](https://docs.fireflies.ai/fundamentals/authorization#troubleshooting) * [FAQ](https://docs.fireflies.ai/fundamentals/authorization#faq) * [Additional Resources](https://docs.fireflies.ai/fundamentals/authorization#additional-resources) [​](https://docs.fireflies.ai/fundamentals/authorization#overview) Overview ------------------------------------------------------------------------------ The Fireflies API implements token-based authentication, which ensures that only authorized users can access certain data and functionalities. ### [​](https://docs.fireflies.ai/fundamentals/authorization#token-based-authentication) Token-Based Authentication We use a standard bearer token authentication mechanism. This means that to make authorized requests to the API, you must include an `Authorization` header with a valid token. ### [​](https://docs.fireflies.ai/fundamentals/authorization#acquiring-a-token) Acquiring a Token Follow these steps to obtain your API key for the Fireflies API: 1. Log in to your account at [fireflies.ai](https://app.fireflies.ai/) 2. Navigate to the [Integrations](https://app.fireflies.ai/integrations) section 3. Click on [Fireflies API](https://app.fireflies.ai/integrations/custom/fireflies) 4. Copy and store your API key securely ### [​](https://docs.fireflies.ai/fundamentals/authorization#making-an-authenticated-request) Making an Authenticated Request To make an authenticated request, add the `Authorization` header followed by the word `Bearer` and your API key. ### [​](https://docs.fireflies.ai/fundamentals/authorization#example-of-an-authenticated-request-header) Example of an Authenticated Request Header Copy Ask AI Authorization: Bearer your_api_key ### [​](https://docs.fireflies.ai/fundamentals/authorization#example-request-with-authorization-header) Example request with Authorization header curl javascript python java Copy Ask AI curl \ -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "{ user { name integrations } }" }' \ https://api.fireflies.ai/graphql Ensure to replace `your_api_key` with your actual API key. [​](https://docs.fireflies.ai/fundamentals/authorization#best-practices-for-token-security) Best Practices for Token Security -------------------------------------------------------------------------------------------------------------------------------- * **Keep it Secret:** Treat your API key like a password. Never expose it in client-side code or share it publicly. * **Store Securely:** Store the API key securely in your application, ideally in environment variables or secure storage solutions. Improper handling of API keys can lead to security vulnerabilities. Always ensure API keys are used and stored securely. [​](https://docs.fireflies.ai/fundamentals/authorization#troubleshooting) Troubleshooting -------------------------------------------------------------------------------------------- * **Invalid key:** If you receive an error regarding an invalid API key, verify that the API key hasn’t expired and that it’s correctly included in the request header. * **Missing key:** Ensure that the `Authorization` header is present in your requests requiring authentication. If you encounter issues with authentication or have questions about API key management, please contact our support team. [​](https://docs.fireflies.ai/fundamentals/authorization#faq) FAQ -------------------------------------------------------------------- Why am I getting an 'auth\_failed' error? This error can signal an issue in your Authorization header. Please ensure that you are including the `Authorization` header with the word `Bearer` and your API key. [​](https://docs.fireflies.ai/fundamentals/authorization#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------------ [Quickstart\ ----------\ \ Make your first request in under 5 minutes](https://docs.fireflies.ai/getting-started/quickstart) [Errors\ ------\ \ Error standards for the Fireflies API](https://docs.fireflies.ai/fundamentals/errors) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/fundamentals/authorization.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/fundamentals/authorization) [Errors](https://docs.fireflies.ai/fundamentals/errors) [Introspection](https://docs.fireflies.ai/fundamentals/introspection) ⌘I --- # Errors - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/fundamentals/errors#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Fundamentals Errors On this page * [Overview](https://docs.fireflies.ai/fundamentals/errors#overview) * [Error schema](https://docs.fireflies.ai/fundamentals/errors#error-schema) * [Additional Resources](https://docs.fireflies.ai/fundamentals/errors#additional-resources) [​](https://docs.fireflies.ai/fundamentals/errors#overview) Overview ----------------------------------------------------------------------- Understanding how errors are structured and returned by the Fireflies API is key to effectively handling and troubleshooting issues. This page outlines the common error format and details specific error types. [​](https://docs.fireflies.ai/fundamentals/errors#error-schema) Error schema ------------------------------------------------------------------------------- Our GraphQL API follows a standard format for returning errors. Errors are encapsulated within an `errors` array in the response body. Please visit [Error codes](https://docs.fireflies.ai/miscellaneous/error-codes) to view explanations for error code types [​](https://docs.fireflies.ai/fundamentals/errors#param-message) message String required Description of the error [​](https://docs.fireflies.ai/fundamentals/errors#param-code) code String required Error code. [​](https://docs.fireflies.ai/fundamentals/errors#param-friendly) friendly Boolean required `friendly === true` are safe to show to the frontend client. Unfriendly errors may have technical details that may not be useful to the UI layer. [​](https://docs.fireflies.ai/fundamentals/errors#param-extensions) extensions Object Contains useful metadata related to the error.Where relevant, includes field `helpUrls` pointing to relevant API documentation sections that explain the error and provide guidance on how to resolve it Example Copy Ask AI { "data": {}, "errors": [\ {\ "message": "Error description",\ "friendly": true,\ "code": "error_code",\ "extensions": {\ "helpUrls": [\ "https://docs.fireflies.ai/miscellaneous/error-codes#error_code"\ ],\ "code": "error_code",\ "status": http_status_code,\ ... otherFields\ }\ }\ ] } [​](https://docs.fireflies.ai/fundamentals/errors#additional-resources) Additional Resources ----------------------------------------------------------------------------------------------- [Error Codes\ -----------\ \ Detailed error code reference](https://docs.fireflies.ai/miscellaneous/error-codes) [Authorization\ -------------\ \ Authenticating your requests with the Fireflies API](https://docs.fireflies.ai/fundamentals/authorization) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/fundamentals/errors.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/fundamentals/errors) [Limits](https://docs.fireflies.ai/fundamentals/limits) [Authorization](https://docs.fireflies.ai/fundamentals/authorization) ⌘I --- # Basic API Examples - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/examples/basic#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Examples Basic On this page * [Overview](https://docs.fireflies.ai/examples/basic#overview) * [Basic examples](https://docs.fireflies.ai/examples/basic#basic-examples) * [Fireflies.ai Replit](https://docs.fireflies.ai/examples/basic#fireflies-ai-replit) * [Additional Resources](https://docs.fireflies.ai/examples/basic#additional-resources) [​](https://docs.fireflies.ai/examples/basic#overview) Overview ------------------------------------------------------------------ Explore basic usage examples for the Fireflies.ai API to get you started quickly. These basic usage examples simplify interact with the API through Javascript code. [​](https://docs.fireflies.ai/examples/basic#basic-examples) Basic examples ------------------------------------------------------------------------------ Basic examples that allow you to perform basic operations with the Fireflies.ai API, like fetching transcripts or setting user role. 1. [Create soundbite from meeting](https://replit.com/@firefliesai/Firefliesai-Create-soundbite-from-a-meeting?v=1) 2. [Set user role](https://replit.com/@firefliesai/Firefliesai-Set-user-role?v=1) 3. [Upload audio](https://replit.com/@firefliesai/Firefliesai-Upload-audio?v=1) 4. [Download meeting video](https://replit.com/@firefliesai/Firefliesai-Download-video-from-meeting?v=1) 5. [Get audio/video url](https://replit.com/@firefliesai/Firefliesai-Get-audiovideo-url?v=1) 6. [Get transcript summary](https://replit.com/@firefliesai/Firefliesai-Get-transcript-summary-from-a-meeting?v=1) [​](https://docs.fireflies.ai/examples/basic#fireflies-ai-replit) Fireflies.ai Replit ---------------------------------------------------------------------------------------- Explore the complete list of usage examples at [replit.com/@firefliesai](https://replit.com/@firefliesai) [​](https://docs.fireflies.ai/examples/basic#additional-resources) Additional Resources ------------------------------------------------------------------------------------------ [Advanced examples\ -----------------\ \ Advanced usage examples](https://docs.fireflies.ai/examples/advanced) [Quickstart\ ----------\ \ Make your first request in under 5 minutes](https://docs.fireflies.ai/getting-started/quickstart) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/examples/basic.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/examples/basic) [Overview](https://docs.fireflies.ai/examples/overview) [Advanced](https://docs.fireflies.ai/examples/advanced) ⌘I --- # AI Apps Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/apps#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema AI Apps On this page * [Additional Resources](https://docs.fireflies.ai/schema/apps#additional-resources) [​](https://docs.fireflies.ai/schema/apps#param-outputs) outputs \[AppOutput\] List of [AI App outputs](https://docs.fireflies.ai/schema/app-output) [​](https://docs.fireflies.ai/schema/apps#additional-resources) Additional Resources --------------------------------------------------------------------------------------- [App Output\ ----------\ \ Schema for App Output](https://docs.fireflies.ai/schema/app-output) [Transcript\ ----------\ \ Schema for Transcript](https://docs.fireflies.ai/schema/transcript) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/apps.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/apps) [Analytics](https://docs.fireflies.ai/schema/analytics) [App Output](https://docs.fireflies.ai/schema/app-output) ⌘I --- # Realtime API Overview - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/realtime-api/overview#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Realtime API Overview On this page * [How It Works](https://docs.fireflies.ai/realtime-api/overview#how-it-works) * [Flow](https://docs.fireflies.ai/realtime-api/overview#flow) * [Features](https://docs.fireflies.ai/realtime-api/overview#features) * [Additional Resources](https://docs.fireflies.ai/realtime-api/overview#additional-resources) The Fireflies.ai Realtime API allows your application to receive **live transcription events** over WebSockets. This enables building interactive features such as live captioning, transcription overlays, and real-time analysis as users speak. The Realtime API is currently in **beta**. Features and endpoints may change. We welcome your feedback as we continue to improve this API. [​](https://docs.fireflies.ai/realtime-api/overview#how-it-works) How It Works --------------------------------------------------------------------------------- The Realtime API uses WebSocket connections to deliver transcription data as it’s generated. [​](https://docs.fireflies.ai/realtime-api/overview#flow) Flow ----------------------------------------------------------------- 1. **Authenticate**: Connect using a valid API token and transcript ID. 2. **Listen**: Once connected, you’ll start receiving transcription events in real time. 3. **React**: Update your UI or process transcription events as they arrive. [​](https://docs.fireflies.ai/realtime-api/overview#features) Features ------------------------------------------------------------------------- * **Low Latency**: Data is streamed as soon as it’s transcribed. * **Event-Based**: Receive structured events for easy handling. * **Token-Based Authentication**: Secure connections with scoped access. * **Incremental Transcription**: Receive transcript segments progressively. [​](https://docs.fireflies.ai/realtime-api/overview#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------- [Getting Started\ ---------------\ \ Getting Started with Realtime API](https://docs.fireflies.ai/realtime-api/getting-started) [Event Schema\ ------------\ \ Schema for Realtime Events](https://docs.fireflies.ai/realtime-api/event-schema) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/realtime-api/overview.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/realtime-api/overview) [Webhooks](https://docs.fireflies.ai/graphql-api/webhooks) [Getting Started](https://docs.fireflies.ai/realtime-api/getting-started) ⌘I --- # AIFilter Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/aifilter#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema AIFilter On this page * [Additional Resources](https://docs.fireflies.ai/schema/aifilter#additional-resources) [​](https://docs.fireflies.ai/schema/aifilter#param-task) task String Description [​](https://docs.fireflies.ai/schema/aifilter#param-pricing) pricing String Description [​](https://docs.fireflies.ai/schema/aifilter#param-metric) metric String Description [​](https://docs.fireflies.ai/schema/aifilter#param-question) question String Description [​](https://docs.fireflies.ai/schema/aifilter#param-date-and-time) date\_and\_time String Description [​](https://docs.fireflies.ai/schema/aifilter#param-text-cleanup) text\_cleanup String Description [​](https://docs.fireflies.ai/schema/aifilter#param-sentiment) sentiment String Description [​](https://docs.fireflies.ai/schema/aifilter#additional-resources) Additional Resources ------------------------------------------------------------------------------------------- [Sentence\ --------\ \ Schema for Sentence](https://docs.fireflies.ai/schema/sentence) [Analytics\ ---------\ \ Schema for Analytics](https://docs.fireflies.ai/schema/analytics) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/aifilter.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/aifilter) [Event Schema](https://docs.fireflies.ai/realtime-api/event-schema) [Analytics](https://docs.fireflies.ai/schema/analytics) ⌘I --- # App Output Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/app-output#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema App Output On this page * [Additional Resources](https://docs.fireflies.ai/schema/app-output#additional-resources) [​](https://docs.fireflies.ai/schema/app-output#param-transcript-id) transcript\_id String The ID of the meeting transcript. [​](https://docs.fireflies.ai/schema/app-output#param-user-id) user\_id String The ID of the user who owns the AI App [​](https://docs.fireflies.ai/schema/app-output#param-app-id) app\_id String The ID of the AI App [​](https://docs.fireflies.ai/schema/app-output#param-created-at) created\_at Float The timestamp in milliseconds from epoch when the output was generated [​](https://docs.fireflies.ai/schema/app-output#param-title) title String The title of the AI App [​](https://docs.fireflies.ai/schema/app-output#param-prompt) prompt String The prompt given to the AI App [​](https://docs.fireflies.ai/schema/app-output#param-response) response String The response generated by the AI App [​](https://docs.fireflies.ai/schema/app-output#additional-resources) Additional Resources --------------------------------------------------------------------------------------------- [Apps\ ----\ \ Schema for Apps](https://docs.fireflies.ai/schema/apps) [Transcript\ ----------\ \ Schema for Transcript](https://docs.fireflies.ai/schema/transcript) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/app-output.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/app-output) [AI Apps](https://docs.fireflies.ai/schema/apps) [AudioUploadStatus](https://docs.fireflies.ai/schema/audio-upload-status) ⌘I --- # Channel Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/channel#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema Channel On this page * [Additional Resources](https://docs.fireflies.ai/schema/channel#additional-resources) [​](https://docs.fireflies.ai/schema/channel#param-id) id ID Unique identifier of the Channel. [​](https://docs.fireflies.ai/schema/channel#additional-resources) Additional Resources ------------------------------------------------------------------------------------------ [Transcript\ ----------\ \ Schema for Transcript](https://docs.fireflies.ai/schema/transcript) [User Groups\ -----------\ \ Schema for User Groups](https://docs.fireflies.ai/schema/user-groups) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/channel.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/channel) [Bite](https://docs.fireflies.ai/schema/bite) [MeetingAnalytics](https://docs.fireflies.ai/schema/meeting-analytics) ⌘I --- # Realtime API Events Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/realtime-api/event-schema#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Realtime API Event Schema On this page * [Event Reference](https://docs.fireflies.ai/realtime-api/event-schema#event-reference) * [Event List](https://docs.fireflies.ai/realtime-api/event-schema#event-list) * [RealtimeTranscriptionEvent](https://docs.fireflies.ai/realtime-api/event-schema#realtimetranscriptionevent) * [Example Payload](https://docs.fireflies.ai/realtime-api/event-schema#example-payload) * [Additional Resources](https://docs.fireflies.ai/realtime-api/event-schema#additional-resources) [​](https://docs.fireflies.ai/realtime-api/event-schema#event-reference) Event Reference =========================================================================================== This page documents the events you may receive from the Fireflies.ai Realtime API WebSocket. [​](https://docs.fireflies.ai/realtime-api/event-schema#event-list) Event List --------------------------------------------------------------------------------- | Event Name | Description | | --- | --- | | `auth.success` | Emitted when authentication succeeds. | | `auth.failed` | Emitted when authentication fails. The socket will disconnect after this event. | | `connection.established` | Emitted when the connection is successfully established. | | `connection.error` | Emitted when there is a connection or authorization error. | | `transcription.broadcast` | Emitted for every new transcription segment or update. | [​](https://docs.fireflies.ai/realtime-api/event-schema#realtimetranscriptionevent) RealtimeTranscriptionEvent ----------------------------------------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/realtime-api/event-schema#param-transcript-id) transcript\_id String The unique identifier for the transcript / meeting [​](https://docs.fireflies.ai/realtime-api/event-schema#param-chunk-id) chunk\_id String The unique identifier for the transcription segment (chunk). You may use this field to deduplicate transcription events. If the transcription is being updated, it will contain the same chunk\_id as the previous event. A new transcription will have a different chunk\_id [​](https://docs.fireflies.ai/realtime-api/event-schema#param-text) text String The transcribed text for this segment. [​](https://docs.fireflies.ai/realtime-api/event-schema#param-speaker-name) speaker\_name String The name of the speaker for this segment. [​](https://docs.fireflies.ai/realtime-api/event-schema#param-start-time) start\_time Float The start time (in seconds) [​](https://docs.fireflies.ai/realtime-api/event-schema#param-end-time) end\_time Float The end time (in seconds) [​](https://docs.fireflies.ai/realtime-api/event-schema#example-payload) Example Payload ------------------------------------------------------------------------------------------- Copy Ask AI { "transcript_id": "abc123", "chunk_id": "chunk_001", "text": "Hello world", "speaker_name": "Alice", "start_time": 0.0, "end_time": 1.25 } [​](https://docs.fireflies.ai/realtime-api/event-schema#additional-resources) Additional Resources ----------------------------------------------------------------------------------------------------- [Getting Started\ ---------------\ \ Getting started with Realtime API](https://docs.fireflies.ai/realtime-api/getting-started) [Sentence\ --------\ \ Schema for Sentence](https://docs.fireflies.ai/schema/sentence) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/realtime-api/event-schema.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/realtime-api/event-schema) [Getting Started](https://docs.fireflies.ai/realtime-api/getting-started) [AIFilter](https://docs.fireflies.ai/schema/aifilter) ⌘I --- # Quickstart - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/getting-started/quickstart#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Getting Started Quickstart On this page * [Step 1: Setting Up](https://docs.fireflies.ai/getting-started/quickstart#step-1%3A-setting-up) * [Obtaining Authentication Credentials](https://docs.fireflies.ai/getting-started/quickstart#obtaining-authentication-credentials) * [Step 2: Making Your First Request](https://docs.fireflies.ai/getting-started/quickstart#step-2%3A-making-your-first-request) * [Step 3: Analyzing the Response](https://docs.fireflies.ai/getting-started/quickstart#step-3%3A-analyzing-the-response) * [Additional Resources](https://docs.fireflies.ai/getting-started/quickstart#additional-resources) This guide provides step-by-step instructions to make your first query with our GraphQL API and demonstrates basic functionality. [​](https://docs.fireflies.ai/getting-started/quickstart#step-1%3A-setting-up) Step 1: Setting Up ---------------------------------------------------------------------------------------------------- Before diving into querying the API, it’s essential to set up your environment correctly. This includes obtaining authentication credentials and configuring your development environment. ### [​](https://docs.fireflies.ai/getting-started/quickstart#obtaining-authentication-credentials) Obtaining Authentication Credentials To access our API, you will need an API key. Follow these steps to obtain your key: 1. Log in to your account at [app.fireflies.ai](https://app.fireflies.ai/) 2. Navigate to the [Integrations](https://app.fireflies.ai/integrations) section 3. Click on [Fireflies API](https://app.fireflies.ai/integrations/custom/fireflies) 4. Copy and store your API key securely It’s crucial to handle your API key with the utmost care to ensure the security of your data. For more information on Authorization and best practices, visit [Authorization](https://docs.fireflies.ai/fundamentals/authorization) [​](https://docs.fireflies.ai/getting-started/quickstart#step-2%3A-making-your-first-request) Step 2: Making Your First Request ---------------------------------------------------------------------------------------------------------------------------------- Execute a simple query to retrieve a list of users. Replace `your_api_key` with your API key in the following requests curl python javascript java Copy Ask AI curl \ -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "{ users { name user_id } }" }' \ https://api.fireflies.ai/graphql When building GraphQL queries for this API, focus on precision and efficiency. Start with simple queries and gradually increase complexity. Ensure you only request the data you need to avoid over-fetching. * **Review the Schema Documentation**: For guidance, refer to the [Schema](https://docs.fireflies.ai/schema) section and use tools like GraphQL Playground for testing. Efficient queries lead to better performance and a smoother API experience. More details on building your GraphQL query are available [here](https://docs.fireflies.ai/graphql-api) [​](https://docs.fireflies.ai/getting-started/quickstart#step-3%3A-analyzing-the-response) Step 3: Analyzing the Response ---------------------------------------------------------------------------------------------------------------------------- You will receive a JSON response with the requested data. Example response: curl Copy Ask AI { "data": { "users": [\ {\ "name":"Justin Fly",\ "user_id":"example-id"\ }\ ] } } Continue to the next sections for more detailed examples and advanced usage instructions. [​](https://docs.fireflies.ai/getting-started/quickstart#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------------ [Users\ -----\ \ Query users using the API](https://docs.fireflies.ai/graphql-api/query/users) [Authorization\ -------------\ \ Authenticating your requests with the Fireflies API](https://docs.fireflies.ai/fundamentals/authorization) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/getting-started/quickstart.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/getting-started/quickstart) [Introduction](https://docs.fireflies.ai/getting-started/introduction) [Chat with Fireflies AI Assistant](https://docs.fireflies.ai/getting-started/ask-docs) ⌘I --- # AudioUploadStatus Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/audio-upload-status#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema AudioUploadStatus On this page * [Additional Resources](https://docs.fireflies.ai/schema/audio-upload-status#additional-resources) [​](https://docs.fireflies.ai/schema/audio-upload-status#param-success) success Boolean Indicates whether the AudioUpload request was a success or not. [​](https://docs.fireflies.ai/schema/audio-upload-status#param-title) title String Title of the uploaded file. [​](https://docs.fireflies.ai/schema/audio-upload-status#param-message) message String Message from AudioUpload request. [​](https://docs.fireflies.ai/schema/audio-upload-status#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------------ [Transcript\ ----------\ \ Schema for Transcript](https://docs.fireflies.ai/schema/transcript) [Upload Audio\ ------------\ \ Use the API to upload audio to Fireflies.ai](https://docs.fireflies.ai/graphql-api/mutation/upload-audio) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/audio-upload-status.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/audio-upload-status) [App Output](https://docs.fireflies.ai/schema/app-output) [Bite](https://docs.fireflies.ai/schema/bite) ⌘I --- # MeetingAnalytics Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/meeting-analytics#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema MeetingAnalytics On this page * [AnalyticsCategories](https://docs.fireflies.ai/schema/meeting-analytics#analyticscategories) * [AnalyticsSpeaker](https://docs.fireflies.ai/schema/meeting-analytics#analyticsspeaker) * [Additional Resources](https://docs.fireflies.ai/schema/meeting-analytics#additional-resources) [​](https://docs.fireflies.ai/schema/meeting-analytics#param-sentiments) sentiments Sentiments Sentiment analysis of the meeting. See [Sentiments](https://docs.fireflies.ai/schema/sentiments) [​](https://docs.fireflies.ai/schema/meeting-analytics#param-categories) categories AnalyticsCategories Categorized analytics of the meeting content. See [AnalyticsCategories](https://docs.fireflies.ai/schema/meeting-analytics#analyticscategories) [​](https://docs.fireflies.ai/schema/meeting-analytics#param-speakers) speakers \[AnalyticsSpeaker\] Array of analytics data for each speaker in the meeting. See [AnalyticsSpeaker](https://docs.fireflies.ai/schema/meeting-analytics#analyticsspeaker) [​](https://docs.fireflies.ai/schema/meeting-analytics#analyticscategories) AnalyticsCategories -------------------------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/schema/meeting-analytics#param-questions) questions Int Number of questions asked during the meeting. [​](https://docs.fireflies.ai/schema/meeting-analytics#param-date-times) date\_times Int Number of date and time references mentioned in the meeting. [​](https://docs.fireflies.ai/schema/meeting-analytics#param-metrics) metrics Int Number of metrics or measurements discussed in the meeting. [​](https://docs.fireflies.ai/schema/meeting-analytics#param-tasks) tasks Int Number of tasks or action items identified in the meeting. [​](https://docs.fireflies.ai/schema/meeting-analytics#analyticsspeaker) AnalyticsSpeaker -------------------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/schema/meeting-analytics#param-speaker-id) speaker\_id Int Unique identifier for the speaker. [​](https://docs.fireflies.ai/schema/meeting-analytics#param-name) name String Name of the speaker. [​](https://docs.fireflies.ai/schema/meeting-analytics#param-duration) duration Float Total speaking time of the speaker in seconds. [​](https://docs.fireflies.ai/schema/meeting-analytics#param-word-count) word\_count Int Total number of words spoken by the speaker. [​](https://docs.fireflies.ai/schema/meeting-analytics#param-longest-monologue) longest\_monologue Float Duration of the speaker’s longest continuous speech in seconds. [​](https://docs.fireflies.ai/schema/meeting-analytics#param-monologues-count) monologues\_count Int Number of times the speaker spoke during the meeting. [​](https://docs.fireflies.ai/schema/meeting-analytics#param-filler-words) filler\_words Int Number of filler words (um, uh, like, etc.) used by the speaker. [​](https://docs.fireflies.ai/schema/meeting-analytics#param-questions-1) questions Int Number of questions asked by the speaker. [​](https://docs.fireflies.ai/schema/meeting-analytics#param-duration-pct) duration\_pct Float Percentage of the total meeting time the speaker was talking. [​](https://docs.fireflies.ai/schema/meeting-analytics#param-words-per-minute) words\_per\_minute Float Average speaking rate of the speaker in words per minute. [​](https://docs.fireflies.ai/schema/meeting-analytics#additional-resources) Additional Resources ---------------------------------------------------------------------------------------------------- [Sentiments\ ----------\ \ Schema for Sentiments](https://docs.fireflies.ai/schema/sentiments) [Speaker\ -------\ \ Schema for Speaker](https://docs.fireflies.ai/schema/speaker) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/meeting-analytics.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/meeting-analytics) [Channel](https://docs.fireflies.ai/schema/channel) [MeetingAttendee](https://docs.fireflies.ai/schema/meeting-attendee) ⌘I --- # Realtime API Guide - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/realtime-api/getting-started#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Realtime API Getting Started On this page * [Overview](https://docs.fireflies.ai/realtime-api/getting-started#overview) * [Endpoint](https://docs.fireflies.ai/realtime-api/getting-started#endpoint) * [Requirements](https://docs.fireflies.ai/realtime-api/getting-started#requirements) * [Connecting via Socket.IO](https://docs.fireflies.ai/realtime-api/getting-started#connecting-via-socket-io) * [Auth Parameters](https://docs.fireflies.ai/realtime-api/getting-started#auth-parameters) * [Additional Resources](https://docs.fireflies.ai/realtime-api/getting-started#additional-resources) [​](https://docs.fireflies.ai/realtime-api/getting-started#overview) Overview -------------------------------------------------------------------------------- This guide shows you how to connect to the Fireflies.ai Realtime API and start receiving transcription events in real time. [​](https://docs.fireflies.ai/realtime-api/getting-started#endpoint) Endpoint -------------------------------------------------------------------------------- Copy Ask AI wss://api.fireflies.ai [​](https://docs.fireflies.ai/realtime-api/getting-started#requirements) Requirements ---------------------------------------------------------------------------------------- You’ll need the following: * A valid API token * A `transcriptId` (or meeting ID) [​](https://docs.fireflies.ai/realtime-api/getting-started#connecting-via-socket-io) Connecting via Socket.IO ---------------------------------------------------------------------------------------------------------------- Use the Socket.IO client to connect and listen for events. Copy Ask AI import { io } from 'socket.io-client'; const socket = io('wss://api.fireflies.ai', { path: '/ws/realtime', auth: { token: 'Bearer ', transcriptId: '' } }); socket.on('auth.success', data => { console.log('Authenticated:', data); }); socket.on('auth.failed', err => { console.error('Authentication failed:', err); }); socket.on('connection.error', err => { console.error('Connection error:', err); }); socket.on('connection.established', () => { console.log('Connection established'); }); socket.on('transcription.broadcast', event => { console.log('Transcript event:', event); }); [​](https://docs.fireflies.ai/realtime-api/getting-started#auth-parameters) Auth Parameters ---------------------------------------------------------------------------------------------- | Field | Type | Description | | --- | --- | --- | | `token` | string | Your API access token | | `transcriptId` | string | ID of the meeting or transcript | If authentication fails, the server emits an `auth.failed` event and disconnects the socket. See [Authorization](https://docs.fireflies.ai/fundamentals/authorization) [​](https://docs.fireflies.ai/realtime-api/getting-started#additional-resources) Additional Resources -------------------------------------------------------------------------------------------------------- [Overview\ --------\ \ Overview of Realtime API](https://docs.fireflies.ai/realtime-api/overview) [Authorization\ -------------\ \ Authenticating your requests with the Fireflies API](https://docs.fireflies.ai/fundamentals/authorization) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/realtime-api/getting-started.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/realtime-api/getting-started) [Overview](https://docs.fireflies.ai/realtime-api/overview) [Event Schema](https://docs.fireflies.ai/realtime-api/event-schema) ⌘I --- # MeetingInfo Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/meeting-info#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema MeetingInfo On this page * [Additional Resources](https://docs.fireflies.ai/schema/meeting-info#additional-resources) [​](https://docs.fireflies.ai/schema/meeting-info#param-fred-joined) fred\_joined Boolean Boolean value that returns `true` if the bot joined the call, `false` otherwise. [​](https://docs.fireflies.ai/schema/meeting-info#param-silent-meeting) silent\_meeting Boolean Boolean value that returns `true` if the meeting does not contain any spoken words. Otherwise false. [​](https://docs.fireflies.ai/schema/meeting-info#param-summary-status) summary\_status SummaryStatus String value representing the summary status. Possible values are `processing`, `processed`, `failed`, `skipped`. [​](https://docs.fireflies.ai/schema/meeting-info#additional-resources) Additional Resources ----------------------------------------------------------------------------------------------- [Transcript\ ----------\ \ Schema for Transcript](https://docs.fireflies.ai/schema/transcript) [Summary\ -------\ \ Schema for Summary](https://docs.fireflies.ai/schema/summary) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/meeting-info.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/meeting-info) [MeetingAttendee](https://docs.fireflies.ai/schema/meeting-attendee) [Sentiments](https://docs.fireflies.ai/schema/sentiments) ⌘I --- # Speaker Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/speaker#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema Speaker On this page * [Additional Resources](https://docs.fireflies.ai/schema/speaker#additional-resources) [​](https://docs.fireflies.ai/schema/speaker#param-id) id number ID of the speaker identified within the transcript [​](https://docs.fireflies.ai/schema/speaker#param-name) name String Name of the speaker identified within the transcript [​](https://docs.fireflies.ai/schema/speaker#additional-resources) Additional Resources ------------------------------------------------------------------------------------------ [Transcript\ ----------\ \ Schema for Transcript](https://docs.fireflies.ai/schema/transcript) [Sentence\ --------\ \ Schema for Sentence](https://docs.fireflies.ai/schema/sentence) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/speaker.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/speaker) [SummarySection](https://docs.fireflies.ai/schema/summary-section) [Transcript](https://docs.fireflies.ai/schema/transcript) ⌘I --- # Sentiments Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/sentiments#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema Sentiments On this page * [Additional Resources](https://docs.fireflies.ai/schema/sentiments#additional-resources) [​](https://docs.fireflies.ai/schema/sentiments#param-negative-pct) negative\_pct Float Percentage of negative sentiment detected in the conversation. [​](https://docs.fireflies.ai/schema/sentiments#param-neutral-pct) neutral\_pct Float Percentage of neutral sentiment detected in the conversation. [​](https://docs.fireflies.ai/schema/sentiments#param-positive-pct) positive\_pct Float Percentage of positive sentiment detected in the conversation. [​](https://docs.fireflies.ai/schema/sentiments#additional-resources) Additional Resources --------------------------------------------------------------------------------------------- [Sentence\ --------\ \ Schema for Sentence](https://docs.fireflies.ai/schema/sentence) [Meeting Analytics\ -----------------\ \ Schema for Meeting Analytics](https://docs.fireflies.ai/schema/meeting-analytics) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/sentiments.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/sentiments) [MeetingInfo](https://docs.fireflies.ai/schema/meeting-info) [Sentence](https://docs.fireflies.ai/schema/sentence) ⌘I --- # Analytics Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/analytics#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema Analytics On this page * [TeamAnalytics](https://docs.fireflies.ai/schema/analytics#teamanalytics) * [TeamMeetingStats](https://docs.fireflies.ai/schema/analytics#teammeetingstats) * [UserMeetingStats](https://docs.fireflies.ai/schema/analytics#usermeetingstats) * [TeamConversationStats](https://docs.fireflies.ai/schema/analytics#teamconversationstats) * [UserConversationStats](https://docs.fireflies.ai/schema/analytics#userconversationstats) * [UserAnalytics](https://docs.fireflies.ai/schema/analytics#useranalytics) * [Additional Resources](https://docs.fireflies.ai/schema/analytics#additional-resources) [​](https://docs.fireflies.ai/schema/analytics#param-team) team TeamAnalytics Analytics data for the team. See [TeamAnalytics](https://docs.fireflies.ai/schema/analytics#teamanalytics) [​](https://docs.fireflies.ai/schema/analytics#param-users) users \[UserAnalytics\] List of analytics data for individual users. See [UserAnalytics](https://docs.fireflies.ai/schema/analytics#useranalytics) [​](https://docs.fireflies.ai/schema/analytics#teamanalytics) TeamAnalytics ------------------------------------------------------------------------------ [​](https://docs.fireflies.ai/schema/analytics#param-conversation) conversation TeamConversationStats Conversation statistics for the team. See [TeamConversationStats](https://docs.fireflies.ai/schema/analytics#teamconversationstats) [​](https://docs.fireflies.ai/schema/analytics#param-meeting) meeting TeamMeetingStats Meeting statistics for the team. See [TeamMeetingStats](https://docs.fireflies.ai/schema/analytics#teammeetingstats) [​](https://docs.fireflies.ai/schema/analytics#teammeetingstats) TeamMeetingStats ------------------------------------------------------------------------------------ [​](https://docs.fireflies.ai/schema/analytics#param-count) count Int Total count of meetings [​](https://docs.fireflies.ai/schema/analytics#param-count-diff-pct) count\_diff\_pct Int Percentage difference in meeting count compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-duration) duration Float Total duration of meetings in minutes [​](https://docs.fireflies.ai/schema/analytics#param-duration-diff-pct) duration\_diff\_pct Int Percentage difference in meeting duration compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-average-count) average\_count Int Average number of meetings per user [​](https://docs.fireflies.ai/schema/analytics#param-average-count-diff-pct) average\_count\_diff\_pct Int Percentage difference in average meeting count compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-average-duration) average\_duration Int Average duration of meetings in minutes [​](https://docs.fireflies.ai/schema/analytics#param-average-duration-diff-pct) average\_duration\_diff\_pct Int Percentage difference in average meeting duration compared to previous period [​](https://docs.fireflies.ai/schema/analytics#usermeetingstats) UserMeetingStats ------------------------------------------------------------------------------------ [​](https://docs.fireflies.ai/schema/analytics#param-count-1) count Int Total count of meetings for the user [​](https://docs.fireflies.ai/schema/analytics#param-count-diff) count\_diff Int Difference in meeting count compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-count-diff-compared-to) count\_diff\_compared\_to Int Meeting count in the previous period [​](https://docs.fireflies.ai/schema/analytics#param-count-diff-pct-1) count\_diff\_pct Int Percentage difference in meeting count compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-duration-1) duration Float Total duration of meetings in minutes for the user [​](https://docs.fireflies.ai/schema/analytics#param-duration-diff) duration\_diff Int Difference in meeting duration compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-duration-diff-compared-to) duration\_diff\_compared\_to Int Meeting duration in the previous period [​](https://docs.fireflies.ai/schema/analytics#param-duration-diff-pct-1) duration\_diff\_pct Int Percentage difference in meeting duration compared to previous period [​](https://docs.fireflies.ai/schema/analytics#teamconversationstats) TeamConversationStats ---------------------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/schema/analytics#param-average-filler-words) average\_filler\_words Int Average number of filler words used per meeting [​](https://docs.fireflies.ai/schema/analytics#param-average-filler-words-diff-pct) average\_filler\_words\_diff\_pct Int Percentage difference in average filler words compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-average-monologues-count) average\_monologues\_count Int Average number of monologues per meeting [​](https://docs.fireflies.ai/schema/analytics#param-average-monologues-count-diff-pct) average\_monologues\_count\_diff\_pct Int Percentage difference in average monologues count compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-average-questions) average\_questions Int Average number of questions asked per meeting [​](https://docs.fireflies.ai/schema/analytics#param-average-questions-diff-pct) average\_questions\_diff\_pct Int Percentage difference in average questions compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-average-sentiments) average\_sentiments Sentiments Average sentiment analysis results for team meetings. See [Sentiments](https://docs.fireflies.ai/schema/sentiments) [​](https://docs.fireflies.ai/schema/analytics#param-average-silence-duration) average\_silence\_duration Float Average duration of silence in minutes per meeting [​](https://docs.fireflies.ai/schema/analytics#param-average-silence-duration-diff-pct) average\_silence\_duration\_diff\_pct Int Percentage difference in average silence duration compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-average-talk-listen-ratio) average\_talk\_listen\_ratio Float Average ratio of talking to listening across all meetings [​](https://docs.fireflies.ai/schema/analytics#param-average-words-per-minute) average\_words\_per\_minute Float Average words spoken per minute across all meetings [​](https://docs.fireflies.ai/schema/analytics#param-longest-monologue-duration-sec) longest\_monologue\_duration\_sec Int Duration in seconds of the longest monologue [​](https://docs.fireflies.ai/schema/analytics#param-longest-monologue-duration-diff-pct) longest\_monologue\_duration\_diff\_pct Int Percentage difference in longest monologue duration compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-total-filler-words) total\_filler\_words Int Total number of filler words used across all meetings [​](https://docs.fireflies.ai/schema/analytics#param-total-filler-words-diff-pct) total\_filler\_words\_diff\_pct Int Percentage difference in total filler words compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-total-meeting-notes-count) total\_meeting\_notes\_count Int Total count of meeting notes created [​](https://docs.fireflies.ai/schema/analytics#param-total-meetings-count) total\_meetings\_count Int Total count of meetings [​](https://docs.fireflies.ai/schema/analytics#param-total-monologues-count) total\_monologues\_count Int Total count of monologues across all meetings [​](https://docs.fireflies.ai/schema/analytics#param-total-monologues-diff-pct) total\_monologues\_diff\_pct Int Percentage difference in total monologues compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-teammates-count) teammates\_count Int Number of teammates included in the analytics [​](https://docs.fireflies.ai/schema/analytics#param-total-questions) total\_questions Int Total number of questions asked across all meetings [​](https://docs.fireflies.ai/schema/analytics#param-total-questions-diff-pct) total\_questions\_diff\_pct Int Percentage difference in total questions compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-total-silence-duration) total\_silence\_duration Float Total duration of silence in minutes across all meetings [​](https://docs.fireflies.ai/schema/analytics#param-total-silence-duration-diff-pct) total\_silence\_duration\_diff\_pct Int Percentage difference in total silence duration compared to previous period [​](https://docs.fireflies.ai/schema/analytics#userconversationstats) UserConversationStats ---------------------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/schema/analytics#param-talk-listen-pct) talk\_listen\_pct Float Percentage of time spent talking vs listening [​](https://docs.fireflies.ai/schema/analytics#param-talk-listen-ratio) talk\_listen\_ratio Float Ratio of talking to listening [​](https://docs.fireflies.ai/schema/analytics#param-total-silence-duration-1) total\_silence\_duration Float Total duration of silence in minutes for the user [​](https://docs.fireflies.ai/schema/analytics#param-total-silence-duration-compare-to) total\_silence\_duration\_compare\_to Float Silence duration in the previous period [​](https://docs.fireflies.ai/schema/analytics#param-total-silence-pct) total\_silence\_pct Float Percentage of meeting time spent in silence [​](https://docs.fireflies.ai/schema/analytics#param-total-silence-ratio) total\_silence\_ratio Float Ratio of silence to speaking time [​](https://docs.fireflies.ai/schema/analytics#param-total-speak-duration) total\_speak\_duration Float Total duration of speaking time in minutes [​](https://docs.fireflies.ai/schema/analytics#param-total-speak-duration-with-user) total\_speak\_duration\_with\_user Float Total duration of speaking time with specific user in minutes [​](https://docs.fireflies.ai/schema/analytics#param-total-word-count) total\_word\_count Int Total count of words spoken [​](https://docs.fireflies.ai/schema/analytics#param-user-filler-words) user\_filler\_words Int Number of filler words used by the user [​](https://docs.fireflies.ai/schema/analytics#param-user-filler-words-compare-to) user\_filler\_words\_compare\_to Int Filler words used in the previous period [​](https://docs.fireflies.ai/schema/analytics#param-user-filler-words-diff-pct) user\_filler\_words\_diff\_pct Int Percentage difference in filler words compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-user-longest-monologue-sec) user\_longest\_monologue\_sec Int Duration in seconds of the user’s longest monologue [​](https://docs.fireflies.ai/schema/analytics#param-user-longest-monologue-compare-to) user\_longest\_monologue\_compare\_to Int Longest monologue duration in the previous period [​](https://docs.fireflies.ai/schema/analytics#param-user-longest-monologue-diff-pct) user\_longest\_monologue\_diff\_pct Int Percentage difference in longest monologue duration compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-user-monologues-count) user\_monologues\_count Int Count of monologues by the user [​](https://docs.fireflies.ai/schema/analytics#param-user-monologues-count-compare-to) user\_monologues\_count\_compare\_to Int Monologues count in the previous period [​](https://docs.fireflies.ai/schema/analytics#param-user-monologues-count-diff-pct) user\_monologues\_count\_diff\_pct Int Percentage difference in monologues count compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-user-questions) user\_questions Int Number of questions asked by the user [​](https://docs.fireflies.ai/schema/analytics#param-user-questions-compare-to) user\_questions\_compare\_to Int Questions asked in the previous period [​](https://docs.fireflies.ai/schema/analytics#param-user-questions-diff-pct) user\_questions\_diff\_pct Int Percentage difference in questions asked compared to previous period [​](https://docs.fireflies.ai/schema/analytics#param-user-speak-duration) user\_speak\_duration Float Duration of time the user spent speaking in minutes [​](https://docs.fireflies.ai/schema/analytics#param-user-word-count) user\_word\_count Int Count of words spoken by the user [​](https://docs.fireflies.ai/schema/analytics#param-user-words-per-minute) user\_words\_per\_minute Int Words spoken per minute by the user [​](https://docs.fireflies.ai/schema/analytics#param-user-words-per-minute-compare-to) user\_words\_per\_minute\_compare\_to Int Words per minute in the previous period [​](https://docs.fireflies.ai/schema/analytics#param-user-words-per-minute-diff-pct) user\_words\_per\_minute\_diff\_pct Int Percentage difference in words per minute compared to previous period [​](https://docs.fireflies.ai/schema/analytics#useranalytics) UserAnalytics ------------------------------------------------------------------------------ [​](https://docs.fireflies.ai/schema/analytics#param-user-id) user\_id String Unique identifier for the user [​](https://docs.fireflies.ai/schema/analytics#param-user-name) user\_name String Name of the user [​](https://docs.fireflies.ai/schema/analytics#param-user-email) user\_email String Email address of the user [​](https://docs.fireflies.ai/schema/analytics#param-conversation-1) conversation UserConversationStats Conversation statistics for the user. See [UserConversationStats](https://docs.fireflies.ai/schema/analytics#userconversationstats) [​](https://docs.fireflies.ai/schema/analytics#param-meeting-1) meeting UserMeetingStats Meeting statistics for the user. See [UserMeetingStats](https://docs.fireflies.ai/schema/analytics#usermeetingstats) [​](https://docs.fireflies.ai/schema/analytics#additional-resources) Additional Resources -------------------------------------------------------------------------------------------- [Sentiments\ ----------\ \ Schema for Sentiments](https://docs.fireflies.ai/schema/sentiments) [Meeting Analytics\ -----------------\ \ Schema for Meeting Analytics](https://docs.fireflies.ai/schema/meeting-analytics) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/analytics.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/analytics) [AIFilter](https://docs.fireflies.ai/schema/aifilter) [AI Apps](https://docs.fireflies.ai/schema/apps) ⌘I --- # Advanced API Examples - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/examples/advanced#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Examples Advanced On this page * [Overview](https://docs.fireflies.ai/examples/advanced#overview) * [Find questions from external participants](https://docs.fireflies.ai/examples/advanced#find-questions-from-external-participants) * [Fetch meetings from multiple users](https://docs.fireflies.ai/examples/advanced#fetch-meetings-from-multiple-users) * [Verify webhook requests](https://docs.fireflies.ai/examples/advanced#verify-webhook-requests) * [Fireflies.ai Replit](https://docs.fireflies.ai/examples/advanced#fireflies-ai-replit) * [Additional Resources](https://docs.fireflies.ai/examples/advanced#additional-resources) [​](https://docs.fireflies.ai/examples/advanced#overview) Overview --------------------------------------------------------------------- Explore advanced usage examples that build on top of the Fireflies.ai API. This page is regularly updated ### [​](https://docs.fireflies.ai/examples/advanced#find-questions-from-external-participants) [Find questions from external participants](https://replit.com/@firefliesai/Firefliesai-Find-questions-from-external-participants?v=1) This replit allows you to query questions asked by participants who do not belong to your organization. It can be useful in deriving insights and analysis for client calls, interviews, etc. ### [​](https://docs.fireflies.ai/examples/advanced#fetch-meetings-from-multiple-users) [Fetch meetings from multiple users](https://replit.com/@firefliesai/Firefliesai-Fetch-meetings-for-multiple-users?v=1) This replit allows you to fetch meetings from multiple users by providing it a list of API keys. Please read our privacy policy and terms of usage for more details ### [​](https://docs.fireflies.ai/examples/advanced#verify-webhook-requests) [Verify webhook requests](https://replit.com/@firefliesai/Firefliesai-Verifying-webhook-requests?v=1) This replit allows you to verify webhook requests by checking the signature and the payload. [​](https://docs.fireflies.ai/examples/advanced#fireflies-ai-replit) Fireflies.ai Replit ------------------------------------------------------------------------------------------- Explore the complete list of usage examples at [replit.com/@firefliesai](https://replit.com/@firefliesai) [​](https://docs.fireflies.ai/examples/advanced#additional-resources) Additional Resources --------------------------------------------------------------------------------------------- [Basic examples\ --------------\ \ Basic usage examples](https://docs.fireflies.ai/examples/basic) [Webhooks\ --------\ \ Create notifications using webhooks](https://docs.fireflies.ai/graphql-api/webhooks) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/examples/advanced.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/examples/advanced) [Basic](https://docs.fireflies.ai/examples/basic) [Analytics](https://docs.fireflies.ai/graphql-api/query/analytics) ⌘I --- # Summary Section Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/summary-section#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema SummarySection On this page * [Additional Resources](https://docs.fireflies.ai/schema/summary-section#additional-resources) [​](https://docs.fireflies.ai/schema/summary-section#param-title) title String Title of the section [​](https://docs.fireflies.ai/schema/summary-section#param-content) content String Response summary content of the section [​](https://docs.fireflies.ai/schema/summary-section#additional-resources) Additional Resources -------------------------------------------------------------------------------------------------- [Summary\ -------\ \ Schema for Summary](https://docs.fireflies.ai/schema/summary) [Transcript\ ----------\ \ Schema for Transcript](https://docs.fireflies.ai/schema/transcript) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/summary-section.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/summary-section) [Summary](https://docs.fireflies.ai/schema/summary) [Speaker](https://docs.fireflies.ai/schema/speaker) ⌘I --- # Sentence Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/sentence#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema Sentence On this page * [Additional Resources](https://docs.fireflies.ai/schema/sentence#additional-resources) [​](https://docs.fireflies.ai/schema/sentence#param-index) index Int Index [​](https://docs.fireflies.ai/schema/sentence#param-text) text String Default transcription sentence or user edited transcription sentence. [​](https://docs.fireflies.ai/schema/sentence#param-raw-text) raw\_text String Transcribed sentence from meeting audio [​](https://docs.fireflies.ai/schema/sentence#param-start-time) start\_time String Start time of Sentence [​](https://docs.fireflies.ai/schema/sentence#param-end-time) end\_time String End time of Sentence [​](https://docs.fireflies.ai/schema/sentence#param-speaker-id) speaker\_id ID Unique identifier for Speaker [​](https://docs.fireflies.ai/schema/sentence#param-speaker-name) speaker\_name String Name of the speaker. [​](https://docs.fireflies.ai/schema/sentence#param-ai-filters) ai\_filters AIFilter Sentiment analysis from meeting audio. Type of [AIFilter](https://docs.fireflies.ai/schema/aifilter) [​](https://docs.fireflies.ai/schema/sentence#additional-resources) Additional Resources ------------------------------------------------------------------------------------------- [AIFilter\ --------\ \ Schema for AIFilter](https://docs.fireflies.ai/schema/aifilter) [Speaker\ -------\ \ Schema for Speaker](https://docs.fireflies.ai/schema/speaker) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/sentence.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/sentence) [Sentiments](https://docs.fireflies.ai/schema/sentiments) [Summary](https://docs.fireflies.ai/schema/summary) ⌘I --- # Summary Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/summary#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema Summary On this page * [Additional Resources](https://docs.fireflies.ai/schema/summary#additional-resources) Meeting AI summary prompts are defined by [AI apps](https://app.fireflies.ai/apps) and can be customized to your needs. [​](https://docs.fireflies.ai/schema/summary#param-action-items) action\_items String A list of action items generated by the AI based on the meeting transcript [​](https://docs.fireflies.ai/schema/summary#param-keywords) keywords String A list of keywords generated by the AI based on the meeting transcript [​](https://docs.fireflies.ai/schema/summary#param-outline) outline String An outline of the meeting with timestamps generated by the AI based on the meeting transcript [​](https://docs.fireflies.ai/schema/summary#param-overview) overview String A summary of the meeting generated by the AI [​](https://docs.fireflies.ai/schema/summary#param-shorthand-bullet) shorthand\_bullet String A list of shorthand bullets generated by the AI [​](https://docs.fireflies.ai/schema/summary#param-notes) notes String Detailed meeting notes generated by the AI [​](https://docs.fireflies.ai/schema/summary#param-gist) gist String A summary of the meeting in 1 sentence [​](https://docs.fireflies.ai/schema/summary#param-bullet-gist) bullet\_gist String Summary of the meeting in a few bullet points with descriptive emojis [​](https://docs.fireflies.ai/schema/summary#param-short-summary) short\_summary String Summary of the meeting in a single paragraph [​](https://docs.fireflies.ai/schema/summary#param-short-overview) short\_overview String Brief overview of the meeting [​](https://docs.fireflies.ai/schema/summary#param-meeting-type) meeting\_type String Meeting classification [​](https://docs.fireflies.ai/schema/summary#param-topics-discussed) topics\_discussed \[String\] List of topics discussed during the meeting. [​](https://docs.fireflies.ai/schema/summary#param-transcript-chapters) transcript\_chapters \[String\] Chapters of the short transcript. The short transcript is an LLM-condensed transcript that may be helpful for downstream applications [​](https://docs.fireflies.ai/schema/summary#param-extended-sections) extended\_sections \[SummarySection\] Optional sections of the summary included by customizing the summary from the dashboard [​](https://docs.fireflies.ai/schema/summary#additional-resources) Additional Resources ------------------------------------------------------------------------------------------ [Summary Section\ ---------------\ \ Schema for Summary Section](https://docs.fireflies.ai/schema/summary-section) [Transcript\ ----------\ \ Schema for Transcript](https://docs.fireflies.ai/schema/transcript) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/summary.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/summary) [Sentence](https://docs.fireflies.ai/schema/sentence) [SummarySection](https://docs.fireflies.ai/schema/summary-section) ⌘I --- # User Groups Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/user-groups#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema User Groups On this page * [Additional Resources](https://docs.fireflies.ai/schema/user-groups#additional-resources) [​](https://docs.fireflies.ai/schema/user-groups#param-id) id String Unique ID for the user group [​](https://docs.fireflies.ai/schema/user-groups#param-name) name String Name of the user group. [​](https://docs.fireflies.ai/schema/user-groups#param-handle) handle String Unique identifier or handle for the user group. [​](https://docs.fireflies.ai/schema/user-groups#param-members) members \[UserGroupMember\] List of members in the user group. See [UserGroupMember](https://docs.fireflies.ai/schema/user-group-member) [​](https://docs.fireflies.ai/schema/user-groups#additional-resources) Additional Resources ---------------------------------------------------------------------------------------------- [User\ ----\ \ Schema for User](https://docs.fireflies.ai/schema/user) [User Group Member\ -----------------\ \ Schema for User Group Member](https://docs.fireflies.ai/schema/user-group-member) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/user-groups.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/user-groups) [User](https://docs.fireflies.ai/schema/user) [User Group Member](https://docs.fireflies.ai/schema/user-group-member) ⌘I --- # Deprecated - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/additional-info/deprecated#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Additional Info Deprecated On this page * [Overview](https://docs.fireflies.ai/additional-info/deprecated#overview) * [Transcript](https://docs.fireflies.ai/additional-info/deprecated#transcript) * [Transcripts](https://docs.fireflies.ai/additional-info/deprecated#transcripts) [​](https://docs.fireflies.ai/additional-info/deprecated#overview) Overview ------------------------------------------------------------------------------ This page lists all the fields that have been deprecated. Deprecated fields are fields that are no longer recommended for use and may be removed in future versions. Please note that using deprecated fields can lead to compatibility issues in future releases. The following fields have been deprecated: ### [​](https://docs.fireflies.ai/additional-info/deprecated#transcript) [Transcript](https://docs.fireflies.ai/schema/transcript) `host_email`: Use `organizer_email` instead. ### [​](https://docs.fireflies.ai/additional-info/deprecated#transcripts) [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) `date`: Use `fromDate` and `toDate` to query a time range. `title`: Use `keyword` and `scope` instead of `title` `organizer_email`: Use the `organizers` array field to filter by one or more organizer email addresses. `participant_email`: Use the `participants` array field to filter by one or more participant email addresses. Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/additional-info/deprecated.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/additional-info/deprecated) [Error codes](https://docs.fireflies.ai/miscellaneous/error-codes) [Changelog](https://docs.fireflies.ai/additional-info/change-log) ⌘I --- # Webhooks - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/webhooks#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation GraphQL API Webhooks On this page * [Overview](https://docs.fireflies.ai/graphql-api/webhooks#overview) * [Events supported](https://docs.fireflies.ai/graphql-api/webhooks#events-supported) * [Saving a webhook](https://docs.fireflies.ai/graphql-api/webhooks#saving-a-webhook) * [Upload audio webhook](https://docs.fireflies.ai/graphql-api/webhooks#upload-audio-webhook) * [Webhook Authentication](https://docs.fireflies.ai/graphql-api/webhooks#webhook-authentication) * [How It Works](https://docs.fireflies.ai/graphql-api/webhooks#how-it-works) * [Saving a secret](https://docs.fireflies.ai/graphql-api/webhooks#saving-a-secret) * [Verifying the Signature](https://docs.fireflies.ai/graphql-api/webhooks#verifying-the-signature) * [See it in action](https://docs.fireflies.ai/graphql-api/webhooks#see-it-in-action) * [Webhook Schema](https://docs.fireflies.ai/graphql-api/webhooks#webhook-schema) * [Example Payload](https://docs.fireflies.ai/graphql-api/webhooks#example-payload) * [FAQ](https://docs.fireflies.ai/graphql-api/webhooks#faq) * [Additional Resources](https://docs.fireflies.ai/graphql-api/webhooks#additional-resources) [​](https://docs.fireflies.ai/graphql-api/webhooks#overview) Overview ------------------------------------------------------------------------ Webhooks enable your application to set up event based notifications. In this section, you’ll learn how to configure webhooks to receive updates from Fireflies. [​](https://docs.fireflies.ai/graphql-api/webhooks#events-supported) Events supported ---------------------------------------------------------------------------------------- The webhooks support the following events: * Transcription complete: Triggers when a meeting has been processed and the transcript is ready for viewing Fireflies sends webhook notifications as POST requests to your specified endpoint. Each request contains a JSON payload with information about the event that occurred. [​](https://docs.fireflies.ai/graphql-api/webhooks#saving-a-webhook) Saving a webhook ---------------------------------------------------------------------------------------- Follow the instructions below to save a webhook URL that sends notifications for all subscribed events. This webhook will only be fired for meetings that you own. 1 Visit the [Fireflies.ai dashboard settings](https://app.fireflies.ai/settings) 2 Navigate to the Developer settings tab 3 Enter a valid https URL in the webhooks field and save You may test your webhook using the upload audio API or by uploading through the dashboard at [app.fireflies.ai/upload](https://app.fireflies.ai/upload) [​](https://docs.fireflies.ai/graphql-api/webhooks#upload-audio-webhook) Upload audio webhook ------------------------------------------------------------------------------------------------ You can also include a webhook URL as part of an upload audio request. This is different from the saved webhook as it will only send notifications for that singular audio upload request. curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{ "query": "mutation($input: AudioUploadInput) { uploadAudio(input: $input) { success title message } }", "variables": { "input": { "url": "https://url_to_the_audio_file", "title": "title of the file", "webhook": "https://url_for_the_webhook" } } }' \ https://api.fireflies.ai/graphql [​](https://docs.fireflies.ai/graphql-api/webhooks#webhook-authentication) Webhook Authentication ---------------------------------------------------------------------------------------------------- Webhook authentication ensures that incoming webhook requests are securely verified before processing. This allows consumers to trust that webhook events originate from a secure and verified source. ### [​](https://docs.fireflies.ai/graphql-api/webhooks#how-it-works) How It Works Each webhook request sent from the server includes an `x-hub-signature` header containing a SHA-256 HMAC signature of the request payload. This signature is generated using a secret key known only to the server and your application. When the consumer receives a webhook, they can use the signature provided in the `x-hub-signature` header to verify that the request has not been tampered with. This is done by computing their own HMAC signature using the shared secret key and comparing it to the signature included in the header. ### [​](https://docs.fireflies.ai/graphql-api/webhooks#saving-a-secret) Saving a secret 1. Go to the settings page at [app.fireflies.ai/settings](https://app.fireflies.ai/settings) 2. Navigate to the **Developer Settings** tab 3. You can either: * Enter a custom secret key of 16-32 characters in the input field * Click on the refresh button to generate a random secret key 4. Click Save to ensure the secret gets updated 5. Make sure to store this secret key securely, as it will be used to authenticate incoming webhook requests ### [​](https://docs.fireflies.ai/graphql-api/webhooks#verifying-the-signature) Verifying the Signature 1. **Receive the Webhook**: * Each request will include the payload and an `x-hub-signature` header 2. **Verify the Signature**: * Compute the HMAC SHA-256 signature using the payload and the shared secret key * Compare the computed signature to the `x-hub-signature` header value * If they match, the request is verified as authentic. If they do not match, treat the request with caution or reject it By verifying webhook signatures, consumers can ensure that webhook events received are secure and have not been altered during transmission ### [​](https://docs.fireflies.ai/graphql-api/webhooks#see-it-in-action) See it in action To see webhook authentication in action, you can view an example at [Fireflies.ai Verifying Webhook Requests](https://replit.com/@firefliesai/Firefliesai-Verifying-webhook-requests#index.js) . This example demonstrates how to receive a webhook, compute the HMAC SHA-256 signature, and verify it against the `x-hub-signature` header to ensure the request’s authenticity. [​](https://docs.fireflies.ai/graphql-api/webhooks#webhook-schema) Webhook Schema ------------------------------------------------------------------------------------ [​](https://docs.fireflies.ai/graphql-api/webhooks#param-meeting-id) meetingId String required Identifier for the meeting / transcript that the webhook has triggered for. MeetingId and TranscriptId are used interchangeably for the Fireflies.ai Platform. [​](https://docs.fireflies.ai/graphql-api/webhooks#param-event-type) eventType String Name of the event type that has been fired against the webhook [​](https://docs.fireflies.ai/graphql-api/webhooks#param-client-reference-id) clientReferenceId ID Custom identifier set by the user during upload. You may use this to identify your uploads in your events. [​](https://docs.fireflies.ai/graphql-api/webhooks#example-payload) Example Payload -------------------------------------------------------------------------------------- Copy Ask AI { "meetingId": "ASxwZxCstx", "eventType": "Transcription completed", "clientReferenceId": "be582c46-4ac9-4565-9ba6-6ab4264496a8" } [​](https://docs.fireflies.ai/graphql-api/webhooks#faq) FAQ -------------------------------------------------------------- Why am I not receiving webhook requests There may be multiple reasons why you are not receiving webhook requests. Please go through the following checklist: * Webhooks are only fired for meeting owners, referred to in the API as the `organizer_email.` Ensure that you have correctly setup the webhooks for the meeting owner. * Ensure that your webhook is setup as a POST request * If you have setup secret verification, ensure that you are correctly verifying the request by checking the example implementation [here](https://replit.com/@firefliesai/Firefliesai-Verifying-webhook-requests?v=1) . Team-wide webhooks are only supported for the Enterprise tier with the Super Admin role. This allows you to setup one webhook for all meetings owned by your team. Details [here](https://docs.fireflies.ai/fundamentals/super-admin) . [​](https://docs.fireflies.ai/graphql-api/webhooks#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------ [Super Admin\ -----------\ \ Fireflies Super Admin with advanced capabilities](https://docs.fireflies.ai/fundamentals/super-admin) [Upload Audio\ ------------\ \ Use the API to upload audio to Fireflies.ai](https://docs.fireflies.ai/graphql-api/mutation/upload-audio) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/webhooks.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/webhooks) [Update Meeting Privacy](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy) [Overview](https://docs.fireflies.ai/realtime-api/overview) ⌘I --- # API Documentation [Skip to main content](https://docs.fireflies.ai/schema/bite#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema Bite On this page * [Additional Resources](https://docs.fireflies.ai/schema/bite#additional-resources) [​](https://docs.fireflies.ai/schema/bite#param-id) id String A unique identifier for the Bite [​](https://docs.fireflies.ai/schema/bite#param-transcript-id) transcript\_id String A unique identifier for the transcript the Bite is associated to [​](https://docs.fireflies.ai/schema/bite#param-start-time) start\_time String Start time for the Bite [​](https://docs.fireflies.ai/schema/bite#param-end-time) end\_time String End time for the Bite [​](https://docs.fireflies.ai/schema/bite#param-name) name String A string representing the title of the Bite [​](https://docs.fireflies.ai/schema/bite#param-thumbnail) thumbnail String URL of the Bite’s thumbnail image [​](https://docs.fireflies.ai/schema/bite#param-preview) preview String URL to a short preview video of the Bite [​](https://docs.fireflies.ai/schema/bite#param-status) status String Current processing status of the Bite. Acceptable values include ‘pending’, ‘processing’, ‘ready’, and ‘error’ [​](https://docs.fireflies.ai/schema/bite#param-summary) summary String An AI-generated summary describing the content of the Bite [​](https://docs.fireflies.ai/schema/bite#param-user-id) userId String Identifier of the user who created the Bite [​](https://docs.fireflies.ai/schema/bite#param-summary-status) summary\_status String Status of the AI summary generation process [​](https://docs.fireflies.ai/schema/bite#param-media-type) media\_type String Type of the Bite, either ‘video’ or ‘audio’ [​](https://docs.fireflies.ai/schema/bite#param-privacies) privacies \[BitePrivacy\] Array specifying the visibility of the Bite. Possible values are `public`, `team`, and `participants`. For example, `["team", "participants"]` indicates visibility to both team members and participants, while `["public"]` allows anyone to access the bite through its link [​](https://docs.fireflies.ai/schema/bite#param-created-at) created\_at String The date when this Bite was created [​](https://docs.fireflies.ai/schema/bite#param-user) user BiteUser Object representing the user who created the Bite, including relevant user details Show properties [​](https://docs.fireflies.ai/schema/bite#param-name-1) name String required Name associated with the User [​](https://docs.fireflies.ai/schema/bite#param-id-1) id String required ID of the User [​](https://docs.fireflies.ai/schema/bite#param-first-name) first\_name String First name of the User [​](https://docs.fireflies.ai/schema/bite#param-last-name) last\_name String Last name of the User [​](https://docs.fireflies.ai/schema/bite#param-picture) picture String Picture associated with the User [​](https://docs.fireflies.ai/schema/bite#param-sources) sources \[MediaSource\] Array of MediaSource objects for the Bite Show properties [​](https://docs.fireflies.ai/schema/bite#param-src) src String required Source of the media [​](https://docs.fireflies.ai/schema/bite#param-type) type String Type of the media [​](https://docs.fireflies.ai/schema/bite#param-captions) captions \[BiteCaption\] Array of Object describing text captions associated with the Bite Show properties [​](https://docs.fireflies.ai/schema/bite#param-index) index String required Index [​](https://docs.fireflies.ai/schema/bite#param-speaker-id) speaker\_id String required SpeakerId associated with the caption object [​](https://docs.fireflies.ai/schema/bite#param-text) text String required Text associated with the caption [​](https://docs.fireflies.ai/schema/bite#param-speaker-name) speaker\_name String required Name of the speaker associated with this caption [​](https://docs.fireflies.ai/schema/bite#param-start-time-1) start\_time String required Start time for the caption [​](https://docs.fireflies.ai/schema/bite#param-end-time-1) end\_time String required End time for the caption [​](https://docs.fireflies.ai/schema/bite#param-created-from) created\_from BiteOrigin Object describing the origin of the Bite with the following properties Show properties [​](https://docs.fireflies.ai/schema/bite#param-id-2) id String required Unique identifier [​](https://docs.fireflies.ai/schema/bite#param-name-2) name String required Name of the origin source [​](https://docs.fireflies.ai/schema/bite#param-type-1) type String required Type of the original source, e.g., ‘meeting’ [​](https://docs.fireflies.ai/schema/bite#param-duration) duration String Length of the original source in seconds [​](https://docs.fireflies.ai/schema/bite#additional-resources) Additional Resources --------------------------------------------------------------------------------------- [Transcript\ ----------\ \ Schema for Transcript](https://docs.fireflies.ai/schema/transcript) [Create Bite\ -----------\ \ Use the API to create bites from your transcripts](https://docs.fireflies.ai/graphql-api/mutation/create-bite) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/bite.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/bite) [AudioUploadStatus](https://docs.fireflies.ai/schema/audio-upload-status) [Channel](https://docs.fireflies.ai/schema/channel) ⌘I --- # MeetingAttendee Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/meeting-attendee#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema MeetingAttendee On this page * [Additional Resources](https://docs.fireflies.ai/schema/meeting-attendee#additional-resources) [​](https://docs.fireflies.ai/schema/meeting-attendee#param-display-name) displayName String Display name of the meeting attendee. [​](https://docs.fireflies.ai/schema/meeting-attendee#param-email) email String Email address of the meeting attendee. [​](https://docs.fireflies.ai/schema/meeting-attendee#param-phone-number) phoneNumber String Phone number of the meeting attendee. [​](https://docs.fireflies.ai/schema/meeting-attendee#param-name) name String Full name of the meeting attendee. [​](https://docs.fireflies.ai/schema/meeting-attendee#param-location) location String Deprecated field [​](https://docs.fireflies.ai/schema/meeting-attendee#additional-resources) Additional Resources --------------------------------------------------------------------------------------------------- [MeetingAttendance\ -----------------\ \ Schema for MeetingAttendance](https://docs.fireflies.ai/schema/meeting-attendance) [Transcript\ ----------\ \ Schema for Transcript](https://docs.fireflies.ai/schema/transcript) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/meeting-attendee.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/meeting-attendee) [MeetingAnalytics](https://docs.fireflies.ai/schema/meeting-analytics) [MeetingInfo](https://docs.fireflies.ai/schema/meeting-info) ⌘I --- # User Group Member Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/user-group-member#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema User Group Member On this page * [Additional Resources](https://docs.fireflies.ai/schema/user-group-member#additional-resources) [​](https://docs.fireflies.ai/schema/user-group-member#param-user-id) user\_id String Unique identifier for the user group member. [​](https://docs.fireflies.ai/schema/user-group-member#param-first-name) first\_name String First name of the user group member. [​](https://docs.fireflies.ai/schema/user-group-member#param-last-name) last\_name String Last name of the user group member. [​](https://docs.fireflies.ai/schema/user-group-member#param-email) email String Email address of the user group member. [​](https://docs.fireflies.ai/schema/user-group-member#additional-resources) Additional Resources ---------------------------------------------------------------------------------------------------- [User Groups\ -----------\ \ Schema for User Groups](https://docs.fireflies.ai/schema/user-groups) [User\ ----\ \ Schema for User](https://docs.fireflies.ai/schema/user) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/user-group-member.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/user-group-member) [User Groups](https://docs.fireflies.ai/schema/user-groups) [AudioUploadInput](https://docs.fireflies.ai/schema/input/audio-upload-input) ⌘I --- # User Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/user#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema User On this page * [Additional Resources](https://docs.fireflies.ai/schema/user#additional-resources) [​](https://docs.fireflies.ai/schema/user#param-user-id) user\_id String Unique identifier for the User. [​](https://docs.fireflies.ai/schema/user#param-user-groups) user\_groups \[UserGroup\] List of user groups the user belongs to. (See [User Groups](https://docs.fireflies.ai/schema/user-groups) ) [​](https://docs.fireflies.ai/schema/user#param-email) email String Email address for the User. [​](https://docs.fireflies.ai/schema/user#param-name) name String Full name of the User. [​](https://docs.fireflies.ai/schema/user#param-num-transcripts) num\_transcripts Int Total number of transcripts associated with the user. [​](https://docs.fireflies.ai/schema/user#param-recent-transcript) recent\_transcript String Most recent transcript generated by the user. [​](https://docs.fireflies.ai/schema/user#param-recent-meeting) recent\_meeting String Details about the user’s most recent meeting. [​](https://docs.fireflies.ai/schema/user#param-minutes-consumed) minutes\_consumed Int Total number of minutes consumed by the user in meetings. [​](https://docs.fireflies.ai/schema/user#param-is-admin) is\_admin Boolean Indicates whether the user has administrative privileges. True if the user is an admin, false otherwise. [​](https://docs.fireflies.ai/schema/user#param-integrations) integrations \[String\] A list of integrations enabled for the user’s account. [​](https://docs.fireflies.ai/schema/user#additional-resources) Additional Resources --------------------------------------------------------------------------------------- [User Groups\ -----------\ \ Schema for User Groups](https://docs.fireflies.ai/schema/user-groups) [Transcripts\ -----------\ \ Query transcripts using the API](https://docs.fireflies.ai/graphql-api/query/transcripts) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/user.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/user) [Transcript](https://docs.fireflies.ai/schema/transcript) [User Groups](https://docs.fireflies.ai/schema/user-groups) ⌘I --- # Transcript Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/transcript#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Schema Transcript On this page * [Additional Resources](https://docs.fireflies.ai/schema/transcript#additional-resources) [​](https://docs.fireflies.ai/schema/transcript#param-id) id ID Unique identifier of the Transcript. [​](https://docs.fireflies.ai/schema/transcript#param-title) title String Title of the Transcript. [​](https://docs.fireflies.ai/schema/transcript#param-host-email) host\_email String [DEPRECATED](https://docs.fireflies.ai/additional-info/deprecated) Email address of the meeting host. [​](https://docs.fireflies.ai/schema/transcript#param-organizer-email) organizer\_email String Email address of the meeting organizer. [​](https://docs.fireflies.ai/schema/transcript#param-user) user User The [User](https://docs.fireflies.ai/schema/user) who Fred recorded the meeting on behalf of [​](https://docs.fireflies.ai/schema/transcript#param-speakers) speakers \[Speaker\] The speakers array contains the id and name of the speaker as it appears within the transcript [​](https://docs.fireflies.ai/schema/transcript#param-transcript-url) transcript\_url String The url to view the transcript in the dashboard [​](https://docs.fireflies.ai/schema/transcript#param-participants) participants \[String\] An array of email addresses of meeting participants guests, including participants that do not have Fireflies account. [​](https://docs.fireflies.ai/schema/transcript#param-meeting-attendees) meeting\_attendees \[MeetingAttendee\] List of [MeetingAttendee](https://docs.fireflies.ai/schema/meeting-attendee) [​](https://docs.fireflies.ai/schema/transcript#param-meeting-attendance) meeting\_attendance \[MeetingAttendance\] List of [MeetingAttendance](https://docs.fireflies.ai/schema/meeting-attendance) records showing when participants joined and left the meeting [​](https://docs.fireflies.ai/schema/transcript#param-fireflies-users) fireflies\_users \[String\] An array of email addresses of only Fireflies users participants that have fireflies account that participated in the meeting [​](https://docs.fireflies.ai/schema/transcript#param-duration) duration Number Duration of the audio in minutes [​](https://docs.fireflies.ai/schema/transcript#param-date-string) dateString DateTime String representation of DateTime. Example: `2024-04-22T20:14:04.454Z` [​](https://docs.fireflies.ai/schema/transcript#param-date) date Float Date the transcript was created represented in milliseconds from [EPOCH](https://en.wikipedia.org/wiki/Epoch_(computing)) .The timezone for this field is UTC +00:00 [​](https://docs.fireflies.ai/schema/transcript#param-audio-url) audio\_url String Secure, newly generated hashed url that allows you download meeting audio. This url expires after every 24 hours. You’d have to make another request to generate a new audio\_url.You need to be subscribed to subscribed to a pro or higher plan to query audio\_url. View plans [here](https://fireflies.ai/pricing) [​](https://docs.fireflies.ai/schema/transcript#param-video-url) video\_url String Secure, newly generated hashed url that allows you download meeting video. This url expires after every 24 hours. You’d have to make another request to generate a new video\_url. You will need to enable `RECORD MEETING VIDEO` setting on your Fireflies [dashboard](https://app.fireflies.ai/settings) for this to work.You need to be subscribed to a business or higher plan to query video\_url. View plans [here](https://fireflies.ai/pricing) [​](https://docs.fireflies.ai/schema/transcript#param-sentence) sentence \[Sentence\] An array of [Sentence](https://docs.fireflies.ai/schema/sentence) (s), containing transcript details like `raw_text`, `speaker_name`, etc. [​](https://docs.fireflies.ai/schema/transcript#param-calendar-id) calendar\_id String Calendar provider event ID. This field represents calId for google calendar and iCalUID for outlook calendar. [​](https://docs.fireflies.ai/schema/transcript#param-summary) summary Summary AI generated [Summary](https://docs.fireflies.ai/schema/summary) of the meeting. [​](https://docs.fireflies.ai/schema/transcript#param-meeting-info) meeting\_info MeetingInfo [MeetingInfo](https://docs.fireflies.ai/schema/meeting-info) metadata fields. [​](https://docs.fireflies.ai/schema/transcript#param-cal-id) cal\_id String Calendar provider event ID with a timestamp that helps uniquely identify recurring events [​](https://docs.fireflies.ai/schema/transcript#param-calendar-type) calendar\_type String Calendar provider name [​](https://docs.fireflies.ai/schema/transcript#param-apps) apps Apps Preview of [Apps](https://docs.fireflies.ai/schema/apps) generated from the transcript. Max limit of 5 most recent AI App Outputs per meeting. Use the [Apps Query](https://docs.fireflies.ai/graphql-api/query/apps) to fetch the entire list of AI App Outputs [​](https://docs.fireflies.ai/schema/transcript#param-meeting-link) meeting\_link String The web conferencing url of the meeting. This field is only populated if the meeting was hosted on a supported platform such as Google Meet, Zoom, etc. [​](https://docs.fireflies.ai/schema/transcript#param-analytics) analytics MeetingAnalytics [MeetingAnalytics](https://docs.fireflies.ai/schema/meeting-analytics) contains analytics data about the meeting, including: * `sentiments`: Sentiment analysis showing percentages of positive, neutral, and negative sentiments * `categories`: Counts of different types of content (questions, date/times, metrics, tasks) * `speakers`: Detailed analytics for each speaker including duration, word count, filler words, etc. You need to be subscribed to subscribed to a pro or higher plan to query meeting analytics. View plans [here](https://fireflies.ai/pricing) [​](https://docs.fireflies.ai/schema/transcript#param-channels) channels \[Channel\] An array of [Channel](https://docs.fireflies.ai/schema/channel) the meeting belongs to [​](https://docs.fireflies.ai/schema/transcript#additional-resources) Additional Resources --------------------------------------------------------------------------------------------- [Summary\ -------\ \ Schema for Summary](https://docs.fireflies.ai/schema/summary) [Sentence\ --------\ \ Schema for Sentence](https://docs.fireflies.ai/schema/sentence) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/transcript.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/transcript) [Speaker](https://docs.fireflies.ai/schema/speaker) [User](https://docs.fireflies.ai/schema/user) ⌘I --- # What's New - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/getting-started/whats-new#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Getting Started What's New On this page * [2.13.0](https://docs.fireflies.ai/getting-started/whats-new#2-13-0) * [2.12.0](https://docs.fireflies.ai/getting-started/whats-new#2-12-0) * [2.10.0](https://docs.fireflies.ai/getting-started/whats-new#2-10-0) * [2.9.0](https://docs.fireflies.ai/getting-started/whats-new#2-9-0) * [2.8.0](https://docs.fireflies.ai/getting-started/whats-new#2-8-0) * [2.7.0](https://docs.fireflies.ai/getting-started/whats-new#2-7-0) * [2.6.2](https://docs.fireflies.ai/getting-started/whats-new#2-6-2) * [2.6.1](https://docs.fireflies.ai/getting-started/whats-new#2-6-1) * [2.6.0](https://docs.fireflies.ai/getting-started/whats-new#2-6-0) Take a look at our latest updates, features, and improvements for the Fireflies API. [​](https://docs.fireflies.ai/getting-started/whats-new#2-13-0) 2.13.0 Rate Limiting for Delete Transcript ### [​](https://docs.fireflies.ai/getting-started/whats-new#rate-limiting-for-delete-transcript) Rate Limiting for Delete Transcript The [Delete Transcript](https://docs.fireflies.ai/graphql-api/mutation/delete-transcript) mutation now includes rate limiting protection to prevent abuse. The mutation is limited to 10 requests per minute across all user tiers.If you exceed this limit, the API will return a `too_many_requests` error (HTTP 429) with a `retryAfter` timestamp indicating when you can make requests again. [​](https://docs.fireflies.ai/getting-started/whats-new#2-12-0) 2.12.0 Meeting Privacy Control ### [​](https://docs.fireflies.ai/getting-started/whats-new#meeting-privacy-control) Meeting Privacy Control The new [Update Meeting Privacy](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy) mutation allows meeting owners and team administrators to programmatically update meeting privacy settings. You can now change privacy levels between `link`, `owner`, `participants`, `teammatesandparticipants`, and `teammates` to control who can access meeting transcripts.This mutation follows the same authorization pattern as other meeting management operations, requiring either meeting ownership or team admin privileges. [​](https://docs.fireflies.ai/getting-started/whats-new#2-10-0) 2.10.0 Meeting Attendance Tracking ### [​](https://docs.fireflies.ai/getting-started/whats-new#meeting-attendance-tracking) Meeting Attendance Tracking The [Transcript](https://docs.fireflies.ai/schema/transcript) schema now includes a new `meeting_attendance` field that provides detailed participant attendance information. This field returns an array of [MeetingAttendance](https://docs.fireflies.ai/schema/meeting-attendance) records showing when participants joined and left the meeting.Each attendance record includes the participant’s name, join time (ISO 8601 format), and leave time (if they left during the meeting). This feature enables better meeting analytics and participation tracking by leveraging meeting events data.The attendance data is available in both [Transcript](https://docs.fireflies.ai/graphql-api/query/transcript) and [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) queries. [​](https://docs.fireflies.ai/getting-started/whats-new#2-9-0) 2.9.0 Channel Filtering ### [​](https://docs.fireflies.ai/getting-started/whats-new#channel-filtering) Channel Filtering The [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) query now supports filtering by channel using the new `channel_id` parameter. This allows you to retrieve transcripts from specific channels by providing a single channel ID.The `channel_id` parameter accepts a string value and enables more targeted querying of meeting transcripts within your organization’s channels. [​](https://docs.fireflies.ai/getting-started/whats-new#2-8-0) 2.8.0 Array Fields for Organizers and Participants ### [​](https://docs.fireflies.ai/getting-started/whats-new#array-fields-for-organizers-and-participants) Array Fields for Organizers and Participants The [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) query now supports array fields `organizers` and `participants` that allow filtering by multiple email addresses. These new array fields provide more flexible querying capabilities while maintaining backward compatibility.The previous single email fields `organizer_email` and `participant_email` are now deprecated but continue to work. Using both old and new fields simultaneously will result in a validation error. [​](https://docs.fireflies.ai/getting-started/whats-new#2-7-0) 2.7.0 User Groups ### [​](https://docs.fireflies.ai/getting-started/whats-new#user-groups) User Groups The Fireflies API now includes comprehensive support for user groups. The new [User Groups](https://docs.fireflies.ai/graphql-api/query/user-groups) query allows you to fetch all user groups within your team or filter to only show groups you belong to using the `mine` parameter.Additionally, the [User](https://docs.fireflies.ai/schema/user) and [Users](https://docs.fireflies.ai/graphql-api/query/users) queries now include enhanced `user_groups` fields with detailed member information, providing better visibility into team organization and collaboration. [​](https://docs.fireflies.ai/getting-started/whats-new#2-6-2) 2.6.2 Keyword search ### [​](https://docs.fireflies.ai/getting-started/whats-new#keyword-search) Keyword Search The [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) query has been enhanced to include keyword search functionality. By utilizing the `keyword` and `scope` parameters, you can now perform advanced searches within both the title and the transcript text, offering more precise retrieval.The `title` parameter has been deprecated in favor of `keyword` [​](https://docs.fireflies.ai/getting-started/whats-new#2-6-1) 2.6.1 Upload audio ### [​](https://docs.fireflies.ai/getting-started/whats-new#enhancements-to-audio-upload) Enhancements to Audio Upload The [Upload Audio](https://docs.fireflies.ai/graphql-api/mutation/upload-audio) function now includes a `bypass_size_check` flag. This enhancement provides greater control over filtering unwanted uploads, such as voicemails from dialers. [​](https://docs.fireflies.ai/getting-started/whats-new#2-6-0) 2.6.0 Realtime API ### [​](https://docs.fireflies.ai/getting-started/whats-new#realtime-api) Realtime API The Fireflies.ai [Realtime API](https://docs.fireflies.ai/realtime-api/overview) allows your application to receive live transcription events over WebSockets. This enables building interactive features such as live captioning, transcription overlays, and real-time analysis as users speak. Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/getting-started/whats-new.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/getting-started/whats-new) [LLM-based Development](https://docs.fireflies.ai/getting-started/llm-development) [General concepts](https://docs.fireflies.ai/fundamentals/concepts) ⌘I --- # Error codes - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/miscellaneous/error-codes#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Miscellaneous Error codes On this page * [Overview](https://docs.fireflies.ai/miscellaneous/error-codes#overview) * [API Errors](https://docs.fireflies.ai/miscellaneous/error-codes#api-errors) * [invalid\_arguments](https://docs.fireflies.ai/miscellaneous/error-codes#invalid-arguments) * [object\_not\_found](https://docs.fireflies.ai/miscellaneous/error-codes#object-not-found) * [forbidden](https://docs.fireflies.ai/miscellaneous/error-codes#forbidden) * [paid\_required](https://docs.fireflies.ai/miscellaneous/error-codes#paid-required) * [not\_in\_team](https://docs.fireflies.ai/miscellaneous/error-codes#not-in-team) * [require\_elevated\_privilege](https://docs.fireflies.ai/miscellaneous/error-codes#require-elevated-privilege) * [account\_cancelled](https://docs.fireflies.ai/miscellaneous/error-codes#account-cancelled) * [args\_required](https://docs.fireflies.ai/miscellaneous/error-codes#args-required) * [too\_many\_requests](https://docs.fireflies.ai/miscellaneous/error-codes#too-many-requests) * [payload\_too\_small](https://docs.fireflies.ai/miscellaneous/error-codes#payload-too-small) * [request\_timeout](https://docs.fireflies.ai/miscellaneous/error-codes#request-timeout) * [invalid\_language\_code](https://docs.fireflies.ai/miscellaneous/error-codes#invalid-language-code) * [admin\_must\_exist](https://docs.fireflies.ai/miscellaneous/error-codes#admin-must-exist) * [unsupported\_platform](https://docs.fireflies.ai/miscellaneous/error-codes#unsupported-platform) * [invariant\_violation](https://docs.fireflies.ai/miscellaneous/error-codes#invariant-violation) [​](https://docs.fireflies.ai/miscellaneous/error-codes#overview) Overview ----------------------------------------------------------------------------- This page lists the error codes and their corresponding reasons for the Fireflies.ai API. You can refer to this page to understand the meaning and possible causes of different error codes that you may encounter while using the API. It provides a comprehensive reference for troubleshooting and resolving issues. Please visit [Errors](https://docs.fireflies.ai/fundamentals/errors) page for more details [​](https://docs.fireflies.ai/miscellaneous/error-codes#api-errors) API Errors --------------------------------------------------------------------------------- ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#invalid-arguments) `invalid_arguments` Returned when invalid arguments are passed to a query or mutation Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "Invalid argument(s) were provided",\ "code": "invalid_arguments",\ "extensions": {\ "code": "invalid_arguments",\ "status": 400,\ "metadata": {\ "fields": [\ {\ "name": "fromDate",\ "message": "fromDate must be a Date instance",\ "constraints": [\ {\ "type": "isDate",\ "message": "fromDate must be a Date instance"\ }\ ]\ }\ ]\ }\ }\ }\ ] } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#object-not-found) `object_not_found` Returned when the subject of your query or mutation is not found. For example, querying a non-existent userId would throw an `object_not_found` error of the type `User` Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "User not found",\ "code": "object_not_found",\ "extensions": {\ "code": "object_not_found",\ "status": 404,\ "metadata": {\ "objectType": "User"\ }\ }\ }\ ], } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#forbidden) `forbidden` Returned when you are not allowed to perform an action Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "You are not authorized to perform this action",\ "code": "forbidden",\ "extensions": {\ "code": "forbidden",\ "status": 403,\ }\ }\ ] } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#paid-required) `paid_required` Returned when you are required to be subscribed to a paid plan for the Fireflies.ai platform. The error will also mentioned the required `tier` for such actions. For example, making a request to `uploadAudio` as a free user will throw a `paid_required` error with tier `pro_or_higher`, which means that you need to be subscribed to a Pro or Higher plan to perform this action Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "You need to be subscribed to a paid plan to perform this action",\ "code": "paid_required",\ "extensions": {\ "code": "paid_required",\ "status": 403,\ "metadata": {\ "tier": "pro_or_higher"\ },\ }\ }\ ] } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#not-in-team) `not_in_team` Returned when you are attempting to query against a `userId` that is not a part of your team Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "You do not have permissions for this team",\ "code": "not_in_team",\ "extensions": {\ "code": "not_in_team",\ "status": 403,\ }\ }\ ] } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#require-elevated-privilege) `require_elevated_privilege` Returned when you are attempting to perform admin actions as a non-admin user Copy Ask AI { "errors": [\ {\ .. other fields for error\ "message": "You do not have permission to perform this action",\ "code": "require_elevated_privilege",\ "extensions": {\ "code": "require_elevated_privilege",\ "status": 403,\ }\ }\ ] } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#account-cancelled) `account_cancelled` Returned when your account has been cancelled due to non-payment or some other reason. Please contact support if you think this is a mistake Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "Your account is inactive. If this is not expected, please contact support",\ "code": "account_cancelled",\ "extensions": {\ "code": "account_cancelled",\ "status": 403,\ }\ }\ ] } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#args-required) `args_required` Returned when your query or mutation is missing one or more required arguments. The property `extesions.metadata.fields` will provide the list of fields that have this constraints Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "You must provide one of the following: mine, transcript_id, my_team",\ "code": "args_required",\ "extensions": {\ "code": "args_required",\ "status": 400,\ "metadata": {\ "fields": [\ "mine",\ "transcript_id",\ "my_team"\ ]\ },\ }\ }\ ] } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#too-many-requests) `too_many_requests` Returned when you have been rate-limited due to making too many requests. The field `extensions.metadata.retryAfter` mentions the `retryAfter` time Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "Too many requests. Please retry after 2:45:45 AM (UTC)",\ "code": "too_many_requests",\ "extensions": {\ "code": "too_many_requests",\ "status": 429,\ "metadata": {\ "retryAfter": 1720651545066\ }\ }\ }\ ] } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#payload-too-small) `payload_too_small` Returned when the content size for `uploadAudio` mutation is too small. Upload files larger than `50kb` to avoid this error Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "Content size is too small. Please upload files larger than 50kb",\ "code": "payload_too_small",\ "extensions": {\ "code": "payload_too_small",\ "status": 400,\ }\ }\ ] } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#request-timeout) `request_timeout` Returned when your request has taken too long to respond. Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "Request timed out. Please try again or contact support",\ "code": "request_timeout",\ "extensions": {\ "code": "request_timeout",\ "status": 408,\ }\ }\ ] } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#invalid-language-code) `invalid_language_code` Returned when an invalid language code has been passed to a query or mutation Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "Language code is invalid or not supported. Please refer to API docs for supported languages",\ "code": "invalid_language_code",\ "extensions": {\ "code": "invalid_language_code",\ "status": 400,\ }\ }\ ] } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#admin-must-exist) `admin_must_exist` Returned when you are attempting to call `setUserRole` for a single member team Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "You must have at least one admin your team",\ "code": "admin_must_exist",\ "extensions": {\ "code": "admin_must_exist",\ "status": 400,\ }\ }\ ] } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#unsupported-platform) `unsupported_platform` Returned when an unsupported meeting platform URL is provided to the `addToLiveMeeting` mutation Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "The meeting platform is not supported. Please use a supported meeting platform URL.",\ "code": "unsupported_platform",\ "extensions": {\ "code": "unsupported_platform",\ "status": 400,\ }\ }\ ] } ### [​](https://docs.fireflies.ai/miscellaneous/error-codes#invariant-violation) `invariant_violation` Returned when an internal invariant is violated (unexpected internal state). This typically indicates a bug and is not actionable by clients. Please contact support if you receive this error. Copy Ask AI { "errors": [\ {\ ... other fields for error\ "message": "Something unexpected happened. Please try again",\ "code": "invariant_violation",\ "extensions": {\ "code": "invariant_violation",\ "status": 500,\ }\ }\ ] } Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/miscellaneous/error-codes.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/miscellaneous/error-codes) [Language codes](https://docs.fireflies.ai/miscellaneous/language-codes) [Deprecated](https://docs.fireflies.ai/additional-info/deprecated) ⌘I --- # Language codes - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/miscellaneous/language-codes#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Miscellaneous Language codes On this page * [Overview](https://docs.fireflies.ai/miscellaneous/language-codes#overview) * [References](https://docs.fireflies.ai/miscellaneous/language-codes#references) * [Codes](https://docs.fireflies.ai/miscellaneous/language-codes#codes) [​](https://docs.fireflies.ai/miscellaneous/language-codes#overview) Overview -------------------------------------------------------------------------------- This page lists the language codes supported by the Fireflies.ai API. You may use these codes with the `uploadAudio` or `addToLive` functionality to specify custom languages for your meetings. Each language entry includes the language name and its corresponding code, providing a quick and easy reference. [​](https://docs.fireflies.ai/miscellaneous/language-codes#references) References ------------------------------------------------------------------------------------ * [Add to Live](https://docs.fireflies.ai/graphql-api/mutation/add-to-live) * [Upload Audio](https://docs.fireflies.ai/graphql-api/mutation/upload-audio) [​](https://docs.fireflies.ai/miscellaneous/language-codes#codes) Codes -------------------------------------------------------------------------- Copy Ask AI [\ {\ "languageName": "Arabic",\ "languageCode": "ar"\ },\ {\ "languageName": "Bulgarian",\ "languageCode": "bg"\ },\ {\ "languageName": "Chinese",\ "languageCode": "zh"\ },\ {\ "languageName": "Croatian",\ "languageCode": "hr"\ },\ {\ "languageName": "Czech",\ "languageCode": "cs"\ },\ {\ "languageName": "Danish",\ "languageCode": "da"\ },\ {\ "languageName": "Dutch",\ "languageCode": "nl"\ },\ {\ "languageName": "English",\ "languageCode": "en"\ },\ {\ "languageName": "US English",\ "languageCode": "en-US"\ },\ {\ "languageName": "Australia English",\ "languageCode": "en-AU"\ },\ {\ "languageName": "UK English",\ "languageCode": "en-GB"\ },\ {\ "languageName": "Finnish",\ "languageCode": "fi"\ },\ {\ "languageName": "French",\ "languageCode": "fr"\ },\ {\ "languageName": "German",\ "languageCode": "de"\ },\ {\ "languageName": "Hebrew",\ "languageCode": "he"\ },\ {\ "languageName": "Hindi",\ "languageCode": "hi"\ },\ {\ "languageName": "Hungarian",\ "languageCode": "hu"\ },\ {\ "languageName": "Indonesian",\ "languageCode": "id"\ },\ {\ "languageName": "Italian",\ "languageCode": "it"\ },\ {\ "languageName": "Japanese",\ "languageCode": "ja"\ },\ {\ "languageName": "Korean",\ "languageCode": "ko"\ },\ {\ "languageName": "Malay",\ "languageCode": "ms"\ },\ {\ "languageName": "Norwegian",\ "languageCode": "no"\ },\ {\ "languageName": "Polish",\ "languageCode": "pl"\ },\ {\ "languageName": "Portuguese",\ "languageCode": "pt"\ },\ {\ "languageName": "Romanian",\ "languageCode": "ro"\ },\ {\ "languageName": "Russian",\ "languageCode": "ru"\ },\ {\ "languageName": "Slovak",\ "languageCode": "sk"\ },\ {\ "languageName": "Spanish",\ "languageCode": "es"\ },\ {\ "languageName": "Latin American Spanish",\ "languageCode": "es-419"\ },\ {\ "languageName": "Swedish",\ "languageCode": "sv"\ },\ {\ "languageName": "Tamil",\ "languageCode": "ta"\ },\ {\ "languageName": "Thai",\ "languageCode": "th"\ },\ {\ "languageName": "Filipino",\ "languageCode": "tl"\ },\ {\ "languageName": "Turkish",\ "languageCode": "tr"\ },\ {\ "languageName": "Ukrainian",\ "languageCode": "uk"\ },\ {\ "languageName": "Vietnamese",\ "languageCode": "vi"\ }\ ] Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/miscellaneous/language-codes.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/miscellaneous/language-codes) [UpdateMeetingPrivacyInput](https://docs.fireflies.ai/schema/input/update-meeting-privacy-input) [Error codes](https://docs.fireflies.ai/miscellaneous/error-codes) ⌘I --- # Changelog - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/additional-info/change-log#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Additional Info Changelog On this page * [Overview](https://docs.fireflies.ai/additional-info/change-log#overview) * [2.13.0](https://docs.fireflies.ai/additional-info/change-log#2-13-0) * [2.12.0](https://docs.fireflies.ai/additional-info/change-log#2-12-0) * [2.11.0](https://docs.fireflies.ai/additional-info/change-log#2-11-0) * [2.10.0](https://docs.fireflies.ai/additional-info/change-log#2-10-0) * [2.9.0](https://docs.fireflies.ai/additional-info/change-log#2-9-0) * [2.8.0](https://docs.fireflies.ai/additional-info/change-log#2-8-0) * [2.7.1](https://docs.fireflies.ai/additional-info/change-log#2-7-1) * [2.7.0](https://docs.fireflies.ai/additional-info/change-log#2-7-0) * [2.6.3](https://docs.fireflies.ai/additional-info/change-log#2-6-3) * [2.6.2](https://docs.fireflies.ai/additional-info/change-log#2-6-2) * [2.6.1](https://docs.fireflies.ai/additional-info/change-log#2-6-1) * [2.6.0](https://docs.fireflies.ai/additional-info/change-log#2-6-0) * [2.5.1](https://docs.fireflies.ai/additional-info/change-log#2-5-1) * [2.5.0](https://docs.fireflies.ai/additional-info/change-log#2-5-0) * [2.4.6](https://docs.fireflies.ai/additional-info/change-log#2-4-6) * [2.4.5](https://docs.fireflies.ai/additional-info/change-log#2-4-5) * [2.4.4](https://docs.fireflies.ai/additional-info/change-log#2-4-4) * [2.4.3](https://docs.fireflies.ai/additional-info/change-log#2-4-3) * [2.4.2](https://docs.fireflies.ai/additional-info/change-log#2-4-2) * [2.4.1](https://docs.fireflies.ai/additional-info/change-log#2-4-1) * [2.4.0](https://docs.fireflies.ai/additional-info/change-log#2-4-0) * [2.3.17](https://docs.fireflies.ai/additional-info/change-log#2-3-17) * [2.3.16](https://docs.fireflies.ai/additional-info/change-log#2-3-16) * [2.3.15](https://docs.fireflies.ai/additional-info/change-log#2-3-15) * [2.3.14](https://docs.fireflies.ai/additional-info/change-log#2-3-14) * [2.3.13](https://docs.fireflies.ai/additional-info/change-log#2-3-13) * [2.3.12](https://docs.fireflies.ai/additional-info/change-log#2-3-12) * [2.3.11](https://docs.fireflies.ai/additional-info/change-log#2-3-11) * [2.3.10](https://docs.fireflies.ai/additional-info/change-log#2-3-10) * [2.3.9](https://docs.fireflies.ai/additional-info/change-log#2-3-9) * [2.3.8](https://docs.fireflies.ai/additional-info/change-log#2-3-8) * [2.3.7](https://docs.fireflies.ai/additional-info/change-log#2-3-7) * [2.3.6](https://docs.fireflies.ai/additional-info/change-log#2-3-6) * [2.3.5](https://docs.fireflies.ai/additional-info/change-log#2-3-5) * [2.3.4](https://docs.fireflies.ai/additional-info/change-log#2-3-4) * [2.3.3](https://docs.fireflies.ai/additional-info/change-log#2-3-3) * [2.3.2](https://docs.fireflies.ai/additional-info/change-log#2-3-2) * [2.3.1](https://docs.fireflies.ai/additional-info/change-log#2-3-1) * [2.3.0](https://docs.fireflies.ai/additional-info/change-log#2-3-0) * [2.2.0](https://docs.fireflies.ai/additional-info/change-log#2-2-0) * [2.1.1](https://docs.fireflies.ai/additional-info/change-log#2-1-1) * [2.1.0](https://docs.fireflies.ai/additional-info/change-log#2-1-0) * [2.0.7](https://docs.fireflies.ai/additional-info/change-log#2-0-7) * [2.0.6](https://docs.fireflies.ai/additional-info/change-log#2-0-6) * [2.0.5](https://docs.fireflies.ai/additional-info/change-log#2-0-5) * [2.0.4](https://docs.fireflies.ai/additional-info/change-log#2-0-4) * [2.0.3](https://docs.fireflies.ai/additional-info/change-log#2-0-3) * [2.0.2](https://docs.fireflies.ai/additional-info/change-log#2-0-2) * [2.0.1](https://docs.fireflies.ai/additional-info/change-log#2-0-1) * [2.0.0](https://docs.fireflies.ai/additional-info/change-log#2-0-0) [​](https://docs.fireflies.ai/additional-info/change-log#overview) Overview ------------------------------------------------------------------------------ This document maintains a chronologically ordered list of notable changes for each version of the Fireflies API. It’s designed to make it easier for you to keep track of new features, improvements, and bug fixes. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-13-0) 2.13.0 Added rate limiting to the `deleteTranscript` mutation. It is limited to 10 requests per minute across all user tiers. When exceeded, the API returns HTTP 429 `too_many_requests`. See [Delete Transcript](https://docs.fireflies.ai/graphql-api/mutation/delete-transcript) . ### [​](https://docs.fireflies.ai/additional-info/change-log#2-12-0) 2.12.0 Added `updateMeetingPrivacy` mutation to update meeting privacy settings. Allows meeting owners and team admins to change privacy levels between link, owner, participants, teammatesandparticipants, and teammates. See [Update Meeting Privacy](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy) . ### [​](https://docs.fireflies.ai/additional-info/change-log#2-11-0) 2.11.0 Added `channels` field to [Transcript](https://docs.fireflies.ai/schema/transcript) schema. Returns an array of [Channel](https://docs.fireflies.ai/schema/channel) objects containing channel IDs associated with the meeting. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-10-0) 2.10.0 Added new `meeting_attendance` field to [Transcript](https://docs.fireflies.ai/schema/transcript) schema providing participant join and leave times from meeting events data. Added new [MeetingAttendance](https://docs.fireflies.ai/schema/meeting-attendance) schema with `name`, `join_time`, and `leave_time` fields for tracking participant attendance. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-9-0) 2.9.0 Added `channel_id` parameter to [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) query to filter meetings by specific channel. Accepts a single channel ID string. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-8-0) 2.8.0 Added array fields `organizers` and `participants` to [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) query for filtering by multiple email addresses. Previous single email fields `organizer_email` and `participant_email` are now deprecated. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-7-1) 2.7.1 Added validation for [Add to Live](https://docs.fireflies.ai/graphql-api/mutation/add-to-live) to only allow supported meeting platforms as `meeting_link`.Added new error type [UnsupportedPlatform](https://docs.fireflies.ai/miscellaneous/error-codes#unsupported-platform) that is thrown when an unsupported `meeting_link` is provided to `Add to Live`. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-7-0) 2.7.0 Added new `user_groups` query to fetch user groups with optional `mine` filter. See [User Groups](https://docs.fireflies.ai/graphql-api/query/user-groups) Enhanced [UserGroup](https://docs.fireflies.ai/schema/user-groups) schema with `members` field Added new [UserGroupMember](https://docs.fireflies.ai/schema/user-group-member) schema for user group member details ### [​](https://docs.fireflies.ai/additional-info/change-log#2-6-3) 2.6.3 Made improvements to the performance and stability of the Fireflies API. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-6-2) 2.6.2 Updated `transcripts` query to allow text search within meeting transcript (/query/transcripts)\[Transcripts\] ### [​](https://docs.fireflies.ai/additional-info/change-log#2-6-1) 2.6.1 Updated `uploadAudio` mutation to include `bypass_size_check` boolean, allowing processing of audio files smaller than the standard 50kb minimum size. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-6-0) 2.6.0 Added [Realtime API](https://docs.fireflies.ai/realtime-api/overview) support. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-5-1) 2.5.1 Added `user_groups` field to [User](https://docs.fireflies.ai/schema/user) query. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-5-0) 2.5.0 Added query `analytics` to query team and user analytics for meetings and conversations. See [Analytics](https://docs.fireflies.ai/graphql-api/analytics) Added query `transcript.analytics` to query analytics per meeting. See [Transcript](https://docs.fireflies.ai/graphql-api/transcript) or [Transcripts](https://docs.fireflies.ai/graphql-api/transcripts) ### [​](https://docs.fireflies.ai/additional-info/change-log#2-4-6) 2.4.6 Fixed bug in `transcripts.title` query not returning correct results ### [​](https://docs.fireflies.ai/additional-info/change-log#2-4-5) 2.4.5 Reduced the minimum file size for `uploadAudio` mutation to 50kb. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-4-4) 2.4.4 Field `client_reference_id` in [AudioUpload](https://docs.fireflies.ai/graphql-api/mutation/upload-audio) was limited to 32 characters as part of input validation. It has now been increased to 128 characters. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-4-3) 2.4.3 Added length validation for all input fields. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-4-2) 2.4.2 Added `updateMeetingTitle` mutation to update meeting titles. For more details, view [Update Meeting Title](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-title) ### [​](https://docs.fireflies.ai/additional-info/change-log#2-4-1) 2.4.1 Made improvements to the performance and stability of the Fireflies API. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-4-0) 2.4.0 Added `mine` field to [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) query Added breaking changes to [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) query that allows you to only use one of the following fields: `organizer_email`, `participant_email`, `user_id`, `mine` at a time ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-17) 2.3.17 Added `meeting_link` field to [Transcript](https://docs.fireflies.ai/schema/transcript) schema ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-16) 2.3.16 Added `apps` query to fetch AI App Outputs. For more details, view [Apps](https://docs.fireflies.ai/graphql-api/query/apps) ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-15) 2.3.15 Fixed bug in `transcripts` query where it was not returning the correct match. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-14) 2.3.14 Added support for webhook auth. For more details, view the [Webhooks](https://docs.fireflies.ai/graphql-api/webhooks) page ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-13) 2.3.13 Added new fields to summary to [Summary](https://docs.fireflies.ai/schema/summary) schema ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-12) 2.3.12 Added fields `cal_id` and `calendar_type` to [Transcript](https://docs.fireflies.ai/schema/transcript) schema ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-11) 2.3.11 Fixed bug in `transcript.sentences` query where it was incorrectly returning null Made improvements to the performance and stability of the Fireflies API. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-10) 2.3.10 Added field `attendees` to [addToLive](https://docs.fireflies.ai/graphql-api/mutation/add-to-live) mutation ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-9) 2.3.9 Added field `meeting_info` for meeting metadata. Updated `uploadAudio` mutation to allow saving video ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-8) 2.3.8 Added field `speakers` in transcript. Updated docs to include error codes and their explanations. View details [here](https://docs.fireflies.ai/miscellaneous/error-codes) ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-7) 2.3.7 Added new fields for `transcript.summary`. View details on the [Summary](https://docs.fireflies.ai/schema/summary) schema page ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-6) 2.3.6 Updated docs for webhooks to include webhook schema Added `client_reference_id` field for audio upload ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-5) 2.3.5 Added argument `custom_language` for `uploadAudio`. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-4) 2.3.4 Added query argument `fromDate` and `toDate` for `transcripts`. View more details [here](https://docs.fireflies.ai/graphql-api/query/transcripts) . Field `date` has been deprecated in favor of these arguments ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-3) 2.3.3 Added mutation for `addToLiveMeeting`. View more details [here](https://docs.fireflies.ai/graphql-api/mutation/add-to-live) ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-2) 2.3.2 Made improvements to the performance and stability of the Fireflies API. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-1) 2.3.1 Added field `calendar_id`. This field represents calId for google calendar and iCalUID for outlook calendar. For more details, view [Transcript](https://docs.fireflies.ai/schema/transcript) ### [​](https://docs.fireflies.ai/additional-info/change-log#2-3-0) 2.3.0 Added queries for [Transcript Summary](https://docs.fireflies.ai/schema/summary) . For more details, view [Summary](https://docs.fireflies.ai/schema/summary) schema and [Transcript](https://docs.fireflies.ai/schema/transcript) schema ### [​](https://docs.fireflies.ai/additional-info/change-log#2-2-0) 2.2.0 Added queries for [bites](https://docs.fireflies.ai/graphql-api/query/bites) and [bite](https://docs.fireflies.ai/graphql-api/query/bite) . For more details, view [Bites](https://docs.fireflies.ai/schema/bite) schema Added mutation for Create Bite that allows you to progmatically create bites. For more details, view [CreateBite](https://docs.fireflies.ai/graphql-api/mutation/create-bite) mutation ### [​](https://docs.fireflies.ai/additional-info/change-log#2-1-1) 2.1.1 Fixed bugs in [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) query ### [​](https://docs.fireflies.ai/additional-info/change-log#2-1-0) 2.1.0 Added `video_url` field for [Transcript](https://docs.fireflies.ai/additional-info/schema/transcript) schema ### [​](https://docs.fireflies.ai/additional-info/change-log#2-0-7) 2.0.7 Made improvements to the performance and stability of the Fireflies API. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-0-6) 2.0.6 Made improvements to the performance and stability of the Fireflies API. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-0-5) 2.0.5 Fixed bug in in [Transcripts](https://docs.fireflies.ai/additional-info/graphql-api/query/transcripts) query for `fireflies_users` field ### [​](https://docs.fireflies.ai/additional-info/change-log#2-0-4) 2.0.4 Fixed bug in in [Transcripts](https://docs.fireflies.ai/additional-info/graphql-api/query/transcripts) query for `audio_url` field ### [​](https://docs.fireflies.ai/additional-info/change-log#2-0-3) 2.0.3 Made improvements to the performance and stability of the Fireflies API. ### [​](https://docs.fireflies.ai/additional-info/change-log#2-0-2) 2.0.2 Fixed bug in [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) query arguments ### [​](https://docs.fireflies.ai/additional-info/change-log#2-0-1) 2.0.1 Fixed schema inconsistency in [AudioUpload](https://docs.fireflies.ai/graphql-api/mutation/upload-audio) mutation. Fixed schema inconsistency in [SetUserRole](https://docs.fireflies.ai/graphql-api/mutation/set-user-role) mutation ### [​](https://docs.fireflies.ai/additional-info/change-log#2-0-0) 2.0.0 Field `transcript/host_email` has been deprecated. More details in [Transcript](https://docs.fireflies.ai/schema/transcript) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/additional-info/change-log.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/additional-info/change-log) [Deprecated](https://docs.fireflies.ai/additional-info/deprecated) ⌘I --- # Unknown \# Changelog Source: https://docs.fireflies.ai/additional-info/change-log Recent updates to the Fireflies API ## Overview This document maintains a chronologically ordered list of notable changes for each version of the Fireflies API. It's designed to make it easier for you to keep track of new features, improvements, and bug fixes. ### 2.13.0 Added rate limiting to the \`deleteTranscript\` mutation. It is limited to 10 requests per minute across all user tiers. When exceeded, the API returns HTTP 429 \`too\_many\_requests\`. See \[Delete Transcript\](/graphql-api/mutation/delete-transcript). \### 2.12.0 Added \`updateMeetingPrivacy\` mutation to update meeting privacy settings. Allows meeting owners and team admins to change privacy levels between link, owner, participants, teammatesandparticipants, and teammates. See \[Update Meeting Privacy\](/graphql-api/mutation/update-meeting-privacy). \### 2.11.0 Added \`channels\` field to \[Transcript\](/schema/transcript) schema. Returns an array of \[Channel\](/schema/channel) objects containing channel IDs associated with the meeting. \### 2.10.0 Added new \`meeting\_attendance\` field to \[Transcript\](/schema/transcript) schema providing participant join and leave times from meeting events data. Added new \[MeetingAttendance\](/schema/meeting-attendance) schema with \`name\`, \`join\_time\`, and \`leave\_time\` fields for tracking participant attendance. \### 2.9.0 Added \`channel\_id\` parameter to \[Transcripts\](/graphql-api/query/transcripts) query to filter meetings by specific channel. Accepts a single channel ID string. \### 2.8.0 Added array fields \`organizers\` and \`participants\` to \[Transcripts\](/graphql-api/query/transcripts) query for filtering by multiple email addresses. Previous single email fields \`organizer\_email\` and \`participant\_email\` are now deprecated. \### 2.7.1 Added validation for \[Add to Live\](/graphql-api/mutation/add-to-live) to only allow supported meeting platforms as \`meeting\_link\`. Added new error type \[UnsupportedPlatform\](/miscellaneous/error-codes#unsupported-platform) that is thrown when an unsupported \`meeting\_link\` is provided to \`Add to Live\`. \### 2.7.0 Added new \`user\_groups\` query to fetch user groups with optional \`mine\` filter. See \[User Groups\](/graphql-api/query/user-groups) Enhanced \[UserGroup\](/schema/user-groups) schema with \`members\` field Added new \[UserGroupMember\](/schema/user-group-member) schema for user group member details ### 2.6.3 Made improvements to the performance and stability of the Fireflies API. ### 2.6.2 Updated \`transcripts\` query to allow text search within meeting transcript (/query/transcripts)\\\[Transcripts\] \### 2.6.1 Updated \`uploadAudio\` mutation to include \`bypass\_size\_check\` boolean, allowing processing of audio files smaller than the standard 50kb minimum size. \### 2.6.0 Added \[Realtime API\](/realtime-api/overview) support. ### 2.5.1 Added \`user\_groups\` field to \[User\](/schema/user) query. ### 2.5.0 Added query \`analytics\` to query team and user analytics for meetings and conversations. See \[Analytics\](/graphql-api/analytics) Added query \`transcript.analytics\` to query analytics per meeting. See \[Transcript\](/graphql-api/transcript) or \[Transcripts\](/graphql-api/transcripts) \### 2.4.6 Fixed bug in \`transcripts.title\` query not returning correct results ### 2.4.5 Reduced the minimum file size for \`uploadAudio\` mutation to 50kb. ### 2.4.4 Field \`client\_reference\_id\` in \[AudioUpload\](/graphql-api/mutation/upload-audio) was limited to 32 characters as part of input validation. It has now been increased to 128 characters. \### 2.4.3 Added length validation for all input fields. ### 2.4.2 Added \`updateMeetingTitle\` mutation to update meeting titles. For more details, view \[Update Meeting Title\](/graphql-api/mutation/update-meeting-title) \### 2.4.1 Made improvements to the performance and stability of the Fireflies API. ### 2.4.0 Added \`mine\` field to \[Transcripts\](/graphql-api/query/transcripts) query Added breaking changes to \[Transcripts\](/graphql-api/query/transcripts) query that allows you to only use one of the following fields: \`organizer\_email\`, \`participant\_email\`, \`user\_id\`, \`mine\` at a time \### 2.3.17 Added \`meeting\_link\` field to \[Transcript\](/schema/transcript) schema ### 2.3.16 Added \`apps\` query to fetch AI App Outputs. For more details, view \[Apps\](/graphql-api/query/apps) \### 2.3.15 Fixed bug in \`transcripts\` query where it was not returning the correct match. ### 2.3.14 Added support for webhook auth. For more details, view the \[Webhooks\](/graphql-api/webhooks) page \### 2.3.13 Added new fields to summary to \[Summary\](/schema/summary) schema ### 2.3.12 Added fields \`cal\_id\` and \`calendar\_type\` to \[Transcript\](/schema/transcript) schema ### 2.3.11 Fixed bug in \`transcript.sentences\` query where it was incorrectly returning null Made improvements to the performance and stability of the Fireflies API. ### 2.3.10 Added field \`attendees\` to \[addToLive\](/graphql-api/mutation/add-to-live) mutation ### 2.3.9 Added field \`meeting\_info\` for meeting metadata. Updated \`uploadAudio\` mutation to allow saving video ### 2.3.8 Added field \`speakers\` in transcript. Updated docs to include error codes and their explanations. View details \[here\](/miscellaneous/error-codes) \### 2.3.7 Added new fields for \`transcript.summary\`. View details on the \[Summary\](/schema/summary) schema page \### 2.3.6 Updated docs for webhooks to include webhook schema Added \`client\_reference\_id\` field for audio upload ### 2.3.5 Added argument \`custom\_language\` for \`uploadAudio\`. ### 2.3.4 Added query argument \`fromDate\` and \`toDate\` for \`transcripts\`. View more details \[here\](/graphql-api/query/transcripts). Field \`date\` has been deprecated in favor of these arguments \### 2.3.3 Added mutation for \`addToLiveMeeting\`. View more details \[here\](/graphql-api/mutation/add-to-live) \### 2.3.2 Made improvements to the performance and stability of the Fireflies API. ### 2.3.1 Added field \`calendar\_id\`. This field represents calId for google calendar and iCalUID for outlook calendar. For more details, view \[Transcript\](/schema/transcript) \### 2.3.0 Added queries for \[Transcript Summary\](/schema/summary). For more details, view \[Summary\](/schema/summary) schema and \[Transcript\](/schema/transcript) schema \### 2.2.0 Added queries for \[bites\](/graphql-api/query/bites) and \[bite\](/graphql-api/query/bite). For more details, view \[Bites\](/schema/bite) schema Added mutation for Create Bite that allows you to progmatically create bites. For more details, view \[CreateBite\](/graphql-api/mutation/create-bite) mutation \### 2.1.1 Fixed bugs in \[Transcripts\](/graphql-api/query/transcripts) query ### 2.1.0 Added \`video\_url\` field for \[Transcript\](schema/transcript) schema ### 2.0.7 Made improvements to the performance and stability of the Fireflies API. ### 2.0.6 Made improvements to the performance and stability of the Fireflies API. ### 2.0.5 Fixed bug in in \[Transcripts\](graphql-api/query/transcripts) query for \`fireflies\_users\` field \### 2.0.4 Fixed bug in in \[Transcripts\](graphql-api/query/transcripts) query for \`audio\_url\` field \### 2.0.3 Made improvements to the performance and stability of the Fireflies API. ### 2.0.2 Fixed bug in \[Transcripts\](/graphql-api/query/transcripts) query arguments ### 2.0.1 Fixed schema inconsistency in \[AudioUpload\](/graphql-api/mutation/upload-audio) mutation. Fixed schema inconsistency in \[SetUserRole\](/graphql-api/mutation/set-user-role) mutation \### 2.0.0 Field \`transcript/host\_email\` has been deprecated. More details in \[Transcript\](/schema/transcript) \# Deprecated Source: https://docs.fireflies.ai/additional-info/deprecated Fields marked for removal ## Overview This page lists all the fields that have been deprecated. Deprecated fields are fields that are no longer recommended for use and may be removed in future versions. Please note that using deprecated fields can lead to compatibility issues in future releases. The following fields have been deprecated: ### \[Transcript\](/schema/transcript) \`host\_email\`: Use \`organizer\_email\` instead. ### \[Transcripts\](/graphql-api/query/transcripts) \`date\`: Use \`fromDate\` and \`toDate\` to query a time range. \`title\`: Use \`keyword\` and \`scope\` instead of \`title\` \`organizer\_email\`: Use the \`organizers\` array field to filter by one or more organizer email addresses. \`participant\_email\`: Use the \`participants\` array field to filter by one or more participant email addresses. # Advanced Source: https://docs.fireflies.ai/examples/advanced Library of advanced usage examples ## Overview Explore advanced usage examples that build on top of the Fireflies.ai API. This page is regularly updated ### \[Find questions from external participants\](https://replit.com/@firefliesai/Firefliesai-Find-questions-from-external-participants?v=1) This replit allows you to query questions asked by participants who do not belong to your organization. It can be useful in deriving insights and analysis for client calls, interviews, etc. ### \[Fetch meetings from multiple users\](https://replit.com/@firefliesai/Firefliesai-Fetch-meetings-for-multiple-users?v=1) This replit allows you to fetch meetings from multiple users by providing it a list of API keys. Please read our privacy policy and terms of usage for more details ### \[Verify webhook requests\](https://replit.com/@firefliesai/Firefliesai-Verifying-webhook-requests?v=1) This replit allows you to verify webhook requests by checking the signature and the payload. ## Fireflies.ai Replit Explore the complete list of usage examples at \[replit.com/@firefliesai\](https://replit.com/@firefliesai) ## Additional Resources Basic usage examples Create notifications using webhooks \# Basic Source: https://docs.fireflies.ai/examples/basic Library of basic usage examples ## Overview Explore basic usage examples for the Fireflies.ai API to get you started quickly. These basic usage examples simplify interact with the API through Javascript code. ## Basic examples Basic examples that allow you to perform basic operations with the Fireflies.ai API, like fetching transcripts or setting user role. 1. \[Create soundbite from meeting\](https://replit.com/@firefliesai/Firefliesai-Create-soundbite-from-a-meeting?v=1) 2. \[Set user role\](https://replit.com/@firefliesai/Firefliesai-Set-user-role?v=1) 3. \[Upload audio\](https://replit.com/@firefliesai/Firefliesai-Upload-audio?v=1) 4. \[Download meeting video\](https://replit.com/@firefliesai/Firefliesai-Download-video-from-meeting?v=1) 5. \[Get audio/video url\](https://replit.com/@firefliesai/Firefliesai-Get-audiovideo-url?v=1) 6. \[Get transcript summary\](https://replit.com/@firefliesai/Firefliesai-Get-transcript-summary-from-a-meeting?v=1) ## Fireflies.ai Replit Explore the complete list of usage examples at \[replit.com/@firefliesai\](https://replit.com/@firefliesai) ## Additional Resources Advanced usage examples Make your first request in under 5 minutes \# Overview Source: https://docs.fireflies.ai/examples/overview Library of API usecases ## Overview This part of the documentation is designed to provide developers with practical insights into integrating and maximizing the Fireflies.ai API in various applications. By visiting our Replit page at Fireflies.ai on Replit, you can directly access and interact with these examples, making your learning process interactive and engaging. ## Fireflies.ai Replit Explore a wide array of examples where we have created code snippets that allows you to interact with the Fireflies API. To view, please visit \[replit.com/@firefliesai\](https://replit.com/@firefliesai) You can also view the list of examples at the links \[Basic examples\](/examples/basic) and \[Advanced examples\](/examples/advanced) ## Additional Resources Basic usage examples Advanced usage examples \# Authorization Source: https://docs.fireflies.ai/fundamentals/authorization Authenticating your requests with the Fireflies API ## Overview The Fireflies API implements token-based authentication, which ensures that only authorized users can access certain data and functionalities. ### Token-Based Authentication We use a standard bearer token authentication mechanism. This means that to make authorized requests to the API, you must include an \`Authorization\` header with a valid token. ### Acquiring a Token Follow these steps to obtain your API key for the Fireflies API: 1. Log in to your account at \[fireflies.ai\](https://app.fireflies.ai) 2. Navigate to the \[Integrations\](https://app.fireflies.ai/integrations) section 3. Click on \[Fireflies API\](https://app.fireflies.ai/integrations/custom/fireflies) 4. Copy and store your API key securely ### Making an Authenticated Request To make an authenticated request, add the \`Authorization\` header followed by the word \`Bearer\` and your API key. ### Example of an Authenticated Request Header \`\`\`plaintext theme={null} Authorization: Bearer your\_api\_key \`\`\` ### Example request with Authorization header \`\`\`curl curl theme={null} curl \\ -X POST \\ -H "Content-Type: application/json" \\ -H "Authorization: Bearer your\_api\_key" \\ --data '{ "query": "{ user { name integrations } }" }' \\ https://api.fireflies.ai/graphql \`\`\` \`\`\`javascript javascript theme={null} const axios = require('axios'); const url = 'https://api.fireflies.ai/graphql'; const headers = { 'Content-Type': 'application/json', Authorization: 'Bearer your\_api\_key' }; const data = { query: '{ user { name integrations } }' }; axios .post(url, data, { headers: headers }) .then(response => { console.log(response.data); }) .catch(error => { console.error('Error:', error); }); \`\`\` \`\`\`python python theme={null} import requests url = 'https://api.fireflies.ai/graphql' headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer your\_api\_key' } data = { 'query': '{ user { name integrations } }' } response = requests.post(url, json=data, headers=headers) print(response.json()) \`\`\` \`\`\`java java theme={null} import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.nio.charset.StandardCharsets; public class ApiRequest { public static void main(String\[\] args) { HttpClient client = HttpClient.newHttpClient(); String url = "https://api.fireflies.ai/graphql"; String json = "{\\"query\\":\\"{ user { name integrations } }\\"}"; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create(url)) .header("Content-Type", "application/json") .header("Authorization", "Bearer your\_api\_key") .POST(HttpRequest.BodyPublishers.ofString(json, StandardCharsets.UTF\_8)) .build(); client.sendAsync(request, HttpResponse.BodyHandlers.ofString()) .thenApply(HttpResponse::body) .thenAccept(System.out::println) .join(); } } \`\`\` Ensure to replace \`your\_api\_key\` with your actual API key. ## Best Practices for Token Security \* \*\*Keep it Secret:\*\* Treat your API key like a password. Never expose it in client-side code or share it publicly. \* \*\*Store Securely:\*\* Store the API key securely in your application, ideally in environment variables or secure storage solutions. Improper handling of API keys can lead to security vulnerabilities. Always ensure API keys are used and stored securely. \## Troubleshooting \* \*\*Invalid key:\*\* If you receive an error regarding an invalid API key, verify that the API key hasn't expired and that it's correctly included in the request header. \* \*\*Missing key:\*\* Ensure that the \`Authorization\` header is present in your requests requiring authentication. If you encounter issues with authentication or have questions about API key management, please contact our support team. \## FAQ This error can signal an issue in your Authorization header. Please ensure that you are including the \`Authorization\` header with the word \`Bearer\` and your API key. \## Additional Resources Make your first request in under 5 minutes Error standards for the Fireflies API \# General concepts Source: https://docs.fireflies.ai/fundamentals/concepts Foundational guide to the core aspects of the Fireflies API ## Overview This section serves as a primer on the essential features of the Fireflies API. It covers the requirements to make authenticated requests to the Fireflies API, key GraphQL concepts and a breakdown of core components like queries, mutations, schema and data types. ### Host The Fireflies API is hosted at \[https://api.fireflies.ai\](https://api.fireflies.ai) ### Authorization The Fireflies API requires a valid API key for all requests. Please see \[Authorization\](/fundamentals/authorization) for more information ## GraphQL API Concepts Welcome to our GraphQL API! GraphQL is a powerful query language designed for APIs, offering clients the ability to request exactly what they need and nothing more. ### Queries Queries are used to fetch data in GraphQL. They are akin to the \`GET\` request in REST. A basic query might look like this: Queries are read-only and won’t modify your data. \`\`\`graphql graphql theme={null} query { user(id: "1") { name email } } \`\`\` ### Mutations Mutations allow you to modify data – create, update, or delete. Mutations should be used with caution as they change server-side data. \`\`\`graphql graphql theme={null} mutation { setUserRole(user\_id: "1", role: "user") { id name } } \`\`\` ## Schema and Types ### Schema Definition The schema defines the API's capabilities, including types, queries, mutations, and more. ### Understanding GraphQL Schema The schema is a contract between client and server, defining how clients can access data. \#### Data Types \*\*Standard Types:\*\* Int, Float, String, Boolean, ID. \*\*Custom Types:\*\* Defining complex data structures. Custom types are user-defined and can include combinations of standard types. #### Best Practices 1. Optimize query performance by requesting for only necessary data. 2. Use variables in queries to enhance readability and flexibility ## Additional Resources For more in-depth information, visit \[GraphQL Documentation\](https://graphql.org/learn/). Make your first request in under 5 minutes Query generation and API exploration \# Errors Source: https://docs.fireflies.ai/fundamentals/errors Error standards for the Fireflies API ## Overview Understanding how errors are structured and returned by the Fireflies API is key to effectively handling and troubleshooting issues. This page outlines the common error format and details specific error types. ## Error schema Our GraphQL API follows a standard format for returning errors. Errors are encapsulated within an \`errors\` array in the response body. Please visit \[Error codes\](/miscellaneous/error-codes) to view explanations for error code types Description of the error Error code. \`friendly === true\` are safe to show to the frontend client. Unfriendly errors may have technical details that may not be useful to the UI layer. Contains useful metadata related to the error. Where relevant, includes field \`helpUrls\` pointing to relevant API documentation sections that explain the error and provide guidance on how to resolve it \`\`\`json Example theme={null} { "data": {}, "errors": \[ { "message": "Error description", "friendly": true, "code": "error\_code", "extensions": { "helpUrls": \[ "https://docs.fireflies.ai/miscellaneous/error-codes#error\_code" \], "code": "error\_code", "status": http\_status\_code, ... otherFields } } \] } \`\`\` ## Additional Resources Detailed error code reference Authenticating your requests with the Fireflies API \# Introspection Source: https://docs.fireflies.ai/fundamentals/introspection Query generation and API exploration. ## Overview Introspection is a feature that allows querying a GraphQL server to discover its schema. This capability is crucial for developers to understand available queries, mutations, and the structure of the data they can work with, facilitating seamless API interaction and exploration. ### Requirements You will need a Fireflies.ai API key to use introspection. For more details, please visit \[Authorization\](/fundamentals/authorization#acquiring-a-token) ### Introspection using Apollo Sandbox For introspection using our builtin Apollo Sandbox, visit \[api.fireflies.ai/graphql\](https://api.fireflies.ai/graphql) and enter your \`api\_key\` in the Headers section as a Bearer token ### Introspection using Postman Create a new Graphql Request in Postman with the url \[api.fireflies.ai/graphql\](https://api.fireflies.ai/graphql) and enter your \`api\_key\` in the Headers section as a Bearer token ## Additional Resources Foundational guide to the core aspects of the Fireflies API Authenticating your requests with the Fireflies API \# Limits Source: https://docs.fireflies.ai/fundamentals/limits File size and API rate limits for the Fireflies API ## Overview Understanding the limitations of our API is crucial for efficient and uninterrupted usage. Below you'll find detailed information about the upload limits for different file types and the rate limits applicable to various subscription plans. ## Upload Limits The Fireflies API accommodates a range of file sizes for different user types. Here's a breakdown of the maximum file sizes for audio and video uploads: | Upload Type | Free User Limit | Pro / Business / Enterprise Limit | | ----------- | --------------- | --------------------------------- | | Audio Files | Up to 200MB | Up to 200MB | | Video Files | Up to 100MB | Up to 1.5GB | ### Understanding Upload Limits \* \*\*Audio Files:\*\* All users can upload an audio file no greater than 200MB, ensuring ample capacity for high-quality audio content. \* \*\*Video Files for Free Users:\*\* Free users have a maximum upload limit of 100MB for video files, suitable for short clips and previews. \* \*\*Video Files for Pro/Business/Enterprise Users:\*\* Higher-tier users can upload larger video files up to 1.5GB, accommodating longer and higher resolution content. ## API Rate Limits To maintain the quality of service and availability for all users, our API enforces rate limits based on the type of subscription plan. | Plan | API Rate Limit | | --------------------- | ------------------- | | Free / Pro | 50 requests per day | | Business / Enterprise | 60 requests per min | ### Add to Live API Rate Limit The Add to Live API has a rate limit of 3 requests per 20 minutes. ### Navigating API Rate Limits \* \*\*Free and Pro Plans:\*\* These plans are ideal for light to moderate usage, with a cap of 50 API requests per day. This rate is suitable for testing and small-scale applications. \* \*\*Business and Enterprise Plans:\*\* Designed for more demanding use cases, these plans allow up to 60 requests per minute, providing ample capacity for larger applications and higher volume demands. **These limits are in place to ensure optimal performance and fair usage across our platform.** \## Additional Resources Use the API to upload audio to Fireflies.ai Authenticating your requests with the Fireflies API \# Super Admin Source: https://docs.fireflies.ai/fundamentals/super-admin Fireflies Super Admin with advanced capabilities for querying your data ## Overview The Super Admin API offers advanced features such as team-wide webhooks and privacy setting bypass, providing enhanced control and flexibility for managing your data. This is only available on the enterprise tier for company admins - \[learn more\](https://guide.fireflies.ai/hc/en-us/articles/30453010621585-Learn-about-the-Super-Admin-role). ## Super Admin Webhooks The Super Admin webhook notifies you of all team meetings owned by your team, allowing you to automate workflows, integrate with other tools, and maintain an overview of your team's meetings with a single webhook. ### Setting up Super Admin Webhooks Follow the steps below to set up the Super Admin webhook: Visit the \[Fireflies.ai dashboard settings\](https://app.fireflies.ai/settings) Navigate to the Developer settings tab Enter a valid https URL in the webhooks field and save It is highly suggested to use \[webhook auth\](/graphql-api/webhooks) to secure your servers. \### Privacy Settings Bypass The Super Admin functionality allows you to bypass your team's privacy settings, allowing you to query all data in your team's account. ### Requirements Super Admin API is only available to teams on the Enterprise plan. \[Learn more here\](https://guide.fireflies.ai/hc/en-us/articles/30453010621585-Learn-about-the-Super-Admin-role) and reach out to us with questions ## Additional Resources Create notifications using webhooks Authenticating your requests with the Fireflies API \# Chat with Fireflies AI Assistant Source: https://docs.fireflies.ai/getting-started/ask-docs Navigate Fireflies.ai Documentation using the AI Assistant ## Overview Welcome to the Fireflies.ai Documentation, your essential guide to unlocking the full potential of our API. We understand that diving into a new API can be daunting, and finding the specific information you need shouldn't add to that challenge. That's why we've designed our documentation to be both comprehensive and user-friendly, ensuring you get the answers you need without the hassle. ## Explore with Fireflies AI Assistant With our AI assistant, navigating the documentation becomes as intuitive as having a conversation. Whether you're looking for detailed API endpoints, integration guides, or troubleshooting tips, our integrated AI assistant is here to assist you every step of the way. ### How to Use Fireflies AI Assistant Getting started is simple: 1. \*\*Access the Search Bar:\*\* Click on the search bar at the top of the page, or use the shortcut \`CMD + K\` (for Mac users) or \`Ctrl + K\` (for Windows and Linux users) to jump straight to it. 2. \*\*Ask Your Question:\*\* Type in your question just as you would when talking to ChatGPT. Whether it's a broad query about API capabilities or a specific request for code examples, the AI Assistant is ready to provide you with precise answers. Foundational guide to the core aspects of the Fireflies API Join the Developer Program to build integrations with Fireflies.ai \# Join the Developer Program Source: https://docs.fireflies.ai/getting-started/developer-program Join the Developer Program to build integrations with Fireflies.ai ## Overview Welcome to the Fireflies.ai Developer Program! This exclusive program offers developers a chance to explore, test, and integrate with our APIs for a limited period of three months. This program is tailored for developers eager to create seamless integrations and unlock the full capabilities of Fireflies.ai. Participants will gain access to premium features and higher rate limits, ensuring a swift and successful project development. ## Program Benefits As a member of the Fireflies.ai Developer Program, you’ll enjoy: \* \*\*Full Business Tier Access\*\*: Complimentary access to all Business Tier features, tools, and resources \* \*\*Integration Support\*\*: Get guidance on how to connect the API seamlessly with your application \* \*\*Enhanced API Access\*\*: Enjoy expanded rate limits and access to premium features designed for high-demand integrations \* \*\*Community and Updates\*\*: Be part of our developer community and receive the latest updates, tutorials, and API news ## How to Apply Interested in joining? Follow these simple steps to apply for the program: 1. \*\*Fill Out the Application Form\*\*: \[Apply here\](https://fireflies-developer.paperform.co) 2. \*\*Verification\*\*: Once you submit the form, our team will review your application. Please note that this process is manual and may take a few business days 3. \*\*Approval Notification\*\*: If your application is approved, you’ll receive a confirmation email with details about your program access ## Application Requirements To qualify for the Developer Program, please ensure you have: \* \*\*A clear project plan\*\*: Briefly describe how Fireflies.ai will integrate with your application \* \*\*A company email\*\*: A company email is preferred for verification purposes \* \*\*GitHub Repository\*\*: Optionally, include a GitHub link to your code or previous work to help us understand your technical expertise \* \*\*Additional Comments\*\*: Any additional information that can help us assess your project’s alignment with our platform goals ## Program Terms \* \*\*Duration\*\*: The complimentary Business Tier access lasts for three months from the date of approval \* \*\*Feedback\*\*: We may reach out for feedback to better understand your experience and how we can enhance our API We look forward to seeing what you’ll build and are excited to support your development journey! ## Additional Resources Welcome to Fireflies public API documentation Authenticating your requests with the Fireflies API \# Introduction Source: https://docs.fireflies.ai/getting-started/introduction Welcome to Fireflies public API documentation. We are actively working to expose more functionality via our API. If you have specific requests, please \[reach out to us\](https://guide.fireflies.ai/). \# Introduction ## Overview of the API The Fireflies API is built on top of GraphQL, a powerful interface designed to provide you with efficient and flexible access to your data. This API allows you to retrieve exactly the data you need in a structured format. Whether you are building a web application, a mobile app, or a complex software system, our API caters to a wide range of data requirements. Our API covers various functionalities, including queries for fetching data as well as uploading meeting audio. It is designed to be intuitive and easy to use, ensuring that you can start fetching and manipulating data with minimal setup. ## Advantages of Using GraphQL \*\*1. Precise Data Fetching:\*\* One of the key strengths of GraphQL is its ability to return exactly what you request and nothing more. This precision eliminates the over-fetching of data, common in traditional REST APIs, leading to more efficient network utilization and faster response times. \*\*2. Single Endpoint:\*\* Unlike REST APIs, which often require multiple endpoints for different data needs, GraphQL operates through a single endpoint. This simplification streamlines interactions with the API and makes maintaining and managing the API more straightforward. \*\*3. Flexibility and Scalability:\*\* GraphQL APIs are incredibly flexible, allowing for queries that can evolve with your needs. This flexibility, combined with efficient data retrieval, makes GraphQL an ideal choice for both small projects and large-scale applications. In the following sections, we will guide you through the essential components of our API, provide detailed examples, and offer best practices to help you make the most of our API. Whether you're a new user or an experienced developer, this documentation is designed to assist you in seamlessly integrating the API into your applications. ## Additional Resources Make your first request in under 5 minutes Foundational guide to the core aspects of the Fireflies API \# LLM-based Development Source: https://docs.fireflies.ai/getting-started/llm-development Enhance your AI coding experience with LLM readable documentation. ### Overview Welcome to the guide on utilizing our specialized \`llms.txt\` files to enhance your LLM-based coding workflow. Whether you’re using Replit, Cursor, Devin, or any other AI coding tool, this page will assist you in leveraging our resources to debug and refine code generated by Fireflies. Our platform seamlessly integrates with a variety of AI coding tools. While the generated code may not always be perfect, this guide outlines how to effectively use our \`llms.txt\` files to improve the debugging process, ensuring your development workflow remains smooth and efficient. ### How to Use \`llms.txt\` Files #### For Tools with Limited Agentic Capabilities If your coding tool does not support web querying or autonomous resource fetching: \* \*\*Download the File\*\*\\ Access the complete file by visiting \[this link\](https://docs.fireflies.ai/llms-full.txt) and download it to your local machine. \* \*\*Upload and Debug\*\*\\ Upload the downloaded file to your AI coding tool. Instruct your tool to analyze and debug the code using the content of this file. This manual intervention guides the tool in identifying and fixing errors in generated code. #### For Advanced, Agentic Coding Tools If your coding tool is sophisticated and capable of querying the web independently: \* \*\*Provide the URL Directly\*\*\\ Instead of downloading the full file, supply your tool with the URL \[https://docs.fireflies.ai/llms-full.txt\](https://docs.fireflies.ai/llms-full.txt). \* \*\*Let It Decide\*\*\\ Your advanced tool will automatically determine which parts of the file to use and where to look, streamlining the debugging process without additional manual steps. ### Additional Tips \* \*\*Tool Configuration:\*\* Ensure that your AI coding tool is configured to handle file uploads or URL-based inputs effectively. \* \*\*Experiment and Adapt:\*\* Different tools may interact with our resources in unique ways. Experiment with both methods to find the approach that best suits your workflow. \* \*\*Support and Documentation:\*\* If you encounter any challenges or need further assistance, please contact our support team. Happy coding! ## Additional Resources Connect your AI tools directly to your meeting data Foundational guide to the core aspects of the Fireflies API \# MCP Server Configuration Source: https://docs.fireflies.ai/getting-started/mcp-configuration Connect your AI tools directly to your meeting data with Fireflies MCP Server. ### Overview The Fireflies MCP Server enables AI tools to connect directly to your meeting data without switching platforms or copying transcript excerpts. This integration allows you to ask questions like "What were the main objections in this week's sales calls?" or "Create a summary of all product feedback from user interviews this month" directly from your AI coding tools. ### What is MCP? Model Context Protocol (MCP) is an open standard that enables AI applications to securely connect to external data sources and tools. With Fireflies MCP Server, your AI tools can access meeting transcripts, summaries, action items, and insights directly from your Fireflies account. ### Getting Started #### Prerequisites \* Active Fireflies.ai account \* AI tool that supports MCP (such as Claude, OpenAI Connector, Cursor, Devin, or other MCP-compatible applications) #### Installation 1. \*\*Configure your AI tool\*\* Add the Fireflies MCP server to your AI tool's configuration. The remote server URL is \[https://api.fireflies.ai/mcp\](https://api.fireflies.ai/mcp) which uses OAuth with your Fireflies account. The exact steps depend on your specific AI application. For specific AI tools, you can also configure directly through: \* \[Claude Settings\](https://claude.ai/settings/connectors) \* \[Devin MCP Marketplace\](https://app.devin.ai/settings/mcp-marketplace/setup/fireflies) 2. \*\*Use your Fireflies API key on Claude Desktop\*\* (Optional): 1. Add this config to your \`claude\_desktop\_config.json\` file: \`\`\`json theme={null} { "mcpServers": { "fireflies": { "command": "npx", "args": \[ "mcp-remote", "https://api.fireflies.ai/mcp", "--header", "Authorization: Bearer YOUR\_API\_KEY\_HERE" \] } } } \`\`\` 2. Get your API Key from Fireflies \* Go to \*\*Settings > Developer Settings\*\* and \*\*Copy your API key\*\* \* \[See how to get your API key →\](https://guide.fireflies.ai/hc/en-us/articles/360020249198-How-to-access-the-Fireflies-API-key) \* Once you have the API key, paste it in your claude\\\_desktop\\\_config.json \* Replace \`YOUR\_API\_KEY\_HERE\` with your actual API key 3. Restart Claude Desktop 3. \*\*Start querying your data\*\* Once configured, you can ask your AI tool questions about your meeting data directly. ### Use Cases \* \*\*Sales Analysis\*\*: "What were the common objections in this week's sales calls?" \* \*\*Product Feedback\*\*: "Summarize all product feedback from user interviews this month" \* \*\*Meeting Insights\*\*: "What action items were assigned to John across all meetings?" \* \*\*Trend Analysis\*\*: "How has customer sentiment changed over the past quarter?" ### Additional Resources Enhance your AI coding experience with LLM readable documentation Authenticating your requests with the Fireflies API \# Quickstart Source: https://docs.fireflies.ai/getting-started/quickstart Make your first request in under 5 minutes. This guide provides step-by-step instructions to make your first query with our GraphQL API and demonstrates basic functionality. ## Step 1: Setting Up Before diving into querying the API, it's essential to set up your environment correctly. This includes obtaining authentication credentials and configuring your development environment. ### Obtaining Authentication Credentials To access our API, you will need an API key. Follow these steps to obtain your key: 1. Log in to your account at \[app.fireflies.ai\](https://app.fireflies.ai) 2. Navigate to the \[Integrations\](https://app.fireflies.ai/integrations) section 3. Click on \[Fireflies API\](https://app.fireflies.ai/integrations/custom/fireflies) 4. Copy and store your API key securely It's crucial to handle your API key with the utmost care to ensure the security of your data. For more information on Authorization and best practices, visit \[Authorization\](/fundamentals/authorization) \## Step 2: Making Your First Request Execute a simple query to retrieve a list of users. Replace \`your\_api\_key\` with your API key in the following requests \`\`\`bash curl theme={null} curl \\ -X POST \\ -H "Content-Type: application/json" \\ -H "Authorization: Bearer your\_api\_key" \\ --data '{ "query": "{ users { name user\_id } }" }' \\ https://api.fireflies.ai/graphql \`\`\` \`\`\`python python theme={null} import requests url = 'https://api.fireflies.ai/graphql' headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer your\_api\_key' } data = { 'query': '{ users { name user\_id } }' } response = requests.post(url, json=data, headers=headers) print(response.json()) \`\`\` \`\`\`javascript javascript theme={null} const axios = require('axios'); const url = 'https://api.fireflies.ai/graphql'; const headers = { 'Content-Type': 'application/json', Authorization: 'Bearer your\_api\_key' }; const data = { query: '{ users { name user\_id } }' }; axios .post(url, data, { headers: headers }) .then(response => { console.log(response.data); }) .catch(error => { console.error('Error:', error); }); \`\`\` \`\`\`java java theme={null} import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; import java.net.http.HttpHeaders; import java.nio.charset.StandardCharsets; public class ApiRequest { public static void main(String\[\] args) { HttpClient client = HttpClient.newHttpClient(); String url = "https://api.fireflies.ai/graphql"; String json = "{\\"query\\":\\"{ users { name user\_id } }\\"}"; HttpRequest request = HttpRequest.newBuilder() .uri(URI.create(url)) .header("Content-Type", "application/json") .header("Authorization", "Bearer your\_api\_key") .POST(HttpRequest.BodyPublishers.ofString(json, StandardCharsets.UTF\_8)) .build(); client.sendAsync(request, HttpResponse.BodyHandlers.ofString()) .thenApply(HttpResponse::body) .thenAccept(System.out::println) .join(); } } \`\`\` When building GraphQL queries for this API, focus on precision and efficiency. Start with simple queries and gradually increase complexity. Ensure you only request the data you need to avoid over-fetching. \* \*\*Review the Schema Documentation\*\*: For guidance, refer to the \[Schema\](/schema) section and use tools like GraphQL Playground for testing. Efficient queries lead to better performance and a smoother API experience. More details on building your GraphQL query are available \[here\](/graphql-api) ## Step 3: Analyzing the Response You will receive a JSON response with the requested data. Example response: \`\`\`bash curl theme={null} { "data": { "users": \[ { "name":"Justin Fly", "user\_id":"example-id" } \] } } \`\`\` Continue to the next sections for more detailed examples and advanced usage instructions. --- # Page Not Found [Skip to main content](https://docs.fireflies.ai/graphql-api/transcript#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Page Not Found 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [General concepts](https://docs.fireflies.ai/fundamentals/concepts#graphql-api-concepts) [Introduction](https://docs.fireflies.ai/getting-started/introduction#advantages-of-using-graphql) [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts#usage-example) ⌘I --- # Page Not Found [Skip to main content](https://docs.fireflies.ai/graphql-api/analytics#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Page Not Found 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [General concepts](https://docs.fireflies.ai/fundamentals/concepts#graphql-api-concepts) [Introduction](https://docs.fireflies.ai/getting-started/introduction#advantages-of-using-graphql) [Analytics](https://docs.fireflies.ai/graphql-api/query/analytics#usage-example) ⌘I --- # Create bite - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/mutation/create-bite#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Mutation Create bite curl javascript python java Copy Ask AI curl -X POST https://api.fireflies.ai/graphql \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{ "query": "mutation CreateBite($transcriptId: ID!, $startTime: Float!, $endTime: Float!) { createBite(transcript_id: $transcriptId, start_time: $startTime, end_time: $endTime) { summary status id } }", "variables": { "transcriptId": "your_transcript_id", "startTime": 0, "endTime": 5 } }' Response Copy Ask AI { "data": { "createBite": { "name": "bite-name", "status": "pending", } } } [​](https://docs.fireflies.ai/graphql-api/mutation/create-bite#overview) Overview ------------------------------------------------------------------------------------ The `createBite` mutation allows you to create a bite through the API. [​](https://docs.fireflies.ai/graphql-api/mutation/create-bite#arguments) Arguments -------------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/mutation/create-bite#param-transcript-id) transcript\_id ID required ID of the transcript [​](https://docs.fireflies.ai/graphql-api/mutation/create-bite#param-name) name String Name of the biteMaximum length is 256 characters. [​](https://docs.fireflies.ai/graphql-api/mutation/create-bite#param-start-time) start\_time Float required Start time of the bite in seconds [​](https://docs.fireflies.ai/graphql-api/mutation/create-bite#param-end-time) end\_time Float required End time of the bite in seconds [​](https://docs.fireflies.ai/graphql-api/mutation/create-bite#param-media-type) media\_type String Type of the bite, either ‘video’ or ‘audio’ [​](https://docs.fireflies.ai/graphql-api/mutation/create-bite#param-privacies) privacies \[String\] Array specifying the visibility of the Soundbite. Possible values are ‘public’, ‘team’, and ‘participants’. For example, \[“team”, “participants”\] indicates visibility to both team members and participants, while \[“public”\] denotes full public access. [​](https://docs.fireflies.ai/graphql-api/mutation/create-bite#param-summary) summary String Summary for the biteMaximum length is 500 characters. [​](https://docs.fireflies.ai/graphql-api/mutation/create-bite#usage-example) Usage Example ---------------------------------------------------------------------------------------------- To create a bite, provide the necessary input parameters to the mutation. Here’s an example of how this mutation could be used: Copy Ask AI mutation Mutation($transcriptId: ID!, $startTime: Float!, $endTime: Float!) { createBite(transcript_id: $transcriptId, start_time: $startTime, end_time: $endTime) { status name id } } curl javascript python java Copy Ask AI curl -X POST https://api.fireflies.ai/graphql \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{ "query": "mutation CreateBite($transcriptId: ID!, $startTime: Float!, $endTime: Float!) { createBite(transcript_id: $transcriptId, start_time: $startTime, end_time: $endTime) { summary status id } }", "variables": { "transcriptId": "your_transcript_id", "startTime": 0, "endTime": 5 } }' Response Copy Ask AI { "data": { "createBite": { "name": "bite-name", "status": "pending", } } } [​](https://docs.fireflies.ai/graphql-api/mutation/create-bite#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------------------ [Bites\ -----\ \ Querying list of bites](https://docs.fireflies.ai/graphql-api/query/bites) [Bite\ ----\ \ Querying bite details](https://docs.fireflies.ai/graphql-api/query/bite) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/mutation/create-bite.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/mutation/create-bite) [Add to Live](https://docs.fireflies.ai/graphql-api/mutation/add-to-live) [Delete Transcript](https://docs.fireflies.ai/graphql-api/mutation/delete-transcript) ⌘I --- # Upload Audio - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Mutation Upload Audio curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{ "query": "mutation($input: AudioUploadInput) { uploadAudio(input: $input) { success title message } }", "variables": { "input": { "url": "https://url-to-the-audio-file", "title": "title of the file", "attendees": [\ {\ "displayName": "Fireflies Notetaker",\ "email": "notetaker@fireflies.ai",\ "phoneNumber": "xxxxxxxxxxxxxxxx"\ },\ {\ "displayName": "Fireflies Notetaker 2",\ "email": "notetaker2@fireflies.ai",\ "phoneNumber": "xxxxxxxxxxxxxxxx"\ }\ ] } } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "uploadAudio": { "success": true, "title": "title of the file", "message": "Uploaded audio has been queued for processing." } } } [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#overview) Overview ------------------------------------------------------------------------------------- The `uploadAudio` mutation allows you to upload audio files to Fireflies.ai for transcription. [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#arguments) Arguments --------------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#param-input) input AudioUploadInput Show child attributes [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#param-url) url String required The url of media file to be transcribed. It MUST be a valid https string and publicly accessible to enable us download the audio / video file. Double check to see if the media file is downloadable and that the link is not a preview link before making the request. The media file must be either of these formats - mp3, mp4, wav, m4a, ogg [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#param-title) title String Title or name of the meeting, this will be used to identify the transcribed file [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#param-webhook) webhook String URL for the webhook that receives notifications when transcription completes [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#param-custom-language) custom\_language String Specify a custom language code for your meeting, e.g. `es` for Spanish or `de` for German. For a complete list of language codes, please view [Language Codes](https://docs.fireflies.ai/miscellaneous/language-codes) [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#param-save-video) save\_video Boolean Specify whether the video should be saved or not. [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#param-attendees) attendees \[Attendees\] An array of objects containing meeting [Attendees](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#) . This is relevant if you have active integrations like Salesforce, Hubspot etc. Fireflies uses the attendees value to push meeting notes to your active CRM integrations where notes are added to an existing contact or a new contact is created. Each object contains - * displayName * email * phoneNumber [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#param-client-reference-id) client\_reference\_id String Custom identifier set by the user during upload. You may use this to identify your uploads in your webhook events. [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#param-bypass-size-check) bypass\_size\_check Boolean Bypasses the internal file size validation that normally rejects audio files smaller than 50kb. Set to true if you need to process very short audio clips. [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#usage-example) Usage Example ----------------------------------------------------------------------------------------------- To upload a file, provide the necessary input parameters to the mutation. Here’s an example of how this mutation could be used: Copy Ask AI mutation uploadAudio($input: AudioUploadInput) { uploadAudio(input: $input) { success title message } } curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{ "query": "mutation($input: AudioUploadInput) { uploadAudio(input: $input) { success title message } }", "variables": { "input": { "url": "https://url-to-the-audio-file", "title": "title of the file", "attendees": [\ {\ "displayName": "Fireflies Notetaker",\ "email": "notetaker@fireflies.ai",\ "phoneNumber": "xxxxxxxxxxxxxxxx"\ },\ {\ "displayName": "Fireflies Notetaker 2",\ "email": "notetaker2@fireflies.ai",\ "phoneNumber": "xxxxxxxxxxxxxxxx"\ }\ ] } } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "uploadAudio": { "success": true, "title": "title of the file", "message": "Uploaded audio has been queued for processing." } } } [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#faq) FAQ --------------------------------------------------------------------------- Can I upload a file directly from my machine? Audio upload only works with publicly accessible URLs. We cannot accept files hosted on your local machine or a private server. I don't want to expose my audio files to the public internet. How can I upload them to Fireflies.ai safely? You may use signed urls with short expiry times to upload audio files to Fireflies.ai. Fireflies will download the file from the url and process it. [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#error-codes) Error Codes ------------------------------------------------------------------------------------------- List of possible error codes that may be returned by the `uploadAudio` mutation. Full list of error codes can be found [here](https://docs.fireflies.ai/miscellaneous/error-codes) . account\_cancelled The user account has been cancelled. Please contact support if you encounter this error. paid\_required (pro\_or\_higher) You may receieve this error when uploading audio files or querying `audio_url` field. Free plan users cannot upload audio files. Please upgrade to a paid plan to upload audio files. paid\_required (business\_or\_higher) You may receieve this error when querying `video_url` field. Free/pro plan users cannot query `video_url` field. Please upgrade to a Business or Enterprise plan to query `video_url` field. payload\_too\_small The audio file is too short to be processed. Please ensure the audio file is at least 50kb in size. invalid\_language\_code The language code you provided is invalid. Please refer to the [Language Codes](https://docs.fireflies.ai/miscellaneous/language-codes) page for a list of valid language codes. [​](https://docs.fireflies.ai/graphql-api/mutation/upload-audio#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------------------- [Webhooks\ --------\ \ Create notifications using webhooks](https://docs.fireflies.ai/graphql-api/webhooks) [Add to Live\ -----------\ \ Use the API to add the Fireflies.ai bot to an ongoing meeting](https://docs.fireflies.ai/graphql-api/mutation/add-to-live) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/mutation/upload-audio.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/mutation/upload-audio) [Set User Role](https://docs.fireflies.ai/graphql-api/mutation/set-user-role) [Update Meeting Title](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-title) ⌘I --- # Page Not Found [Skip to main content](https://docs.fireflies.ai/graphql-api/transcripts#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Page Not Found 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [General concepts](https://docs.fireflies.ai/fundamentals/concepts#graphql-api-concepts) [Introduction](https://docs.fireflies.ai/getting-started/introduction#advantages-of-using-graphql) [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts#usage-example) ⌘I --- # Page Not Found [Skip to main content](https://docs.fireflies.ai/additional-info/schema/transcript#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Page Not Found 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [Transcript](https://docs.fireflies.ai/schema/transcript#) [User](https://docs.fireflies.ai/schema/user#additional-resources) [What's New](https://docs.fireflies.ai/getting-started/whats-new#2-10-0) ⌘I --- # Page Not Found [Skip to main content](https://docs.fireflies.ai/additional-info/graphql-api/query/transcripts#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Page Not Found 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [General concepts](https://docs.fireflies.ai/fundamentals/concepts#graphql-api-concepts) [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts#usage-example) [Transcript](https://docs.fireflies.ai/graphql-api/query/transcript#usage-example) ⌘I --- # MeetingAttendance Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/meeting-attendance#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation MeetingAttendance On this page * [Additional Resources](https://docs.fireflies.ai/schema/meeting-attendance#additional-resources) [​](https://docs.fireflies.ai/schema/meeting-attendance#param-name) name String Name of the meeting participant as it appears in the meeting events. [​](https://docs.fireflies.ai/schema/meeting-attendance#param-join-time) join\_time String ISO 8601 timestamp when the participant first joined the meeting. If the participant joined at meeting start (timestamp: 0), this will be the meeting’s start time. [​](https://docs.fireflies.ai/schema/meeting-attendance#param-leave-time) leave\_time String ISO 8601 timestamp when the participant last left the meeting. This field is nullable if the participant never left or the leave event was not captured. [​](https://docs.fireflies.ai/schema/meeting-attendance#additional-resources) Additional Resources ----------------------------------------------------------------------------------------------------- [MeetingAttendee\ ---------------\ \ Schema for MeetingAttendee](https://docs.fireflies.ai/schema/meeting-attendee) [Transcript\ ----------\ \ Schema for Transcript](https://docs.fireflies.ai/schema/transcript) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/meeting-attendance.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/meeting-attendance) ⌘I --- # Transcript query - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/query/transcript#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Query Transcript curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query Transcript($transcriptId: String!) { transcript(id: $transcriptId) { title id } }", "variables": { "transcriptId": "your_transcript_id" } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "transcript": { "title": "Weekly sync", "id": "transcript-id", } } } [​](https://docs.fireflies.ai/graphql-api/query/transcript#overview) Overview -------------------------------------------------------------------------------- The transcript query is designed to fetch details associated with a specific transcript ID. [​](https://docs.fireflies.ai/graphql-api/query/transcript#arguments) Arguments ---------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/query/transcript#param-id) id String required [​](https://docs.fireflies.ai/graphql-api/query/transcript#schema) Schema ---------------------------------------------------------------------------- Fields available to the [Transcript](https://docs.fireflies.ai/schema/transcript) query [​](https://docs.fireflies.ai/graphql-api/query/transcript#usage-example) Usage Example ------------------------------------------------------------------------------------------ Copy Ask AI query Transcript($transcriptId: String!) { transcript(id: $transcriptId) { id dateString privacy analytics { sentiments { negative_pct neutral_pct positive_pct } categories { questions date_times metrics tasks } speakers { speaker_id name duration word_count longest_monologue monologues_count filler_words questions duration_pct words_per_minute } } speakers { id name } sentences { index speaker_name speaker_id text raw_text start_time end_time ai_filters { task pricing metric question date_and_time text_cleanup sentiment } } title host_email organizer_email calendar_id user { user_id email name num_transcripts recent_meeting minutes_consumed is_admin integrations } fireflies_users participants date transcript_url audio_url video_url duration meeting_attendees { displayName email phoneNumber name location } meeting_attendance { name join_time leave_time } summary { keywords action_items outline shorthand_bullet overview bullet_gist gist short_summary short_overview meeting_type topics_discussed transcript_chapters } cal_id calendar_type meeting_info { fred_joined silent_meeting summary_status } apps_preview { outputs { transcript_id user_id app_id created_at title prompt response } } meeting_link channels { id } } } curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query Transcript($transcriptId: String!) { transcript(id: $transcriptId) { title id } }", "variables": { "transcriptId": "your_transcript_id" } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "transcript": { "title": "Weekly sync", "id": "transcript-id", } } } [​](https://docs.fireflies.ai/graphql-api/query/transcript#error-codes) Error Codes -------------------------------------------------------------------------------------- List of possible error codes that may be returned by the `transcript` query. Full list of error codes can be found [here](https://docs.fireflies.ai/miscellaneous/error-codes) . object\_not\_found (transcript) The transcript ID you are trying to query does not exist or you do not have access to it. [​](https://docs.fireflies.ai/graphql-api/query/transcript#additional-resources) Additional Resources -------------------------------------------------------------------------------------------------------- [Transcripts\ -----------\ \ Querying list of transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) [Update Meeting Title\ --------------------\ \ Use the API to update meeting titles](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-title) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/query/transcript.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/query/transcript) [User Groups](https://docs.fireflies.ai/graphql-api/query/user-groups) [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) ⌘I --- # AI Apps query - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/query/apps#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Query AI Apps curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query GetAIAppsOutputs($transcriptId: String) { apps(transcript_id: $transcriptId) { outputs { transcript_id user_id app_id created_at title prompt response } } }", "variables": { "transcriptId": "your_transcript_id" } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "apps": [\ {\ "transcript_id": "transcript-id",\ "user_id": "user-id",\ "app_id": "app-id",\ "title": "Weekly sync"\ }\ ] } } [​](https://docs.fireflies.ai/graphql-api/query/apps#overview) Overview -------------------------------------------------------------------------- The apps query fetches the results of the AI App for all the meetings it ran successfully. [​](https://docs.fireflies.ai/graphql-api/query/apps#arguments) Arguments ---------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/query/apps#param-app-id) app\_id String The `app_id` parameter retrieves all outputs against a specific AI App. [​](https://docs.fireflies.ai/graphql-api/query/apps#param-transcript-id) transcript\_id String The `transcript_id` parameter retrieves all outputs against a specific meeting/transcript. [​](https://docs.fireflies.ai/graphql-api/query/apps#param-skip) skip Int Number of records to skip over. Helps paginate results when used in combination with the `limit` param. [​](https://docs.fireflies.ai/graphql-api/query/apps#param-limit) limit Int Maximum number of `apps` outputs to fetch in a single query. The default query fetches 10 records, which is the maximum for a single request. [​](https://docs.fireflies.ai/graphql-api/query/apps#schema) Schema ---------------------------------------------------------------------- Fields available to the [AI Apps](https://docs.fireflies.ai/schema/apps) query [​](https://docs.fireflies.ai/graphql-api/query/apps#usage-example) Usage Example ------------------------------------------------------------------------------------ Copy Ask AI query GetAIAppsOutputs($appId: String, $transcriptId: String, $skip: Float, $limit: Float) { apps(app_id: $appId, transcript_id: $transcriptId, skip: $skip, limit: $limit) { outputs { transcript_id user_id app_id created_at title prompt response } } } curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query GetAIAppsOutputs($transcriptId: String) { apps(transcript_id: $transcriptId) { outputs { transcript_id user_id app_id created_at title prompt response } } }", "variables": { "transcriptId": "your_transcript_id" } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "apps": [\ {\ "transcript_id": "transcript-id",\ "user_id": "user-id",\ "app_id": "app-id",\ "title": "Weekly sync"\ }\ ] } } [​](https://docs.fireflies.ai/graphql-api/query/apps#additional-resources) Additional Resources -------------------------------------------------------------------------------------------------- [Transcript\ ----------\ \ Querying transcript details](https://docs.fireflies.ai/graphql-api/query/transcript) [Transcripts\ -----------\ \ Querying list of transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/query/apps.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/query/apps) [Analytics](https://docs.fireflies.ai/graphql-api/query/analytics) [User](https://docs.fireflies.ai/graphql-api/query/user) ⌘I --- # User Groups query - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/query/user-groups#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Query User Groups curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "{ user_groups { name handle members { first_name last_name email } } }" }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "user_groups": [\ {\ "id": "group_123",\ "name": "Engineering Team",\ "handle": "engineering",\ "members": [\ {\ "user_id": "user_456",\ "first_name": "John",\ "last_name": "Doe",\ "email": "john.doe@example.com"\ },\ {\ "user_id": "user_789",\ "first_name": "Jane",\ "last_name": "Smith",\ "email": "jane.smith@example.com"\ }\ ]\ },\ {\ "id": "group_124",\ "name": "Sales Team",\ "handle": "sales",\ "members": [\ {\ "user_id": "user_101",\ "first_name": "Bob",\ "last_name": "Johnson",\ "email": "bob.johnson@example.com"\ }\ ]\ }\ ] } } [​](https://docs.fireflies.ai/graphql-api/query/user-groups#overview) Overview --------------------------------------------------------------------------------- The user\_groups query is designed to fetch a list of all user groups within the team. This query allows you to retrieve information about user groups including their members. [​](https://docs.fireflies.ai/graphql-api/query/user-groups#arguments) Arguments ----------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/query/user-groups#param-mine) mine Boolean `mine` is an optional boolean argument. If set to `true`, returns only user groups that the current user belongs to. If not provided or set to `false`, returns all user groups in the team. [​](https://docs.fireflies.ai/graphql-api/query/user-groups#schema) Schema ----------------------------------------------------------------------------- Fields available to the [UserGroup](https://docs.fireflies.ai/schema/user-groups) query [​](https://docs.fireflies.ai/graphql-api/query/user-groups#usage-example) Usage Example ------------------------------------------------------------------------------------------- Copy Ask AI query UserGroups($mine: Boolean) { user_groups(mine: $mine) { id name handle members { user_id first_name last_name email } } } curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "{ user_groups { name handle members { first_name last_name email } } }" }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "user_groups": [\ {\ "id": "group_123",\ "name": "Engineering Team",\ "handle": "engineering",\ "members": [\ {\ "user_id": "user_456",\ "first_name": "John",\ "last_name": "Doe",\ "email": "john.doe@example.com"\ },\ {\ "user_id": "user_789",\ "first_name": "Jane",\ "last_name": "Smith",\ "email": "jane.smith@example.com"\ }\ ]\ },\ {\ "id": "group_124",\ "name": "Sales Team",\ "handle": "sales",\ "members": [\ {\ "user_id": "user_101",\ "first_name": "Bob",\ "last_name": "Johnson",\ "email": "bob.johnson@example.com"\ }\ ]\ }\ ] } } [​](https://docs.fireflies.ai/graphql-api/query/user-groups#error-codes) Error Codes --------------------------------------------------------------------------------------- List of possible error codes that may be returned by the `user_groups` query. Full list of error codes can be found [here](https://docs.fireflies.ai/miscellaneous/error-codes) . not\_authorized You do not have permission to access user groups for this team. [​](https://docs.fireflies.ai/graphql-api/query/user-groups#additional-resources) Additional Resources --------------------------------------------------------------------------------------------------------- [Users\ -----\ \ Querying list of users](https://docs.fireflies.ai/graphql-api/query/users) [User\ ----\ \ Querying user details](https://docs.fireflies.ai/graphql-api/query/user) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/query/user-groups.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/query/user-groups) [Users](https://docs.fireflies.ai/graphql-api/query/users) [Transcript](https://docs.fireflies.ai/graphql-api/query/transcript) ⌘I --- # Add to Live - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/mutation/add-to-live#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Mutation Add to Live curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{ "query": "mutation AddToLiveMeeting($meetingLink: String!) { addToLiveMeeting(meeting_link: $meetingLink) { success } }", "variables": { "meetingLink": "https://meet.google.com/code-here" } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "addToLiveMeeting": { "success": true, } } } [​](https://docs.fireflies.ai/graphql-api/mutation/add-to-live#overview) Overview ------------------------------------------------------------------------------------ The `addToLiveMeeting` mutation allows you to add the Fireflies.ai bot to an ongoing meeting. It is rate limited to 3 requests per 20 minutes. [​](https://docs.fireflies.ai/graphql-api/mutation/add-to-live#arguments) Arguments -------------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/mutation/add-to-live#param-meeting-link) meeting\_link String! required A valid http URL for the meeting link, i.e. gooogle meet, zoom, etc [​](https://docs.fireflies.ai/graphql-api/mutation/add-to-live#param-title) title String Title or name of the meeting, this will be used to identify the transcribed file. If title is not provided, a default title will be set automaticallyMaximum length is 256 characters. [​](https://docs.fireflies.ai/graphql-api/mutation/add-to-live#param-meeting-password) meeting\_password String Password for the meeting, if applicable.Maximum length is 32 characters. [​](https://docs.fireflies.ai/graphql-api/mutation/add-to-live#param-duration) duration Int Meeting duration in minutes. Defaults to 60 minutes if param is not providedMinimum is 15 and maximum is 120. [​](https://docs.fireflies.ai/graphql-api/mutation/add-to-live#param-language) language String Language of the meeting. Defaults to English if not provided. For a complete list of language codes, please view [Language Codes](https://docs.fireflies.ai/miscellaneous/language-codes) Maximum length is 5 characters. [​](https://docs.fireflies.ai/graphql-api/mutation/add-to-live#param-attendees) attendees \[Attendee\] Array of [Attendees](https://docs.fireflies.ai/schema/input/attendee) for expected meeting participants. [​](https://docs.fireflies.ai/graphql-api/mutation/add-to-live#usage-example) Usage Example ---------------------------------------------------------------------------------------------- To upload an audio file, provide the necessary input parameters to the mutation. Here’s an example of how this mutation could be used: Copy Ask AI mutation AddToLiveMeeting($meetingLink: String!) { addToLiveMeeting(meeting_link: $meetingLink) { success } } curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{ "query": "mutation AddToLiveMeeting($meetingLink: String!) { addToLiveMeeting(meeting_link: $meetingLink) { success } }", "variables": { "meetingLink": "https://meet.google.com/code-here" } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "addToLiveMeeting": { "success": true, } } } [​](https://docs.fireflies.ai/graphql-api/mutation/add-to-live#faq) FAQ -------------------------------------------------------------------------- Why am I getting a 'too\_many\_requests' error? The `addToLive` mutation has a limit of 3 requests per 20 minutes. You may view API Rate limits [here](https://docs.fireflies.ai/fundamentals/limits) . [​](https://docs.fireflies.ai/graphql-api/mutation/add-to-live#error-codes) Error Codes ------------------------------------------------------------------------------------------ List of possible error codes that may be returned by the `addToLiveMeeting` mutation. Full list of error codes can be found [here](https://docs.fireflies.ai/miscellaneous/error-codes) . too\_many\_requests You have exceeded the rate limit for the `addToLiveMeeting` mutation. It is limited to 3 requests per 20 minutes. Please try again later. invalid\_language\_code The language code you provided is invalid. Please refer to the [Language Codes](https://docs.fireflies.ai/miscellaneous/language-codes) page for a list of valid language codes. account\_cancelled The user account has been cancelled. Please contact support if you encounter this error. unsupported\_platform The meeting platform URL provided is not supported. Please use a supported meeting platform such as Zoom, Google Meet, Microsoft Teams, etc. [​](https://docs.fireflies.ai/graphql-api/mutation/add-to-live#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------------------ [Upload Audio\ ------------\ \ Use the API to upload audio to Fireflies.ai](https://docs.fireflies.ai/graphql-api/mutation/upload-audio) [Webhooks\ --------\ \ Create notifications using webhooks](https://docs.fireflies.ai/graphql-api/webhooks) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/mutation/add-to-live.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/mutation/add-to-live) [Bites](https://docs.fireflies.ai/graphql-api/query/bites) [Create bite](https://docs.fireflies.ai/graphql-api/mutation/create-bite) ⌘I --- # UpdateMeetingPrivacyInput Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/input/update-meeting-privacy-input#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Input UpdateMeetingPrivacyInput [​](https://docs.fireflies.ai/schema/input/update-meeting-privacy-input#param-id) id String required The unique identifier of the meeting / transcript. [​](https://docs.fireflies.ai/schema/input/update-meeting-privacy-input#param-privacy) privacy String required The privacy level for the meeting. Must be one of the following values: * `link` - Anyone with the link can access the meeting * `owner` - Only the meeting owner can access * `participants` - Only meeting participants can access * `teammatesandparticipants` - Both teammates and participants can access * `teammates` - Only teammates can access Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/input/update-meeting-privacy-input.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/input/update-meeting-privacy-input) [UpdateMeetingTitleInput](https://docs.fireflies.ai/schema/input/update-meeting-title-input) [Language codes](https://docs.fireflies.ai/miscellaneous/language-codes) ⌘I --- # AudioUploadInput Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/input/audio-upload-input#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Input AudioUploadInput [​](https://docs.fireflies.ai/schema/input/audio-upload-input#param-url) url String required URL from which the audio file will be fetched. This should be a direct link to the audio resource. [​](https://docs.fireflies.ai/schema/input/audio-upload-input#param-title) title String Title assigned to the uploaded file. If not provided, the file’s original name will be used as its title.Maximum length is 256 characters. [​](https://docs.fireflies.ai/schema/input/audio-upload-input#param-attendees) attendees \[Attendee\] Array of [Attendee](https://docs.fireflies.ai/schema/attendee) objects, as defined in the [Attendee](https://docs.fireflies.ai/schema/attendee) schema. Each element in this array represents an attendee.Max length of 100 attendees. [​](https://docs.fireflies.ai/schema/input/audio-upload-input#param-custom-language) custom\_language String Custom language code for the meeting [​](https://docs.fireflies.ai/schema/input/audio-upload-input#param-client-reference-id) client\_reference\_id String Custom identifier set by the user during upload. You may use this to identify your uploads in your events.Maximum length is 128 characters. [​](https://docs.fireflies.ai/schema/input/audio-upload-input#param-save-video) save\_video Boolean Boolean value that specifies whether the content video needs to be saved. Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/input/audio-upload-input.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/input/audio-upload-input) [User Group Member](https://docs.fireflies.ai/schema/user-group-member) [Attendee](https://docs.fireflies.ai/schema/input/attendee) ⌘I --- # Transcripts query - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/query/transcripts#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Query Transcripts curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query Transcripts($userId: String) { transcripts(user_id: $userId) { title id } }" }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "transcripts": [\ {\ "title": "Weekly sync",\ "id": "transcript-id",\ },\ {\ "title": "ClientMeeting.mp3",\ "id": "transcript-id-2",\ }\ ] } } [​](https://docs.fireflies.ai/graphql-api/query/transcripts#overview) Overview --------------------------------------------------------------------------------- The transcripts query is designed to fetch a list of transcripts against input arguments. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#arguments) Arguments ----------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-title) title String **This field is deprecated. Please use `keyword` instead.**Title of the transcriptThis argument is mutually exclusive with `keyword` fieldThe maximum allowable length for this field is `256` characters. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-keyword) keyword String Allows searching for keywords in meeting title and/or words spoken during the meetingThis argument is mutually exclusive with `title` fieldThe maximum allowable length for this field is `255` characters. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-scope) scope TranscriptsQueryScope Specify the scope for keyword search.If scope is provided, `keyword` becomes a required fieldDefaults to `TITLE` if no value is providedThe available options for this field are: * `title`: Search within the title. * `sentences`: Search within the [sentences](https://docs.fireflies.ai/schema/sentence) . * `all`: Search within title and sentences. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-from-date) fromDate DateTime Return all transcripts created after `fromDate`. The `fromDate` parameter accepts a date-time string in the ISO 8601 format, specifically in the form `YYYY-MM-DDTHH:mm.sssZ`. For example, a valid timestamp would be `2024-07-08T22:13:46.660Z`. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-to-date) toDate DateTime Return all transcripts created before `toDate`. The `toDate` parameter accepts a date-time string in the ISO 8601 format, specifically in the form `YYYY-MM-DDTHH:mm.sssZ`. For example, a valid timestamp would be `2024-07-08T22:13:46.660Z`. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-date) date Float **This field is deprecated. Please use `fromDate` and `toDate` instead.**Return all transcripts created within the date specified. Query input value must be in milliseconds. For example, you can use the JavaScript `new Date().getTime()` to get the datetime in milliseconds which should look like this `1621292557453`. The timezone for this field is UTC +00:00For more details regarding time since [EPOCH](https://currentmillis.com/) [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-limit) limit Int Number of transcripts to return. Maxiumum 50 in one query [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-skip) skip Int Number of transcripts to skip. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-host-email) host\_email String Filter all meetings accordingly to meetings that have this email as the host. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-organizer-email) organizer\_email String **This field is deprecated. Please use `organizers` instead.** Filter meetings that have this email as the organizer. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-participant-email) participant\_email String **This field is deprecated. Please use `participants` instead.** Filter meetings that contain this email as an attendee. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-user-id) user\_id String [User id](https://docs.fireflies.ai/schema/user) . Filter all meetings that have this user ID as the organizer or participant. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-mine) mine Boolean Filter all meetings that have the API key owner as the organizer. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-organizers) organizers \[String\] Filter meetings that have any of these emails as organizers. Accepts an array of email addresses.Cannot be combined with the deprecated `organizer_email` or `participant_email` fields.Each email must be valid and 256 characters or fewer. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-participants) participants \[String\] Filter meetings that contain any of these emails as attendees. Accepts an array of email addresses.Cannot be combined with the deprecated `organizer_email` or `participant_email` fields.Each email must be valid and 256 characters or fewer. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#param-channel-id) channel\_id String Filter meetings that belong to a specific channel. Accepts a single channel ID.The channel ID must be a valid string and 256 characters or fewer. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#schema) Schema ----------------------------------------------------------------------------- Fields available to the [Transcript](https://docs.fireflies.ai/schema/transcript) query [​](https://docs.fireflies.ai/graphql-api/query/transcripts#usage-example) Usage Example ------------------------------------------------------------------------------------------- Copy Ask AI query Transcripts( $title: String $date: Float $limit: Int $skip: Int $hostEmail: String $participantEmail: String $organizers: [String] $participants: [String] $userId: String $channelId: String ) { transcripts( title: $title date: $date limit: $limit skip: $skip host_email: $hostEmail participant_email: $participantEmail organizers: $organizers participants: $participants user_id: $userId channel_id: $channelId ) { id analytics { sentiments { negative_pct neutral_pct positive_pct } categories { questions date_times metrics tasks } speakers { speaker_id name duration word_count longest_monologue monologues_count filler_words questions duration_pct words_per_minute } } sentences { index speaker_name speaker_id text raw_text start_time end_time ai_filters { task pricing metric question date_and_time text_cleanup sentiment } } title speakers { id name } host_email organizer_email meeting_info { fred_joined silent_meeting summary_status } calendar_id user { user_id email name num_transcripts recent_meeting minutes_consumed is_admin integrations } fireflies_users participants date transcript_url audio_url video_url duration meeting_attendees { displayName email phoneNumber name location } meeting_attendance { name join_time leave_time } summary { keywords action_items outline shorthand_bullet overview bullet_gist gist short_summary short_overview meeting_type topics_discussed transcript_chapters } cal_id calendar_type apps_preview { outputs { transcript_id user_id app_id created_at title prompt response } } meeting_link channels { id } } } curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query Transcripts($userId: String) { transcripts(user_id: $userId) { title id } }" }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "transcripts": [\ {\ "title": "Weekly sync",\ "id": "transcript-id",\ },\ {\ "title": "ClientMeeting.mp3",\ "id": "transcript-id-2",\ }\ ] } } [​](https://docs.fireflies.ai/graphql-api/query/transcripts#error-codes) Error Codes --------------------------------------------------------------------------------------- List of possible error codes that may be returned by the `transcripts` query. Full list of error codes can be found [here](https://docs.fireflies.ai/miscellaneous/error-codes) . object\_not\_found (user) The user ID you are trying to query does not exist or you do not have access to it. [​](https://docs.fireflies.ai/graphql-api/query/transcripts#additional-resources) Additional Resources --------------------------------------------------------------------------------------------------------- [Transcript\ ----------\ \ Querying transcript details](https://docs.fireflies.ai/graphql-api/query/transcript) [Upload Audio\ ------------\ \ Use the API to upload audio to Fireflies.ai](https://docs.fireflies.ai/graphql-api/mutation/upload-audio) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/query/transcripts.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/query/transcripts) [Transcript](https://docs.fireflies.ai/graphql-api/query/transcript) [Bite](https://docs.fireflies.ai/graphql-api/query/bite) ⌘I --- # Update Meeting Title - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-title#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Mutation Update Meeting Title curl javascript python java Copy Ask AI curl -X POST https://api.fireflies.ai/graphql \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{ "query": "mutation($input: UpdateMeetingTitleInput!) { updateMeetingTitle(input: $input) { title } }", "variables": { "input": { "id": "your_transcript_id", "title": "New Title" } } }' Response Copy Ask AI { "data": { "updateMeetingTitle": { "title": "New Title" } } } [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-title#overview) Overview --------------------------------------------------------------------------------------------- The `updateMeetingTitle` mutation allows for updating the title of a meeting transcript. This operation requires admin privileges within the team. [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-title#arguments) Arguments ----------------------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-title#param-input) input UpdateMeetingTitleInput required The new title to be assigned to the meeting / transcript. [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-title#usage-example) Usage Example ------------------------------------------------------------------------------------------------------- To update a meeting title, provide the transcript ID and the new title as arguments to the mutation. Here’s an example of how this mutation could be used: Copy Ask AI mutation UpdateMeetingTitle($input: UpdateMeetingTitleInput!) { updateMeetingTitle(input: $input) { title } } curl javascript python java Copy Ask AI curl -X POST https://api.fireflies.ai/graphql \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{ "query": "mutation($input: UpdateMeetingTitleInput!) { updateMeetingTitle(input: $input) { title } }", "variables": { "input": { "id": "your_transcript_id", "title": "New Title" } } }' Response Copy Ask AI { "data": { "updateMeetingTitle": { "title": "New Title" } } } [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-title#faq) FAQ ----------------------------------------------------------------------------------- Who has permission to update meeting titles? Only users with admin privileges can update meeting titles. The meeting owner also needs to be in your team. [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-title#error-codes) Error Codes --------------------------------------------------------------------------------------------------- List of possible error codes that may be returned by the `updateMeetingTitle` mutation. Full list of error codes can be found [here](https://docs.fireflies.ai/miscellaneous/error-codes) . require\_elevated\_privilege The user does not have admin privileges to update meeting titles. object\_not\_found (transcript) The specified transcript could not be found or you do not have access to it [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-title#additional-resources) Additional Resources --------------------------------------------------------------------------------------------------------------------- [Transcript\ ----------\ \ Querying transcript details](https://docs.fireflies.ai/graphql-api/query/transcript) [Update Meeting Privacy\ ----------------------\ \ Update meeting privacy](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/mutation/update-meeting-title.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/mutation/update-meeting-title) [Upload Audio](https://docs.fireflies.ai/graphql-api/mutation/upload-audio) [Update Meeting Privacy](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy) ⌘I --- # Bite query - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/query/bite#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Query Bite curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query Bite($biteId: ID!) { bite(id: $biteId) { user_id name status summary } }", "variables": { "biteId": "your_bite_id" } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "bite": { "user_id": "user-id", "id": "bite-id", } } } [​](https://docs.fireflies.ai/graphql-api/query/bite#overview) Overview -------------------------------------------------------------------------- The bite query is designed to fetch details associated with a specific bite ID. [​](https://docs.fireflies.ai/graphql-api/query/bite#arguments) Arguments ---------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/query/bite#param-id) id ID required Unique identifier of the bite [​](https://docs.fireflies.ai/graphql-api/query/bite#schema) Schema ---------------------------------------------------------------------- Fields available to the [Bite](https://docs.fireflies.ai/schema/bite) query [​](https://docs.fireflies.ai/graphql-api/query/bite#usage-example) Usage Example ------------------------------------------------------------------------------------ Copy Ask AI query Bite($biteId: ID!) { bite(id: $biteId) { transcript_id name id thumbnail preview status summary user_id start_time end_time summary_status media_type created_at created_from { description duration id name type } captions { end_time index speaker_id speaker_name start_time text } sources { src type } privacies user { first_name last_name picture name id } } } curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query Bite($biteId: ID!) { bite(id: $biteId) { user_id name status summary } }", "variables": { "biteId": "your_bite_id" } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "bite": { "user_id": "user-id", "id": "bite-id", } } } [​](https://docs.fireflies.ai/graphql-api/query/bite#additional-resources) Additional Resources -------------------------------------------------------------------------------------------------- [Bites\ -----\ \ Querying list of bites](https://docs.fireflies.ai/graphql-api/query/bites) [Create Bite\ -----------\ \ Use the API to create a bite](https://docs.fireflies.ai/graphql-api/mutation/create-bite) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/query/bite.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/query/bite) [Transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) [Bites](https://docs.fireflies.ai/graphql-api/query/bites) ⌘I --- # Delete Transcript - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/mutation/delete-transcript#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Mutation Delete Transcript curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{"query": "mutation($transcriptId: String!) { deleteTranscript(id: $transcriptId) { title date duration organizer_email } }", "variables": {"transcriptId": "your_transcript_id"}}' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "deleteTranscript": { "duration": "1", "date": 1699570138000, "organizer_email": "justin@fly.ai", "title": "Video title" } } } [​](https://docs.fireflies.ai/graphql-api/mutation/delete-transcript#overview) Overview ------------------------------------------------------------------------------------------ The `deleteTranscript` mutation is designed to delete a specific transcript by its ID. **Rate Limit:** This mutation is rate-limited to 10 requests per minute across all user tiers. If you exceed this limit, you will receive a `too_many_requests` error with a `retryAfter` timestamp indicating when you can make requests again. [​](https://docs.fireflies.ai/graphql-api/mutation/delete-transcript#arguments) Arguments -------------------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/mutation/delete-transcript#param-id) id String required Transcript ID [​](https://docs.fireflies.ai/graphql-api/mutation/delete-transcript#usage-example) Usage Example ---------------------------------------------------------------------------------------------------- To delete a transcript, provide the unique id of the transcript as an argument to the mutation. The returned subfields will be from the deleted transcript. Here’s an example of how this mutation could be used: Copy Ask AI mutation deleteTranscript($id: String!) { deleteTranscript(id: $id) { id title host_email organizer_email fireflies_users participants date transcript_url audio_url duration } } curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{"query": "mutation($transcriptId: String!) { deleteTranscript(id: $transcriptId) { title date duration organizer_email } }", "variables": {"transcriptId": "your_transcript_id"}}' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "deleteTranscript": { "duration": "1", "date": 1699570138000, "organizer_email": "justin@fly.ai", "title": "Video title" } } } [​](https://docs.fireflies.ai/graphql-api/mutation/delete-transcript#error-codes) Error Codes ------------------------------------------------------------------------------------------------ List of possible error codes that may be returned by the `deleteTranscript` mutation. Full list of error codes can be found [here](https://docs.fireflies.ai/miscellaneous/error-codes) . require\_elevated\_privilege The user does not have admin privileges to delete the transcript. too\_many\_requests You have exceeded the rate limit of 10 requests per minute. Wait until the time specified in the `retryAfter` field before making additional requests. [​](https://docs.fireflies.ai/graphql-api/mutation/delete-transcript#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------------------------ [Transcripts\ -----------\ \ Querying list of transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) [Update Meeting Privacy\ ----------------------\ \ Update meeting privacy](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/mutation/delete-transcript.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/mutation/delete-transcript) [Create bite](https://docs.fireflies.ai/graphql-api/mutation/create-bite) [Set User Role](https://docs.fireflies.ai/graphql-api/mutation/set-user-role) ⌘I --- # Bites query - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/query/bites#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Query Bites curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query Bites($mine: Boolean) { bites(mine: $mine) { user_id name end_time } }", "variables": { "mine": true } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "bites": [\ {\ "user_id": "user-id",\ "id": "bite-id",\ },\ {\ "user_id": "user-id",\ "id": "bite-id-2",\ }\ ] } } [​](https://docs.fireflies.ai/graphql-api/query/bites#overview) Overview --------------------------------------------------------------------------- The bites query is designed to fetch a list of bites against input arguments. [​](https://docs.fireflies.ai/graphql-api/query/bites#arguments) Arguments ----------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/query/bites#param-mine) mine Boolean required The `mine` parameter, when set to true, fetches results specific to the owner of the API key [​](https://docs.fireflies.ai/graphql-api/query/bites#param-transcript-id) transcript\_id ID You can use `transcript_id` to query all bites against a specific transcript. [​](https://docs.fireflies.ai/graphql-api/query/bites#param-my-team) my\_team Boolean The `my_team` parameter, when set to true, fetches results for the owner of the API key [​](https://docs.fireflies.ai/graphql-api/query/bites#param-limit) limit Int Maximum number of bites to fetch in a single query. Maximum of 50 [​](https://docs.fireflies.ai/graphql-api/query/bites#param-skip) skip Int Number of records to skip over. Helps paginate results when used in combination with the `limit` param. [​](https://docs.fireflies.ai/graphql-api/query/bites#schema) Schema ----------------------------------------------------------------------- Fields available to the [Bites](https://docs.fireflies.ai/schema/bite) query [​](https://docs.fireflies.ai/graphql-api/query/bites#usage-example) Usage Example ------------------------------------------------------------------------------------- Copy Ask AI query Bites($mine: Boolean) { bites(mine: $mine) { transcript_id name id thumbnail preview status summary user_id start_time end_time summary_status media_type created_at created_from { description duration id name type } captions { end_time index speaker_id speaker_name start_time text } sources { src type } privacies user { first_name last_name picture name id } } } curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query Bites($mine: Boolean) { bites(mine: $mine) { user_id name end_time } }", "variables": { "mine": true } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "bites": [\ {\ "user_id": "user-id",\ "id": "bite-id",\ },\ {\ "user_id": "user-id",\ "id": "bite-id-2",\ }\ ] } } [​](https://docs.fireflies.ai/graphql-api/query/bites#error-codes) Error Codes --------------------------------------------------------------------------------- List of possible error codes that may be returned by the `bites` query. Full list of error codes can be found [here](https://docs.fireflies.ai/miscellaneous/error-codes) . args\_required You must provide at least one of the following arguments: `mine`, `transcript_id`, `my_team` to the bites query [​](https://docs.fireflies.ai/graphql-api/query/bites#additional-resources) Additional Resources --------------------------------------------------------------------------------------------------- [Bite\ ----\ \ Querying bite details](https://docs.fireflies.ai/graphql-api/query/bite) [Create Bite\ -----------\ \ Use the API to create a bite](https://docs.fireflies.ai/graphql-api/mutation/create-bite) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/query/bites.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/query/bites) [Bite](https://docs.fireflies.ai/graphql-api/query/bite) [Add to Live](https://docs.fireflies.ai/graphql-api/mutation/add-to-live) ⌘I --- # Users query - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/query/users#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Query Users curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "{ users { name integrations } }" }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "users": [\ {\ "name": "Justin Fly",\ "integrations": []\ },\ {\ "name": "Peter Fire",\ "integrations": []\ }\ ] } } [​](https://docs.fireflies.ai/graphql-api/query/users#overview) Overview --------------------------------------------------------------------------- The users query is designed to fetch a list of all users within the team. You can also view this list on your dashboard at [app.fireflies.ai/team](http://app.fireflies.ai/team) [​](https://docs.fireflies.ai/graphql-api/query/users#schema) Schema ----------------------------------------------------------------------- Fields available to the [User](https://docs.fireflies.ai/schema/user) query [​](https://docs.fireflies.ai/graphql-api/query/users#usage-example) Usage Example ------------------------------------------------------------------------------------- Copy Ask AI query Users { users { user_id email name num_transcripts recent_meeting minutes_consumed is_admin integrations user_groups { id name handle members { user_id first_name last_name email } } } } curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "{ users { name integrations } }" }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "users": [\ {\ "name": "Justin Fly",\ "integrations": []\ },\ {\ "name": "Peter Fire",\ "integrations": []\ }\ ] } } [​](https://docs.fireflies.ai/graphql-api/query/users#additional-resources) Additional Resources --------------------------------------------------------------------------------------------------- [User\ ----\ \ Querying user details](https://docs.fireflies.ai/graphql-api/query/user) [Set User Role\ -------------\ \ Use the API to set user roles](https://docs.fireflies.ai/graphql-api/mutation/set-user-role) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/query/users.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/query/users) [User](https://docs.fireflies.ai/graphql-api/query/user) [User Groups](https://docs.fireflies.ai/graphql-api/query/user-groups) ⌘I --- # Set User Role - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/mutation/set-user-role#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Mutation Set User Role curl javascript python java Copy Ask AI curl -X POST https://api.fireflies.ai/graphql \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{ "query": "mutation($user_id: String!, $role: Role!) { setUserRole(user_id: $user_id, role:$role) { name is_admin } }", "variables": { "user_id": "your_user_id", "role": "admin" } }' Response Copy Ask AI { "data": { "setUserRole": { "name": "Justin Fly", "is_admin": "true", } } } [​](https://docs.fireflies.ai/graphql-api/mutation/set-user-role#overview) Overview -------------------------------------------------------------------------------------- The `setUserRole` mutation allows for the updating of a user’s role within a team. [​](https://docs.fireflies.ai/graphql-api/mutation/set-user-role#arguments) Arguments ---------------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/mutation/set-user-role#param-user-id) user\_id String required The unique identifier of the user. [​](https://docs.fireflies.ai/graphql-api/mutation/set-user-role#param-role) role Role required The [Role](https://docs.fireflies.ai/schema/input/role) to be assigned to the user. Valid types for user are `admin` and `user` [​](https://docs.fireflies.ai/graphql-api/mutation/set-user-role#usage-example) Usage Example ------------------------------------------------------------------------------------------------ To set a user’s role, provide the user’s ID and the desired role as arguments to the mutation. Here’s an example of how this mutation could be used: Copy Ask AI mutation setUserRole($userId: String!, $role: Role!) { setUserRole(user_id: $userId, role: $role) { id name email role } } curl javascript python java Copy Ask AI curl -X POST https://api.fireflies.ai/graphql \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{ "query": "mutation($user_id: String!, $role: Role!) { setUserRole(user_id: $user_id, role:$role) { name is_admin } }", "variables": { "user_id": "your_user_id", "role": "admin" } }' Response Copy Ask AI { "data": { "setUserRole": { "name": "Justin Fly", "is_admin": "true", } } } [​](https://docs.fireflies.ai/graphql-api/mutation/set-user-role#error-codes) Error Codes -------------------------------------------------------------------------------------------- List of possible error codes that may be returned by the `setUserRole` mutation. Full list of error codes can be found [here](https://docs.fireflies.ai/miscellaneous/error-codes) . object\_not\_found (team) This may indicate that you are not a part of any team. Please contact support if you encounter this error not\_in\_team The user ID you are trying to query is not in your team. require\_elevated\_privilege The user does not have admin privileges to set the user role. admin\_must\_exist The team must have at least one admin. Please add an admin to the team or contact support if you encounter this error. invalid\_args An invalid argument was provided to the mutation for the `role` field. Please check the arguments you are providing and try again. [​](https://docs.fireflies.ai/graphql-api/mutation/set-user-role#additional-resources) Additional Resources -------------------------------------------------------------------------------------------------------------- [Users\ -----\ \ Querying list of users](https://docs.fireflies.ai/graphql-api/query/users) [User\ ----\ \ Querying user details](https://docs.fireflies.ai/graphql-api/query/user) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/mutation/set-user-role.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/mutation/set-user-role) [Delete Transcript](https://docs.fireflies.ai/graphql-api/mutation/delete-transcript) [Upload Audio](https://docs.fireflies.ai/graphql-api/mutation/upload-audio) ⌘I --- # Update Meeting Privacy - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Mutation Update Meeting Privacy curl javascript python java Copy Ask AI curl -X POST https://api.fireflies.ai/graphql \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{ "query": "mutation($input: UpdateMeetingPrivacyInput!) { updateMeetingPrivacy(input: $input) { id title privacy } }", "variables": { "input": { "id": "your_transcript_id", "privacy": "teammates" } } }' Response Copy Ask AI { "data": { "updateMeetingPrivacy": { "id": "your_transcript_id", "title": "Meeting Title", "privacy": "teammates" } } } [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy#overview) Overview ----------------------------------------------------------------------------------------------- The `updateMeetingPrivacy` mutation allows for updating the privacy setting of a meeting transcript. This operation requires admin privileges within the team or ownership of the meeting. [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy#arguments) Arguments ------------------------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy#param-input) input UpdateMeetingPrivacyInput required The privacy setting to be assigned to the meeting / transcript. See [UpdateMeetingPrivacyInput](https://docs.fireflies.ai/schema/input/update-meeting-privacy-input) . [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy#usage-example) Usage Example --------------------------------------------------------------------------------------------------------- To update a meeting’s privacy setting, provide the transcript ID and the new privacy level as arguments to the mutation. Here’s an example of how this mutation could be used: Copy Ask AI mutation UpdateMeetingPrivacy($input: UpdateMeetingPrivacyInput!) { updateMeetingPrivacy(input: $input) { id title privacy } } curl javascript python java Copy Ask AI curl -X POST https://api.fireflies.ai/graphql \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ -d '{ "query": "mutation($input: UpdateMeetingPrivacyInput!) { updateMeetingPrivacy(input: $input) { id title privacy } }", "variables": { "input": { "id": "your_transcript_id", "privacy": "teammates" } } }' Response Copy Ask AI { "data": { "updateMeetingPrivacy": { "id": "your_transcript_id", "title": "Meeting Title", "privacy": "teammates" } } } [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy#faq) FAQ ------------------------------------------------------------------------------------- Who has permission to update meeting privacy? Only users with admin privileges or meeting owners can update meeting privacy settings. The meeting owner also needs to be in your team. What privacy levels are available? Available privacy levels are: link (anyone with link), owner (meeting owner only), participants (meeting participants only), teammatesandparticipants (teammates and participants), teammates (teammates only). [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy#error-codes) Error Codes ----------------------------------------------------------------------------------------------------- List of possible error codes that may be returned by the `updateMeetingPrivacy` mutation. Full list of error codes can be found [here](https://docs.fireflies.ai/miscellaneous/error-codes) . require\_elevated\_privilege The user must be either the meeting owner or a team admin to update meeting privacy. object\_not\_found (transcript) The specified transcript could not be found or you do not have access to it [​](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-privacy#additional-resources) Additional Resources ----------------------------------------------------------------------------------------------------------------------- [Transcript\ ----------\ \ Querying transcript details](https://docs.fireflies.ai/graphql-api/query/transcript) [Update Meeting Title\ --------------------\ \ Use the API to update meeting titles](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-title) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/mutation/update-meeting-privacy.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/mutation/update-meeting-privacy) [Update Meeting Title](https://docs.fireflies.ai/graphql-api/mutation/update-meeting-title) [Webhooks](https://docs.fireflies.ai/graphql-api/webhooks) ⌘I --- # Analytics query - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/query/analytics#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Query Analytics curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query Analytics($startTime: String, $endTime: String) { analytics(start_time: $startTime, end_time: $endTime) { team { conversation { average_filler_words } } } }", "variables": { "startTime": "2024-01-01T00:00:00Z", "endTime": "2024-01-31T23:59:59Z" } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "analytics": { "team": { "conversation": { "average_filler_words": 15 } } } } } [​](https://docs.fireflies.ai/graphql-api/query/analytics#overview) Overview ------------------------------------------------------------------------------- The analytics query fetches detailed conversation and meeting metrics for teams and users across a specified date range. [​](https://docs.fireflies.ai/graphql-api/query/analytics#arguments) Arguments --------------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/query/analytics#param-start-time) start\_time String The `start_time` parameter filters results starting from a specific datetime (ISO 8601 format). [​](https://docs.fireflies.ai/graphql-api/query/analytics#param-end-time) end\_time String The `end_time` parameter filters results up to a specific datetime (ISO 8601 format). [​](https://docs.fireflies.ai/graphql-api/query/analytics#schema) Schema --------------------------------------------------------------------------- Fields available to the [Analytics](https://docs.fireflies.ai/schema/analytics) query. [​](https://docs.fireflies.ai/graphql-api/query/analytics#usage-example) Usage Example ----------------------------------------------------------------------------------------- Copy Ask AI query Analytics($startTime: String, $endTime: String) { analytics(start_time: $startTime, end_time: $endTime) { team { conversation { average_filler_words average_filler_words_diff_pct average_monologues_count average_monologues_count_diff_pct average_questions average_questions_diff_pct average_sentiments { negative_pct neutral_pct positive_pct } average_silence_duration average_silence_duration_diff_pct average_talk_listen_ratio average_words_per_minute longest_monologue_duration_sec longest_monologue_duration_diff_pct total_filler_words total_filler_words_diff_pct total_meeting_notes_count total_meetings_count total_monologues_count total_monologues_diff_pct teammates_count total_questions total_questions_diff_pct total_silence_duration total_silence_duration_diff_pct } meeting { count count_diff_pct duration duration_diff_pct average_count average_count_diff_pct average_duration average_duration_diff_pct } } users { user_id user_name user_email conversation { talk_listen_pct talk_listen_ratio total_silence_duration total_silence_duration_compare_to total_silence_pct total_silence_ratio total_speak_duration total_speak_duration_with_user total_word_count user_filler_words user_filler_words_compare_to user_filler_words_diff_pct user_longest_monologue_sec user_longest_monologue_compare_to user_longest_monologue_diff_pct user_monologues_count user_monologues_count_compare_to user_monologues_count_diff_pct user_questions user_questions_compare_to user_questions_diff_pct user_speak_duration user_word_count user_words_per_minute user_words_per_minute_compare_to user_words_per_minute_diff_pct } meeting { count count_diff count_diff_compared_to count_diff_pct duration duration_diff duration_diff_compared_to duration_diff_pct } } } } curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query Analytics($startTime: String, $endTime: String) { analytics(start_time: $startTime, end_time: $endTime) { team { conversation { average_filler_words } } } }", "variables": { "startTime": "2024-01-01T00:00:00Z", "endTime": "2024-01-31T23:59:59Z" } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "analytics": { "team": { "conversation": { "average_filler_words": 15 } } } } } [​](https://docs.fireflies.ai/graphql-api/query/analytics#error-codes) Error Codes ------------------------------------------------------------------------------------- List of possible error codes that may be returned by the `analytics` query. Full list of error codes can be found [here](https://docs.fireflies.ai/miscellaneous/error-codes) . paid\_required (business\_or\_higher) You need to be on a Business or higher plan to query analytics. require\_elevated\_privilege The user does not have admin privileges to view analytics for team. [​](https://docs.fireflies.ai/graphql-api/query/analytics#additional-resources) Additional Resources ------------------------------------------------------------------------------------------------------- [Transcripts\ -----------\ \ Querying list of transcripts](https://docs.fireflies.ai/graphql-api/query/transcripts) [Users\ -----\ \ Querying list of users](https://docs.fireflies.ai/graphql-api/query/users) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/query/analytics.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/query/analytics) [Advanced](https://docs.fireflies.ai/examples/advanced) [AI Apps](https://docs.fireflies.ai/graphql-api/query/apps) ⌘I --- # User query - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/graphql-api/query/user#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Query User curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query User($userId: String!) { user(id: $userId) { name integrations } }", "variables": { "userId": "your_user_id" } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "user": { "name": "Justin Fly", "integrations": ["string"], } } } [​](https://docs.fireflies.ai/graphql-api/query/user#overview) Overview -------------------------------------------------------------------------- The user query is designed to fetch details associated with a specific user id. [​](https://docs.fireflies.ai/graphql-api/query/user#arguments) Arguments ---------------------------------------------------------------------------- [​](https://docs.fireflies.ai/graphql-api/query/user#param-id) id String `id` is an optional argument. Not passing an ID to this query will return user details for the owner of the API key [​](https://docs.fireflies.ai/graphql-api/query/user#schema) Schema ---------------------------------------------------------------------- Fields available to the [User](https://docs.fireflies.ai/schema/user) query [​](https://docs.fireflies.ai/graphql-api/query/user#usage-example) Usage Example ------------------------------------------------------------------------------------ Copy Ask AI query User($userId: String!) { user(id: $userId) { user_id recent_transcript recent_meeting num_transcripts name minutes_consumed is_admin integrations email user_groups { id name handle members { user_id first_name last_name email } } } } curl javascript python java Copy Ask AI curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your_api_key" \ --data '{ "query": "query User($userId: String!) { user(id: $userId) { name integrations } }", "variables": { "userId": "your_user_id" } }' \ https://api.fireflies.ai/graphql Response Copy Ask AI { "data": { "user": { "name": "Justin Fly", "integrations": ["string"], } } } [​](https://docs.fireflies.ai/graphql-api/query/user#error-codes) Error Codes -------------------------------------------------------------------------------- List of possible error codes that may be returned by the `user` query. Full list of error codes can be found [here](https://docs.fireflies.ai/miscellaneous/error-codes) . object\_not\_found (user) The user ID you are trying to query does not exist. not\_in\_team The user ID you are trying to query is not in your team. [​](https://docs.fireflies.ai/graphql-api/query/user#additional-resources) Additional Resources -------------------------------------------------------------------------------------------------- [Users\ -----\ \ Querying list of users](https://docs.fireflies.ai/graphql-api/query/users) [User Groups\ -----------\ \ Querying user groups](https://docs.fireflies.ai/graphql-api/query/user-groups) Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/graphql-api/query/user.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/graphql-api/query/user) [AI Apps](https://docs.fireflies.ai/graphql-api/query/apps) [Users](https://docs.fireflies.ai/graphql-api/query/users) ⌘I --- # Attendee Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/input/attendee#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Input Attendee [​](https://docs.fireflies.ai/schema/input/attendee#param-display-name) displayName String Display name of the attendee as it appears in meeting platforms like Google Chat, Zoom, etc. [​](https://docs.fireflies.ai/schema/input/attendee#param-email) email String Email address of the attendee.Maximum length is 20 characters. [​](https://docs.fireflies.ai/schema/input/attendee#param-phone-number) phoneNumber String Phone number of the attendee. Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/input/attendee.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/input/attendee) [AudioUploadInput](https://docs.fireflies.ai/schema/input/audio-upload-input) [Role](https://docs.fireflies.ai/schema/input/role) ⌘I --- # UpdateMeetingTitleInput Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/input/update-meeting-title-input#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Input UpdateMeetingTitleInput [​](https://docs.fireflies.ai/schema/input/update-meeting-title-input#param-title) title String required The new title to be assigned to the meeting / transcript. The title must be a string between 5 and 250 characters long and should not contain any special characters.Min / max of 5 / 256 characters. [​](https://docs.fireflies.ai/schema/input/update-meeting-title-input#param-id) id String required The unique identifier of the meeting / transcript. Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/input/update-meeting-title-input.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/input/update-meeting-title-input) [Role](https://docs.fireflies.ai/schema/input/role) [UpdateMeetingPrivacyInput](https://docs.fireflies.ai/schema/input/update-meeting-privacy-input) ⌘I --- # Role Schema - Fireflies.ai API Documentation [Skip to main content](https://docs.fireflies.ai/schema/input/role#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Input Role [​](https://docs.fireflies.ai/schema/input/role#param-role) role enum Valid types for role are `admin` and `user` Was this page helpful? YesNo [Suggest edits](https://github.com/firefliesai/public-api-ff/edit/master/docs/schema/input/role.mdx) [Raise issue](https://github.com/firefliesai/public-api-ff/issues/new?title=Issue%20on%20docs&body=Path:%20/schema/input/role) [Attendee](https://docs.fireflies.ai/schema/input/attendee) [UpdateMeetingTitleInput](https://docs.fireflies.ai/schema/input/update-meeting-title-input) ⌘I --- # Page Not Found [Skip to main content](https://docs.fireflies.ai/schema/attendee#content-area) [Fireflies home page![light logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/light.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=89d57b6f64984918e600fab4b327d867)![dark logo](https://mintcdn.com/firefliesai/1yZ69Sj9FG7Gc0Ag/logo/dark.svg?fit=max&auto=format&n=1yZ69Sj9FG7Gc0Ag&q=85&s=46855320026ba559f9e81763bda4d1eb)](https://fireflies.ai/) Search... ⌘K Search... Navigation Page Not Found 404 Page Not Found ============== We couldn't find the page. Maybe you were looking for one of these pages below? [Attendee](https://docs.fireflies.ai/schema/input/attendee#) [AudioUploadInput](https://docs.fireflies.ai/schema/input/audio-upload-input#) [General concepts](https://docs.fireflies.ai/fundamentals/concepts#schema-definition) ⌘I ---