Skip to main content

API

How to access, set up and use our API

Written by Suellen Lorga

The tl;dv API allows you to import meetings, retrieve meeting data, access transcripts and notes, and build custom integrations with your workflows. This article covers API access requirements, authentication, permissions, and the available endpoints.

API access is available on the Pro or Business plans only.


Before You Start

To use the tl;dv API, you'll need:

  • A Pro or Business plan

  • An active tl;dv account

  • An API key

  • A development environment capable of making HTTPS requests

⚠️ The tl;dv API is currently in v1alpha1. As an alpha release, endpoints and functionality may change as we continue to improve the API.


Get Your API Key

  1. Navigate to Personal Settings > API Keys

  2. Generate a new API key

  3. Store the key securely

Your API key provides access to your tl;dv data. Treat it like a password and do not share it publicly.


Authenticate API Requests

Include your API key in the x-api-key header for every request:

x-api-key: YOUR_API_KEY

All requests must be made over HTTPS.

Requests that are missing a valid API key will return an authentication error.


API Endpoint

Current production endpoint:

https://pasta.tldv.io

⚠️ This endpoint may change in future API versions. Any changes will be communicated in advance.


Understanding API Permissions

The tl;dv API follows the same permission model as the web application, with additional plan-based restrictions.

Meeting Visibility vs API Access

Being able to view a meeting in the tl;dv app does not automatically grant API access to that meeting.

Sharing controls visibility within the application, while API access depends on the meeting organizer's subscription plan.

Meeting Organizer Plan

View in App

API Access

Free

✅ If shared

❌ No

Pro

✅ Yes

✅ Yes

Business

✅ Yes

✅ Yes

Enterprise

✅ Yes

✅ Yes

Meeting Ownership

Meeting ownership is determined by:

  • The calendar invite organizer

  • The meeting organizer for spontaneous meetings

If your team relies on API exports or integrations:

  • Ensure the correct user schedules the meeting

  • Ensure the meeting organizer has an eligible plan

Sharing a meeting does not grant API export permissions.


Available API Endpoints

Import a Meeting

Import a meeting, recording, or media file from a publicly accessible URL.

Endpoint

POST /v1alpha1/meetings/import

Use this endpoint to upload recordings into tl;dv for processing.


List Meetings

Retrieve a paginated list of available meetings.

Endpoint

GET /v1alpha1/meetings

Returns meeting metadata including meeting IDs that can be used with other endpoints.


Get a Meeting

Retrieve details for a specific meeting.

Endpoint

GET /v1alpha1/meetings/{meetingId}

Returns information such as:

  • Meeting name

  • Date and time

  • Organizer

  • Invitees

  • Meeting URL

  • Duration


Download a Recording

Download a meeting recording file.

Endpoint

GET /v1alpha1/meetings/{meetingId}/download

The API returns a redirect to a signed download URL.

Important:

  • Signed URLs expire after 6 hours

  • Most HTTP clients automatically follow redirects

  • If redirects are disabled, use the Location header to access the file


Get a Transcript

Retrieve the completed transcript for a meeting.

Endpoint

GET /v1alpha1/meetings/{meetingId}/transcript

Returns transcript data in a structured format once transcription is complete.


Get Meeting Notes

Retrieve notes generated for a meeting.

Endpoint

GET /v1alpha1/meetings/{meetingId}/notes

Returns meeting notes in a structured, human-readable format.


Handling API Errors

When a request fails, the API returns a JSON response describing the issue.

Validation Errors (400)

Validation errors occur when request data is invalid or missing.

Example:

{
"message": "Invalid query params, check 'errors' property for more info.",
"errors": [
{
"property": "meetingType",
"constraints": {
"isEnum": "meetingType must be one of the following values: internal, external"
}
}
]
}

Review the validation details, update the request, and try again.


Authentication, Permission, and Server Errors

The following error types share a common format:

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found

  • 500 Server Error

Example:

{
"name": "NotFoundError",
"message": "Meeting not found"
}

Check both the HTTP status code and the error message to determine the next step.


API Documentation

For endpoint specifications, request schemas, response examples, and the OpenAPI definition, see the full API documentation:


Need Help?

If you need assistance with API access, permissions, or implementation, contact our support team:

You can also reach us through the chat widget in the tl;dv application.

Did this answer your question?