Skip to main content
The CoLoop API enables data collection platform (DCP) developers to integrate CoLoop’s AI content analysis capabilities into their applications. This guide will help you get started with the API.

API Information

All API requests should be made to: 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 the x-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:
  1. Select your organization from the workspace switcher.
  2. Open the organization settings, then select API keys.
  3. 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

Example response:

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 (type is audio or video)
  • A text-only transcript (type is text)
  • An audio or video recording without a transcript

Import a recording with its transcript

Send speakers and turns with the recording. CoLoop analyzes the transcript as soon as it is imported.

Import a recording without a transcript

Leave out both speakers 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

  • externalId must be unique within the project. Sending the same externalId again returns skipped instead of creating a duplicate. If the existing recording shows as “Upload failed” in CoLoop, the result also has uploadFailed: true and a message that says what to do: delete the file in CoLoop and send it again.
  • CoLoop downloads each recording from media.downloadUrl after it responds. Keep the URL reachable for at least one hour.
  • Recordings larger than 5 GB are not supported.
  • Always send media.mimeType with pre-signed URLs, such as Amazon S3 links.
See the API documentation for every field and rule.

Support

During the Alpha phase, contact the CoLoop team for:
  • OAuth application setup
  • API access questions
  • Integration support
  • Feature requests

Next Steps

  1. Set up your OAuth application with CoLoop
  2. Create your first project
  3. Import your transcripts and recordings
  4. Explore the detailed API documentation at https://api.coloop.ai/docs/