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

# Health check

> Returns API status without authentication



## OpenAPI

````yaml GET /
openapi: 3.0.3
info:
  title: Streamforge External API
  description: >
    Public-facing API for accessing normalized creator, content, and analysis
    data across Twitch, YouTube, Instagram, and TikTok.


    ## Authentication

    All requests require an API key in the `x-api-key` header.


    ## Rate Limiting

    The API uses a weight-based quota system:

    - Single item requests: 1 quota unit

    - Bulk requests: 1 quota unit per item (up to 100 items)

    - List requests: 1 quota unit per item returned (based on `limit`)

    - Advanced endpoint: 100 quota units per request


    Rate limit headers are included in all responses:

    - `X-RateLimit-{window}-limit`: Maximum requests allowed

    - `X-RateLimit-{window}-remaining`: Remaining requests

    - `X-RateLimit-{window}-reset`: ISO timestamp when limit resets


    ### Quota weights by endpoint:

    - Profile/Content endpoints: 1 quota unit per item

    - Analysis endpoint: 100 quota units per request

    - Email endpoint: 10 quota units per request

    - Socials endpoint: 10 quota units per request

    - Audience endpoint: 100 quota units per request


    ## Base URL

    Production: `https://external-api.streamforge.com`
  version: 1.0.0
  contact:
    name: Streamforge Support
    email: support@streamforge.com
servers:
  - url: https://external-api.streamforge.com
    description: Production
  - url: http://localhost:3000
    description: Local development (from .env)
    variables:
      base_url:
        default: http://localhost:3000
security:
  - ApiKeyAuth: []
tags:
  - name: Health
    description: Health check endpoint
  - name: Profiles
    description: Creator profile endpoints
  - name: Content
    description: Content (streams/videos) endpoints
  - name: Games
    description: Game metadata endpoints
  - name: Advanced
    description: Advanced insights and analysis
paths:
  /:
    get:
      tags:
        - Health
      summary: Health check
      description: Returns API status without authentication
      operationId: healthCheck
      responses:
        '200':
          description: API is ready
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: ready
      security: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: |
        Your API key. Include it in the `x-api-key` header for all requests.

````