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

# Health Check

> Health check endpoint to verify API service availability and operational status.



## OpenAPI

````yaml https://api.swarms.world/openapi.json get /health
openapi: 3.1.0
info:
  title: Swarms API
  description: >-
    Swarms API provides scalable, secure orchestration for multi-agent systems.
    Access robust endpoints for managing agents and swarms, automating
    workflows, and monitoring execution. Requires an API key—see the [API Keys
    page](https://swarms.world/platform/api-keys). Refer to [Swarms API
    Documentation](https://docs.swarms.ai) for guides and details.
  version: 1.0.0
servers:
  - url: https://api.swarms.world
    description: Swarms Production API
security: []
paths:
  /health:
    get:
      tags:
        - General
      summary: Health Check
      description: >-
        Health check endpoint to verify API service availability and operational
        status.
      operationId: health_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthOutput'
components:
  schemas:
    HealthOutput:
      properties:
        status:
          type: string
          title: Status
          default: ok
      type: object
      title: HealthOutput

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.