Skip to main content

​
Welcome to Scoot API

The Scoot Gateway API provides secure access to Scoot Engage Data, allowing you to integrate transcription services, social events, and user management into your applications.
Make sure you have a Scoot account and API key before getting started with these endpoints.

​
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:

Transcription

Manage and retrieve transcription data

Social Events

Handle social event management

User Management

User account and profile operations

Recording

Recording and media management

​
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: 
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
  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
API key requests are typically processed within 1-3 business days. Include “URGENT” in the subject line for expedited processing.
Keep your API key secure and never expose it in client-side code or public repositories.

​
Request Format

​
Content Type

All POST and PUT requests should include the Content-Type header: 
Content-Type: application/json

​
Example Request

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: 
{
  "data": [...],
  "status": "success",
  "message": "Request completed successfully"
}

​
Error Response

Error responses include details about what went wrong: 
{
  "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

GET /api/v1/transcription?page=1&size=50&sort=createdAt,desc

​
Getting Started

Ready to make your first API call? Check out our Quickstart Guide for step-by-step instructions and code examples.
Start with the transcription endpoints to get familiar with the API structure and authentication flow.
⌘I