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
  2. Navigate to the Integrations section
  3. Click on Fireflies API
  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

​
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 \
   -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 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

​
Step 3: Analyzing the Response

You will receive a JSON response with the requested data. Example response: 
{
	"data":
	{
		"users": [
			{
				"name":"Justin Fly",
				"user_id":"example-id"
			}
		]
	}
}
Continue to the next sections for more detailed examples and advanced usage instructions.

​
Additional Resources

Introduction

Fireflies public API documentation.

Chat with Fireflies AI Assistant

Navigate Fireflies.ai Documentation using the AI Assistant