Welcome to the FORA API

Getting Started / AuthorizationCopied!

Reach out to your FORA point of contact to get an API key for your integration. You can then use this key to authorize your API requests by appending the following header to your request:

X-Fora-Key: <API KEY GOES HERE>

<

What Data Is Accessible?Copied!

Your integration-specific API key can access all data made available via the endpoints described in the “Reference” section of this site.

Exception: if you are retrieving Meeting data, your key will not return any Meeting data for Meetings with the sensitive: true flag set — this indicates that a Meeting was marked “private” by one of the participants.

Quickstart Guide: Searching for Meetings with Associated TranscriptsCopied!

1. Call the POST /meetings/search endpoint with relevant parameters to find one or more meetings you are interested in.

   1. Example: specify the start_at_from and start_at_to parameters to retrieve meetings that begin within a certain datetime range.

2. Every Meeting record with a transcript will have EITHER a meeting.bot_id OR a meeting.linked.bot_id property. Retrieve this for use in step 3.

   1. The difference has to do with the “calendar event” that a transcription bot gets attached to, which probably doesn’t matter for your use case

   2. If a meeting does not have either of these properties, then it was not recorded / transcribed.

3. Take that bot_id from step 2 and pass it into the GET /recall/bots/{id}/vtt endpoint, where the {id} is the bot_id. This will return a nicely formatted transcript for the meeting with speaker names, speaking times, and full segments assembled nicely for consumption.

   1. You do have the option of using the GET /recall/bots/{id}/transcripts endpoint for a JSON representation, but this data is not assembled into complete sentences and is intended for more programmatic use cases.

4. You’re done! You should now have a meeting object with a boatload of attached data and a transcript of that meeting, if available.