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

# Batch models (Beta)

> List batch-capable models and their supported batch parameters.

Returns active models that can be used with the Batch API.

Use this endpoint before creating a batch when you need to discover provider-specific batch constraints such as:

* allowed `endpoint` values for batch input rows
* supported `completion_window` values
* model/provider-specific parameters exposed through `supported_params_detail` and `supported_parameters_detail`

The response is a standard `list` envelope. Each item includes:

* `model`
* `name`
* `status`
* `input_types` and `output_types`
* `supported_params`
* `supported_parameters`
* `supported_params_detail`
* `supported_parameters_detail`
* `providers`, each with provider-level supported parameter detail
* `pricing`

`supported_parameters` is the OpenRouter-compatible alias for `supported_params`. `supported_params_detail` and `supported_parameters_detail` are aliases for the same structured metadata. New clients should prefer `supported_parameters` and `supported_parameters_detail`; existing clients can continue reading `supported_params` and `supported_params_detail`.

You can filter models by supported batch parameter with the `params` query parameter. Repeat it or pass a comma-separated list. The filter accepts canonical names and aliases from `supported_parameters_detail`, so `params=request_endpoint` can match models whose canonical parameter is `endpoint`, and `params=window` can match `completion_window`.

```bash theme={null}
curl "https://api.phaseo.ai/v1/batches/models?params=request_endpoint,window" \
  -H "Authorization: Bearer $PHASEO_API_KEY"
```

```json theme={null}
{
  "object": "list",
  "data": [
    {
      "model": "openai/gpt-5-mini",
      "status": "active",
      "supported_params": ["endpoint", "completion_window"],
      "supported_parameters": ["endpoint", "completion_window"],
      "supported_parameters_detail": {
        "endpoint": {
          "supported": true,
          "values": ["/v1/responses", "/v1/chat/completions"],
          "providers": ["openai"]
        },
        "completion_window": {
          "supported": true,
          "values": ["24h"],
          "providers": ["openai"]
        }
      }
    },
    {
      "model": "openai/text-embedding-3-small",
      "status": "active",
      "supported_params": ["endpoint", "completion_window"],
      "supported_parameters": ["endpoint", "completion_window"],
      "supported_parameters_detail": {
        "endpoint": {
          "supported": true,
          "values": ["/v1/embeddings"],
          "providers": ["openai"]
        },
        "completion_window": {
          "supported": true,
          "values": ["24h"],
          "providers": ["openai"]
        }
      }
    },
    {
      "model": "openai/gpt-image-1.5",
      "status": "active",
      "supported_params": ["endpoint", "completion_window"],
      "supported_parameters": ["endpoint", "completion_window"],
      "supported_parameters_detail": {
        "endpoint": {
          "supported": true,
          "values": ["/v1/images/generations", "/v1/images/edits"],
          "providers": ["openai"]
        },
        "completion_window": {
          "supported": true,
          "values": ["24h"],
          "providers": ["openai"]
        }
      }
    },
    {
      "model": "openai/omni-moderation",
      "status": "active",
      "supported_params": ["endpoint", "completion_window"],
      "supported_parameters": ["endpoint", "completion_window"],
      "supported_parameters_detail": {
        "endpoint": {
          "supported": true,
          "values": ["/v1/moderations"],
          "providers": ["openai"]
        },
        "completion_window": {
          "supported": true,
          "values": ["24h"],
          "providers": ["openai"]
        }
      }
    },
    {
      "model": "openai/sora-2",
      "status": "active",
      "supported_params": ["endpoint", "completion_window"],
      "supported_parameters": ["endpoint", "completion_window"],
      "supported_parameters_detail": {
        "endpoint": {
          "supported": true,
          "values": ["/v1/videos"],
          "providers": ["openai"]
        },
        "completion_window": {
          "supported": true,
          "values": ["24h"],
          "providers": ["openai"]
        }
      }
    }
  ]
}
```


## OpenAPI

````yaml GET /batches/models
openapi: 3.0.3
info:
  title: Phaseo Gateway API
  description: >-
    A gateway API for accessing various AI models with OpenAI-compatible
    endpoints.
  version: 1.0.0
  contact:
    name: Phaseo
    url: https://phaseo.app
    email: danielbutler500@gmail.com
servers:
  - url: https://api.phaseo.ai/v1
security:
  - BearerAuth: []
tags:
  - name: Gateway
    description: Core Phaseo Gateway operations.
paths:
  /batches/models:
    get:
      tags:
        - Gateway
      summary: List batch model capabilities
      description: >-
        Returns DB-backed batch model/provider capability metadata, including
        supported batch parameters such as allowed input endpoints and
        completion windows.
      operationId: listBatchModels
      parameters:
        - name: params
          in: query
          required: false
          description: >-
            Optional supported-parameter filter. Repeat the parameter or pass a
            comma-separated list. Canonical names and aliases are accepted, for
            example `endpoint`, `request_endpoint`, `completion_window`, or
            `window`.
          schema:
            type: array
            items:
              type: string
          style: form
          explode: false
      responses:
        '200':
          description: Batch model capability list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchModelsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    BatchModelsResponse:
      type: object
      properties:
        object:
          type: string
          example: list
        data:
          type: array
          items:
            $ref: '#/components/schemas/BatchModelCapability'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        ok:
          type: boolean
          example: false
        error:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
          example: error_type
        message:
          type: string
          example: Human-readable error message
        description:
          type: string
          example: Additional error details.
        generation_id:
          type: string
          example: G-abc123
        status_code:
          type: integer
          example: 502
        error_type:
          type: string
          enum:
            - user
            - system
          example: system
        error_origin:
          type: string
          enum:
            - user
            - gateway
            - upstream
          example: upstream
        reason:
          type: string
          example: all_candidates_failed
        attempt_count:
          type: integer
          example: 2
        failed_providers:
          type: array
          items:
            type: string
          example:
            - google-ai-studio
            - openai
        failed_statuses:
          type: array
          items:
            type: integer
          example:
            - 403
            - 429
        upstream_error:
          $ref: '#/components/schemas/ErrorUpstreamError'
        failure_sample:
          type: array
          items:
            $ref: '#/components/schemas/ErrorFailureSampleItem'
        provider_failure_diagnostics:
          $ref: '#/components/schemas/ErrorProviderFailureDiagnostics'
        routing_diagnostics:
          $ref: '#/components/schemas/ErrorRoutingDiagnostics'
        provider_candidate_diagnostics:
          $ref: '#/components/schemas/ErrorProviderCandidateDiagnostics'
        provider_enablement:
          $ref: '#/components/schemas/ErrorProviderEnablementDiagnostics'
        missing_pricing_providers:
          type: array
          items:
            type: string
        provider_payment_required_provider:
          type: string
          example: openai
        provider_payment_required_support_notice:
          type: string
          example: >-
            Our upstream provider billing appears to be unavailable. If this
            persists, contact support.
        details:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: true
    BatchModelCapability:
      type: object
      properties:
        model:
          type: string
        name:
          type: string
        status:
          type: string
        input_types:
          type: array
          items:
            type: string
        output_types:
          type: array
          items:
            type: string
        supported_params:
          type: array
          items:
            type: string
        supported_parameters:
          type: array
          description: OpenRouter-compatible alias for supported_params.
          items:
            type: string
        supported_params_detail:
          $ref: '#/components/schemas/SupportedParameterDetails'
        supported_parameters_detail:
          $ref: '#/components/schemas/SupportedParameterDetails'
        providers:
          type: array
          items:
            $ref: '#/components/schemas/BatchModelProviderCapability'
        pricing:
          type: object
          additionalProperties: true
    ErrorUpstreamError:
      type: object
      properties:
        code:
          type: string
          nullable: true
          example: PERMISSION_DENIED
        message:
          type: string
          nullable: true
          example: The caller does not have permission.
        description:
          type: string
          nullable: true
        param:
          type: string
          nullable: true
    ErrorFailureSampleItem:
      type: object
      properties:
        provider:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
        status:
          type: integer
          nullable: true
        upstream_error_code:
          type: string
          nullable: true
        upstream_error_message:
          type: string
          nullable: true
        upstream_error_description:
          type: string
          nullable: true
        upstream_error_param:
          type: string
          nullable: true
        upstream_payload_preview:
          type: string
          nullable: true
        retryable:
          type: boolean
          nullable: true
      additionalProperties: true
    ErrorProviderFailureDiagnostics:
      type: object
      properties:
        category:
          type: string
          enum:
            - credentials_not_configured
            - credentials_invalid_or_forbidden
            - provider_access_missing
            - region_or_project_restriction
            - model_unavailable_for_endpoint
            - rate_limited
            - server_error
        hint:
          type: string
        provider:
          type: string
          nullable: true
    ErrorRoutingDiagnostics:
      type: object
      properties:
        filterStages:
          type: array
          items:
            type: object
            properties:
              stage:
                type: string
              beforeCount:
                type: integer
              afterCount:
                type: integer
              droppedProviders:
                type: array
                items:
                  type: object
                  properties:
                    providerId:
                      type: string
                      nullable: true
                    reason:
                      type: string
                      nullable: true
                  additionalProperties: true
            additionalProperties: true
      additionalProperties: true
    ErrorProviderCandidateDiagnostics:
      type: object
      properties:
        totalProviders:
          type: integer
        supportsEndpointCount:
          type: integer
        candidateCount:
          type: integer
        droppedUnsupportedEndpoint:
          type: array
          items:
            type: string
        droppedMissingAdapter:
          type: array
          items:
            type: object
            properties:
              providerId:
                type: string
                nullable: true
              endpoint:
                type: string
                nullable: true
            additionalProperties: true
      additionalProperties: true
    ErrorProviderEnablementDiagnostics:
      type: object
      properties:
        capability:
          type: string
        providersBefore:
          type: array
          items:
            type: string
        providersAfter:
          type: array
          items:
            type: string
        dropped:
          type: array
          items:
            type: object
            properties:
              providerId:
                type: string
                nullable: true
              reason:
                type: string
                nullable: true
            additionalProperties: true
      additionalProperties: true
    SupportedParameterDetails:
      type: object
      description: >-
        Structured constraints and provider support for request parameters,
        keyed by parameter name.
      additionalProperties:
        type: object
        additionalProperties: true
    BatchModelProviderCapability:
      type: object
      properties:
        id:
          type: string
        supported_params:
          type: array
          items:
            type: string
        supported_parameters:
          type: array
          description: OpenRouter-compatible alias for supported_params.
          items:
            type: string
        supported_params_detail:
          $ref: '#/components/schemas/SupportedParameterDetails'
        supported_parameters_detail:
          $ref: '#/components/schemas/SupportedParameterDetails'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication

````