​
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 to view explanations for error code types

message
String
required

Description of the error

code
String
required

Error code.

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.

extensions
Object

Contains useful metadata related to the error

Example
{
  "data": {},
  "errors": [
    {
      "message": "Error description",
	  "friendly": true,
      "code": "error_code",
      "extensions": {
        "code": "error_code",
        "status": http_status_code,
		... otherFields
      }
    }
  ]
}

​
Additional Resources

Limits

File size and API rate limits for the Fireflies API

Authorization

Authenticating your requests with the Fireflies API

Was this page helpful?

LimitsAuthorization