Media Transcripts API
Overview
Accessing the transcribed text of your media files allows you to easily search, analyze, and utilize the spoken content. This feature helps you quickly find key information within audio or video recordings without having to manually review them.
By providing a structured transcript, you can integrate spoken content into your workflows, generate summaries, or even power search functionalities within your applications.
How It Works
You can retrieve the transcript for a specific media file by using a dedicated API endpoint. This endpoint requires the unique ID of the media file you wish to access.
Getting Started
To access this feature, go to API Docs in your dashboard.
API Endpoint
To retrieve the transcript for a specific media file, you can use the following GET endpoint:
https://api.speakai.co/v1/media/transcript/:mediaId
Replace :mediaId with the actual ID of the media file you want to access.
Response Format
The API returns a JSON object containing the transcript data. Key fields include:
mediaId: The ID of the media file.insight.transcript: An array of sentence objects, each containing:text: The transcribed text.start: Start time in seconds.end: End time in seconds.speaker: Speaker identification (if available).
insight.speakers: List of speakers identified in the transcript.mediaUrl: A temporary signed URL to access the media file (if applicable).
Example Request
curl -X GET "https://api.speakai.co/v1/media/transcript/:mediaId" \
-H "Authorization: Bearer YOUR_API_KEY"
Notes
Ensure your API key has the necessary permissions to access the media file.
If the media is still processing, the transcript might be incomplete or the endpoint might return a processing status.
The
mediaUrlprovided is temporary and for immediate access only.
Next Steps
Ready to get started?
Access the API documentation to find your API key and learn more about integration.
Try retrieving a transcript for one of your media files using the example request.
Explore the response data to understand how to use the transcript in your applications.
Need help? Contact our support team or check out our other guides.