> ## 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.

# Get Premium Endpoints

> Retrieve all API endpoints that require a premium subscription.



## OpenAPI

````yaml https://api.swarms.world/openapi.json get /v1/account/premium-endpoints
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:
  /v1/account/premium-endpoints:
    get:
      tags:
        - Account Management
      summary: Get Premium Endpoints
      description: Retrieve all API endpoints that require a premium subscription.
      operationId: premium_endpoints_v1_account_premium_endpoints_get
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PremiumEndpointsOutput'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PremiumEndpointsOutput:
      properties:
        status:
          type: boolean
          title: Status
          description: Indicates whether fetching premium endpoints was successful.
          default: true
        timestamp:
          anyOf:
            - type: string
            - type: 'null'
          title: Timestamp
          description: The ISO formatted timestamp when this response was generated.
        total:
          type: integer
          title: Total
          description: Number of premium endpoints.
        premium_endpoints:
          items:
            $ref: '#/components/schemas/PremiumEndpointInfo'
          type: array
          title: Premium Endpoints
          description: Route, name and description for every premium-only endpoint.
        upgrade_url:
          type: string
          title: Upgrade Url
          description: Where to upgrade to a premium subscription.
          default: https://cloud.swarms.world/settings
      type: object
      required:
        - total
        - premium_endpoints
      title: PremiumEndpointsOutput
      description: >-
        Response model listing every endpoint that requires a premium
        subscription.


        Attributes:
            status (bool): Indicates success of the operation.
            timestamp (str): The ISO formatted timestamp of the response.
            total (int): Number of premium endpoints.
            premium_endpoints (List[PremiumEndpointInfo]): Route, name and description
                for every premium-only endpoint.
            upgrade_url (str): Where to upgrade to a premium subscription.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PremiumEndpointInfo:
      properties:
        route:
          type: string
          title: Route
          description: The API route path that requires a premium subscription.
        name:
          type: string
          title: Name
          description: Human-readable feature name for the endpoint.
        description:
          type: string
          title: Description
          description: What the endpoint allows a premium subscriber to do.
      type: object
      required:
        - route
        - name
        - description
      title: PremiumEndpointInfo
      description: |-
        Metadata for a single premium-only API endpoint.

        Attributes:
            route (str): The API route path that requires a premium subscription.
            name (str): Human-readable feature name for the endpoint.
            description (str): What the endpoint allows a premium subscriber to do.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````