Getting Started

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

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

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:

x-api-key: your_api_key

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:

Authorization: Bearer your_access_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 resources (like transcripts and media) that you want to analyze.

List Projects

GET /v1/projects/

Example response:

{
  "projects": [
    {
      "id": "proj_123",
      "name": "Customer Interview Analysis",
      "description": "Q4 customer feedback analysis",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "ownerId": "user_123",
      "organizationId": "org_123",
      "keywords": ["feedback", "support"],
      "embeddingModel": "text_embedding_3_small"
    }
  ]
}

Create Project

POST /v1/projects/
Content-Type: application/json

{
  "name": "New Research Project",
  "description": "Analysis of user interviews",
  "organization_id": "org_123"
}

Resources

Resources are the actual content you want to analyze. The API supports several types of resources:

Transcripts
Media files
Combined transcript and media
Research activities with responses

Add Resource to Project

POST /v1/projects/{projectId}/resources/
Content-Type: application/json

{
  "external_id": "interview_123",
  "name": "Customer Interview #1",
  "data": {
    "transcript": {
      "speakers": [
        {
          "id": "speaker_1",
          "name": "Interviewer",
          "role": "moderator"
        },
        {
          "id": "speaker_2",
          "name": "Participant",
          "role": "participant"
        }
      ],
      "speech_turns": [
        {
          "speaker_id": "speaker_1",
          "content": "Can you tell me about your experience?"
        }
      ]
    }
  }
}

Common Patterns

Resource Types

The API supports different types of analysis content:

Interview Transcripts
- Structured conversation data
- Speaker identification
- Timestamped speech turns
Research Activities
- Multi-respondent studies
- Task-based responses
- Mixed media support (text, audio, video, images)
Media Files
- Audio recordings
- Video content
- Images with captions

Storage Considerations

Projects can specify a storageRegion (us, uk, eu)
Media files require a two-step process:
1. Create resource and receive upload URLs
2. Upload media to provided URLs

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
Add some resources for analysis
Explore the detailed API documentation at https://api.coloop.ai/docs/

Setting up a project

Concept Testing

Analysis Grids

Analysis Chat

Tips & Outputs

Supported File Formats

Open Ends Analysis

Collaboration & Access Management

Recording Live Interviews

Compliance

Troubleshooting

API

Getting Started

API Information

Authentication

API keys

OAuth 2.0

Find your organization ID

Core Resources

Projects

List Projects

Create Project

Resources

Add Resource to Project

Common Patterns

Resource Types

Storage Considerations

Support

Next Steps

​API Information

​Authentication

​API keys

​OAuth 2.0

​Find your organization ID

​Core Resources

​Projects

​List Projects

​Create Project

​Resources

​Add Resource to Project

​Common Patterns

​Resource Types

​Storage Considerations

​Support

​Next Steps

API Information

Authentication

API keys

OAuth 2.0

Find your organization ID

Core Resources

Projects

List Projects

Create Project

Resources

Add Resource to Project

Common Patterns

Resource Types

Storage Considerations

Support

Next Steps