Fireflies.ai API Essential Guide

What type of API does Fireflies.ai provide?

Based on the search results provided, Fireflies.ai has a GraphQL API. Here are the key points:

API Type

Fireflies.ai uses a GraphQL API. GraphQL is a powerful query language designed for APIs, offering clients the ability to request exactly what they need and nothing more.

Key Features of the Fireflies.ai GraphQL API

1. Precise Data Fetching: The API allows you to retrieve exactly the data you need in a structured format, eliminating over-fetching of data common in traditional REST APIs.

2. Single Endpoint: Unlike REST APIs with multiple endpoints, GraphQL operates through a single endpoint, simplifying API interactions and management.

3. Flexibility and Scalability: The API is designed to be flexible and can evolve with your needs, making it suitable for both small projects and large-scale applications.

API Functionality

The Fireflies.ai API covers various functionalities, including:

• Queries for fetching data
• Uploading meeting audio
• Extracting relevant information from transcripts using a pre-built NLP layer
• Filtering transcript data based on custom topic categories
• Accessing team-wide information
• Assigning user roles

Best Practices

When using the Fireflies.ai GraphQL API, it's recommended to:

1. Optimize query performance by requesting only necessary data.
2. Use variables in queries to enhance readability and flexibility.

Authentication

The Fireflies API requires a valid API key for all requests. Users should refer to the Authorization section in the documentation for more information.

Does the Fireflies.ai API have webhooks?

Yes, the official Fireflies.ai API does offer webhooks. Here are the key points about Fireflies.ai webhooks:

Webhook Availability

• Fireflies.ai provides webhook functionality as part of their API.

Types of Webhooks

1. Global webhook:

   • Can be set up to send notifications for all subscribed events.
   • Configured in the Fireflies.ai dashboard settings under the Developer settings tab.

2. Per-upload webhook:

   • Can be included as part of an individual audio upload request.
   • Only sends notifications for that specific audio upload.

Webhook Events

The documentation does not provide an exhaustive list of event types, but mentions:

• An "eventType" field is included in the webhook payload to indicate the type of event that triggered the webhook.

Webhook Payload

The webhook payload includes:

• meetingId: Identifier for the meeting/transcript (required)
• eventType: Name of the event type that triggered the webhook
• clientReferenceId: Custom identifier set by the user during upload (optional)

Setting Up Webhooks

1. For global webhooks:

   • Visit the Fireflies.ai dashboard settings
   • Navigate to the Developer settings tab
   • Enter a valid HTTPS URL in the webhooks field and save

2. For per-upload webhooks:

   • Include the webhook URL as part of the audio upload request

Testing Webhooks

You can test your webhook using:

• The upload audio API
• Uploading through the dashboard at app.fireflies.ai/upload

While the documentation doesn't provide an exhaustive list of event types, it's clear that Fireflies.ai supports webhooks for various events related to meeting transcriptions and audio uploads. For more detailed information on specific event types, it would be best to consult their API documentation or contact their support team directly.

Rate Limits and other limitations

Based on the search results provided, here are the key details about the API Rate Limits for Fireflies.ai:

API Rate Limits

The Fireflies.ai API enforces rate limits based on the type of subscription plan:

1. Free and Pro Plans:

   • Limited to 50 API requests per day
   • Suitable for testing and small-scale applications

2. Business and Enterprise Plans:

   • Allow up to 60 requests per minute
   • Designed for more demanding use cases and higher volume demands

Key Points to Consider

• The rate limits are in place to maintain the quality of service and availability for all users.
• Free and Pro plans are ideal for light to moderate usage, while Business and Enterprise plans are suitable for larger applications and higher volume demands.
• These limits apply specifically to API requests and are separate from other usage limits like transcription credits.

Best Practices

1. Monitor your API usage to ensure you stay within the limits for your plan.
2. If you're approaching the limits on a Free or Pro plan, consider upgrading to a Business or Enterprise plan for increased capacity.
3. Implement proper error handling in your application to gracefully manage cases where you might exceed the rate limit.
4. For high-volume applications, consider using the Business or Enterprise plans to take advantage of the higher request limits.

Additional Information

• The API also has upload limits for audio and video files, which vary based on the user's plan.
• Fireflies.ai offers various features through their API, including audio processing, transcript generation, and data extraction.
• For users requiring higher volumes, Fireflies.ai offers volume discounts for plans with more than 50 members.

It's important to note that these rate limits are specific to the API and may not apply to other Fireflies.ai services or features. Always refer to the most up-to-date documentation for the latest information on API usage and limits.

Latest API Version

Based on the search results provided, I can answer your question about the most recent version of the Fireflies.ai API.

Most Recent Version

The most recent version of the Fireflies.ai API is version 2.3.8.

Key Points to Consider

1. The Fireflies API uses GraphQL, which provides efficient and flexible access to data.

2. The API covers various functionalities, including queries for fetching data and uploading meeting audio.

3. Fireflies maintains a chronologically ordered changelog to track notable changes for each version of their API.

4. The API allows developers to integrate Fireflies.ai with various conference software, dialers, and other third-party applications.

Recent Updates and Features

• Version 2.3.8 fixed a bug in the Transcripts query for the fireflies_users field.

• Version 2.3.6 updated the documentation for webhooks to include webhook schema.

• The API provides features such as audio uploading, transcript generation, and custom NLP (Natural Language Processing) capabilities.

Best Practices

1. Always refer to the latest documentation when working with the API, as features and endpoints may change or be updated.

2. Make use of the GraphQL interface to request only the data you need, which can improve efficiency and reduce unnecessary data transfer.

3. Be aware of any rate limits or usage restrictions that may apply to your API access level.

4. Implement proper security measures when handling sensitive meeting data, as Fireflies emphasizes security and access controls.

By using the most recent version of the Fireflies.ai API (2.3.8), you can ensure that you have access to the latest features and bug fixes for your integration needs.

How to get a Fireflies.ai developer account and API Keys?

Obtaining API Access

1. Sign up for a Fireflies.ai Business plan, which includes API access.

2. Once you have a Business plan, you'll be able to access the API documentation and obtain API credentials.

Key Points to Consider

• API access is only available on the Business tier plan, not on Free or Pro plans.
• You'll need to handle your API key securely to protect your data.
• Fireflies uses GraphQL for its API, so you'll need to be familiar with GraphQL queries.

Using the API

1. Obtain your API key from your Fireflies.ai account settings.
2. Use the API key in the Authorization header when making requests.
3. Construct GraphQL queries to interact with the Fireflies.ai API.

Best Practices

• Start with simple queries and gradually increase complexity.
• Only request the data you need to avoid over-fetching.
• Use tools like GraphQL Playground for testing your queries.
• Review the Schema documentation for guidance on available queries and mutations.

Additional Resources

• Fireflies provides detailed API documentation, including a quickstart guide and schema information.
• You can find example queries and responses in the documentation to help you get started.

What can you do with the Fireflies.ai API?

Based on the provided search results, here is a list of data models you can interact with using the Fireflies.ai API, along with what is possible for each:

User

• Retrieve user information such as user ID and email
• Get team-wide information and perform actions on user data
• Access user role information

Meeting

• Find a specific meeting by its unique ID
• Retrieve the most recent meeting for a user
• Create and store new meetings for transcription and sharing
• Access meeting transcripts and recordings

Transcript

• Retrieve transcripts for meetings
• Search within meeting transcripts
• Access transcripts in multiple languages (69+ supported)

Audio

• Upload audio files for transcription
• Process audio to generate transcripts

Speaker

• Access speaker labels and names (for Google Meet & Zoom)
• Retrieve speaker data as Speaker 1, Speaker 2, etc. for other platforms

AI Filter

• Extract relevant information from transcripts using pre-built NLP layer
• Filter transcript data based on custom topic categories
• Access AI-generated insights such as pricing, sentiment, next steps, dates, and deadlines

Summary

• Retrieve AI-generated meeting summaries

Bite

• Create and access "soundbites" or clips from meetings

Channel

• Organize meetings into channels
• Access public and private channels (depending on plan)

Task

• Create tasks using voice commands during meetings (with integrations)

Integration Data

• Access and manage data related to various integrations (CRM, collaboration tools, etc.)

Analytics

• Access conversation intelligence data (on higher-tier plans)
• Retrieve team insights (for admins on higher-tier plans)

While not explicitly mentioned as data models, the API also allows for:

• Searching across meetings and transcripts
• Accessing comments and reactions on meeting content
• Managing user groups (on higher-tier plans)

It's important to note that the availability of certain data models and functionalities may depend on the specific plan or tier of the Fireflies.ai service being used.