Skip to main content

​
Overview

The transcripts query is designed to fetch a list of transcripts against input arguments.

​
Arguments

​
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.
​
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.
​
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.
  • all: Search within title and sentences.
​
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.
​
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.
​
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
​
limit
Int
Number of transcripts to return. Maxiumum 50 in one query
​
skip
Int
Number of transcripts to skip.
​
host_email
String
Filter all meetings accordingly to meetings that have this email as the host.
​
organizer_email
String
This field is deprecated. Please use organizers instead. Filter meetings that have this email as the organizer.
​
participant_email
String
This field is deprecated. Please use participants instead. Filter meetings that contain this email as an attendee.
​
user_id
String
User id. Filter all meetings that have this user ID as the organizer or participant.
​
mine
Boolean
Filter all meetings that have the API key owner as the organizer.
​
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.
​
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.
​
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.

​
Schema

Fields available to the Transcript query

​
Usage Example

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

{
  "data": {
    "transcripts": [
		{
			"title": "Weekly sync",
			"id": "transcript-id",
		},
		{
			"title": "ClientMeeting.mp3",
			"id": "transcript-id-2",
		}
	]
  }
}

​
Error Codes

List of possible error codes that may be returned by the transcripts query. Full list of error codes can be found here.

The user ID you are trying to query does not exist or you do not have access to it.

​
Additional Resources

Transcript

Querying transcript details

Upload Audio

Use the API to upload audio to Fireflies.ai