> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scoot.app/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Complete reference guide for Scoot Gateway API endpoints

## Welcome to Scoot API

The Scoot Gateway API provides secure access to Scoot Engage Data, allowing you to integrate transcription services, room, and user management into your applications.

<Note>
  Make sure you have a [Scoot account](/creating-a-scoot-account) and API key before getting started with these endpoints.
</Note>

## Base URL

All API requests should be made to:

```
https://api.scoot.app
```

## API Specification

The Scoot API follows OpenAPI 3.0 specification standards and includes endpoints for:

<CardGroup cols={2}>
  <Card title="Transcription" icon="microphone" href="/api-reference/transcription/get">
    Manage and retrieve transcription data
  </Card>

  <Card title="Social Events" icon="users" href="/api-reference/event/registration">
    Handle social event management
  </Card>

  <Card title="User Management" icon="user" href="/api-reference/user/get">
    User account and profile operations
  </Card>

  <Card title="Recording" icon="record-vinyl" href="/api-reference/recording/mine">
    Recording and media management
  </Card>
</CardGroup>

## Authentication

All API endpoints require authentication using an API key passed in the request header.

### API Key Header

Include your API key in every request:

```http theme={null}
X-API-Key: your-api-key-here
```

### Getting Your API Key

To obtain an API key for the Scoot Gateway API:

1. **Contact Scoot Support Team** by sending an email to [support@scoot.app](mailto:support@scoot.app)
2. **Include the following information** in your request:
   * Your Scoot account email address
   * Company name
   * Clear use case description
   * Realistic usage estimates
   * Preferred environment (dev/staging/prod)
   * Technical contact details
3. **We will verify your Scoot account** and assign an appropriate API key
4. **You'll receive your API key** via email once approved

<Info>
  API key requests are typically processed within 1-3 business days. Include "URGENT" in the subject line for expedited processing.
</Info>

<Warning>
  Keep your API key secure and never expose it in client-side code or public repositories.
</Warning>

## Request Format

### Content Type

All POST and PUT requests should include the `Content-Type` header:

```http theme={null}
Content-Type: application/json
```

### Example Request

```bash theme={null}
curl -X GET "https://api.scoot.app/api/v1/transcription" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json"
```

## Response Format

### Success Response

Successful responses return JSON data with appropriate HTTP status codes:

```json theme={null}
{
  "data": [...],
  "status": "success",
  "message": "Request completed successfully"
}
```

### Error Response

Error responses include details about what went wrong:

```json theme={null}
{
  "error": "Invalid API key",
  "status": "error",
  "code": 401
}
```

## Pagination

List endpoints support pagination using query parameters:

* `page`: Page number (default: 0)
* `size`: Items per page (default: 20)
* `sort`: Sort field and direction (e.g., `createdAt,desc`)

### Example Paginated Request

```bash theme={null}
GET /api/v1/transcription?page=1&size=50&sort=createdAt,desc
```

## Claude Code Skill

Speed up your integration by using our Claude Code skill. It provides full API context — endpoints, authentication, pagination, and code examples — directly inside your coding workflow.

<Card title="Download Scoot API Skill" icon="bolt" href="/scoot-api-skill.txt">
  Add this skill to Claude Code to get AI-assisted guidance when building with the Scoot API.
</Card>

## Getting Started

Ready to make your first API call? Check out our [Quickstart Guide](/quickstart) for step-by-step instructions and code examples.

<Tip>
  Start with the transcription endpoints to get familiar with the API structure and authentication flow.
</Tip>