API Information
- Base URL:
https://api.coloop.ai - Current Version: v1
- API Documentation: Complete OpenAPI documentation available at https://api.coloop.ai/docs
- API Status: https://status.coloop.ai
https://api.coloop.ai/v1/
Authentication
CoLoop supports API keys and OAuth 2.0. Choose the method that matches your integration.API keys
Use an API key for an integration, script, or local tool tied to one CoLoop organization. Create and manage the key, then send it in thex-api-key header:
OAuth 2.0
Use OAuth 2.0 when your application authenticates individual CoLoop users. After completing the OAuth flow, send the access token as a Bearer token:Find your organization ID
Some API requests require the ID of the organization you want to work with. You can copy it from CoLoop:- Select your organization from the workspace switcher.
- Open the organization settings, then select API keys.
- Find Organization ID, then click Copy.
Core Resources
Projects
Projects are the main organizational unit in CoLoop. They contain the transcripts and recordings you want to analyze.List Projects
Create Project
storageRegion is optional and sets where the project’s data is stored: us, uk, eu, or au. The response returns the new project in data, including the id you use to import files.
Transcripts and recordings
You add interviews to a project with one endpoint. It accepts up to 100 items per request, and each item is one of:- A transcript with its audio or video recording (
typeisaudioorvideo) - A text-only transcript (
typeistext) - An audio or video recording without a transcript
Import a recording with its transcript
Sendspeakers and turns with the recording. CoLoop analyzes the transcript as soon as it is imported.
Import a recording without a transcript
Leave out bothspeakers and turns. CoLoop imports the file and it waits in the project until a project editor starts transcription in CoLoop. The API does not start transcription.
Response
Each item is processed independently and gets its own result:created, skipped, or failed.
What to know
externalIdmust be unique within the project. Sending the sameexternalIdagain returnsskippedinstead of creating a duplicate. If the existing recording shows as “Upload failed” in CoLoop, the result also hasuploadFailed: trueand amessagethat says what to do: delete the file in CoLoop and send it again.- CoLoop downloads each recording from
media.downloadUrlafter it responds. Keep the URL reachable for at least one hour. - Recordings larger than 5 GB are not supported.
- Always send
media.mimeTypewith pre-signed URLs, such as Amazon S3 links.
Support
During the Alpha phase, contact the CoLoop team for:- OAuth application setup
- API access questions
- Integration support
- Feature requests
Next Steps
- Set up your OAuth application with CoLoop
- Create your first project
- Import your transcripts and recordings
- Explore the detailed API documentation at https://api.coloop.ai/docs/

