# AUTO-GENERATED tier-A mirror spec — do not edit.
# Source: openapi/runtime/model-routes.yaml (runtime 0.124.0)
#  + policy: openapi/mirror-policies/model-routes.json
# Regenerate: node scripts/generate-mirror-specs.mjs
openapi: 3.0.3
info:
  title: naturali.ai — Model Routes API
  version: 1.0.0
  description: >-
    Model routes: named, ordered provider+model failover lists an agent can generate through. A
    fully runtime-backed module — this spec is generated verbatim from the runtime's own, re-rooted
    under /v1/projects/{project_id}. The project in the path is authorized by naturali and enforced
    upstream by the project's scoped credential.


    This module mirrors the upstream runtime verbatim (tier A): paths are the runtime's own
    re-rooted under /v1/projects/{project_id}, and every field, method, status code and error shape
    passes through unchanged. Errors raised by the runtime arrive in its envelope; errors raised by
    naturali itself (authentication, project resolution, an unreachable runtime) use naturali's.
  contact:
    name: naturali.ai
    url: https://naturali.ai
servers:
  - url: "{baseUrl}"
    description: Host of your naturali.ai deployment; every path carries the /v1 prefix.
    variables:
      baseUrl:
        description: Base host URL.
        default: https://api.naturali.ai
tags:
  - name: Model Routes
    description: Manage ordered provider+model failover routes
security:
  - bearerAuth: []
  - oauth2:
      - mcp:access
paths:
  /v1/projects/{project_id}/model-routes:
    get:
      tags:
        - Model Routes
      summary: List model routes
      description: Returns the model routes defined in a project
      operationId: listModelRoutes
      parameters:
        - $ref: "#/components/parameters/Limit"
        - $ref: "#/components/parameters/Cursor"
      responses:
        "200":
          description: List of model routes
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/Page"
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: "#/components/schemas/ModelRoute"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          $ref: "#/components/responses/ProjectNotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
    post:
      tags:
        - Model Routes
      summary: Create a model route
      description: "Creates a project-scoped model route: a named, ordered list of provider+model targets
        tried in array order. Every target must reference an AI provider in the same project (400
        otherwise), and the total attempt budget — the sum of `1 + max_retries` over all targets —
        may not exceed 10 (400 naming the computed total). A duplicate `name` in the project is
        rejected with 409."
      operationId: createModelRoute
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - targets
              additionalProperties: false
              properties:
                name:
                  type: string
                  description: Human-readable name, unique per project
                  example: primary-with-fallback
                targets:
                  type: array
                  minItems: 1
                  description: "Ordered failover targets. Position is priority: target 0 is tried first, and a
                    retryable failure falls through to the next target."
                  items:
                    $ref: "#/components/schemas/ModelRouteTarget"
                retry_on:
                  type: array
                  description: Which failure classes are failover-eligible. A failure whose class is not listed (and
                    every deterministic failure — 400-class, auth, content policy) fails the
                    generation immediately instead of spending another target's budget.
                  items:
                    type: string
                    enum:
                      - provider_error
                      - timeout
                      - rate_limited
                  default:
                    - provider_error
                    - timeout
                    - rate_limited
                failure_threshold:
                  type: integer
                  default: 3
                  description: Consecutive retryable failures after which a target is skipped for `cooldown_seconds`.
                    Breaker state is in-process per node and keyed by (provider, model), so it is
                    shared by every route pointing at the same backend.
                  example: 3
                cooldown_seconds:
                  type: integer
                  default: 60
                  description: How long a tripped target is skipped before being probed again
                  example: 60
      responses:
        "201":
          description: Model route created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ModelRoute"
        "400":
          description: Bad request (invalid targets, attempt cap exceeded, unknown provider)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          $ref: "#/components/responses/ProjectNotFound"
        "409":
          description: A model route with this name already exists in the project
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "413":
          $ref: "#/components/responses/PayloadTooLarge"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "502":
          $ref: "#/components/responses/AdmissionUnavailable"
        4XX:
          $ref: "#/components/responses/AdmissionRefused"
    parameters:
      - $ref: "#/components/parameters/ProjectId"
  /v1/projects/{project_id}/model-routes/{route_id}:
    get:
      tags:
        - Model Routes
      summary: Get a model route
      description: Returns a specific model route
      operationId: getModelRoute
      parameters:
        - name: route_id
          in: path
          required: true
          description: Model route ID
          schema:
            type: string
            example: route_V1StGXR8Z5jdHi6B
      responses:
        "200":
          description: Model route details
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ModelRoute"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Model route not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
    put:
      tags:
        - Model Routes
      summary: Update a model route
      description: Updates a model route's name, targets, retry classes, or breaker configuration. Omitted
        fields are left unchanged.
      operationId: updateModelRoute
      parameters:
        - name: route_id
          in: path
          required: true
          description: Model route ID
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  description: New name (unique per project)
                targets:
                  type: array
                  minItems: 1
                  description: Replacement target list (ordered)
                  items:
                    $ref: "#/components/schemas/ModelRouteTarget"
                retry_on:
                  type: array
                  items:
                    type: string
                    enum:
                      - provider_error
                      - timeout
                      - rate_limited
                failure_threshold:
                  type: integer
                cooldown_seconds:
                  type: integer
      responses:
        "200":
          description: Model route updated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ModelRoute"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Model route not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "409":
          description: A model route with this name already exists in the project
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "413":
          $ref: "#/components/responses/PayloadTooLarge"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
        "502":
          $ref: "#/components/responses/AdmissionUnavailable"
        4XX:
          $ref: "#/components/responses/AdmissionRefused"
    delete:
      tags:
        - Model Routes
      summary: Delete a model route
      description: Deletes a model route. Returns 409 when an agent still references it — a routed agent
        has no pinned provider to fall back on, so the reference must be repointed or the agent
        deleted first.
      operationId: deleteModelRoute
      parameters:
        - name: route_id
          in: path
          required: true
          description: Model route ID
          schema:
            type: string
      responses:
        "204":
          description: Model route deleted successfully
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Model route not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "409":
          description: The model route is still referenced by one or more agents
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
        "502":
          $ref: "#/components/responses/AdmissionUnavailable"
        4XX:
          $ref: "#/components/responses/AdmissionRefused"
    parameters:
      - $ref: "#/components/parameters/ProjectId"
components:
  schemas:
    ModelRouteTarget:
      type: object
      required:
        - ai_provider_id
        - model
      properties:
        ai_provider_id:
          x-naturali-ref: ai-providers
          type: string
          description: AI provider in the route's project
          example: aip_V1StGXR8Z5jdHi6B
        model:
          type: string
          description: Model name to call on that provider
          example: gpt-4o-mini
        timeout_seconds:
          type: integer
          description: Per-attempt deadline, enforced with an AbortSignal composed with the caller's signal. A
            timeout classifies as `timeout`; the caller's own signal firing aborts the run without
            failover. Omitted means no per-target deadline.
          example: 30
        max_retries:
          type: integer
          default: 0
          description: "Retries on this target before falling through to the next one. The route is the only
            retry authority — routed calls pass `maxRetries: 0` to the AI SDK so its own retry loop
            cannot multiply these."
          example: 1
    ModelRoute:
      type: object
      properties:
        id:
          type: string
          example: route_V1StGXR8Z5jdHi6B
        project_id:
          x-naturali-ref: projects
          type: string
        name:
          type: string
          example: primary-with-fallback
        targets:
          type: array
          items:
            $ref: "#/components/schemas/ModelRouteTarget"
        retry_on:
          type: array
          items:
            type: string
            enum:
              - provider_error
              - timeout
              - rate_limited
        failure_threshold:
          type: integer
          example: 3
        cooldown_seconds:
          type: integer
          example: 60
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Page:
      type: object
      description: One page of a list. Rows inserted or removed between two calls neither repeat nor skip
        a row on the next page.
      required:
        - data
        - next_cursor
      properties:
        data:
          type: array
          description: This page's items, in the list's order.
          items: {}
        next_cursor:
          type: string
          nullable: true
          description: Pass as `cursor` to fetch the next page; `null` on the last page.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          description: Structured error. Every error response uses this shape, so `code` can be read without
            first checking the type of `error`.
          required:
            - code
            - message
            - hint
          properties:
            code:
              type: string
              pattern: ^[A-Z][A-Z0-9_]*$
              description: Machine-readable error code, UPPER_SNAKE whether naturali or the runtime raises it.
              example: FORBIDDEN
            message:
              type: string
              description: Human-readable explanation.
              example: Your role in this project does not carry this action.
            hint:
              type: string
              description: What to do about it, naming the routes of this API to call. For people and agents; it
                may change, so branch on `code`.
              example: Use a credential whose scope includes this action, or ask a project `admin` or `owner` to
                act; the caller's role or key excludes it.
            meta:
              type: object
              additionalProperties: true
              description: Structured context, such as the `resource` and `limit` of a `PLAN_LIMIT_REACHED`.
  parameters:
    ProjectId:
      name: project_id
      in: path
      required: true
      description: Project public ID (proj_ prefix).
      schema:
        type: string
        example: proj_V1StGXR8Z5jdHi6B
    Limit:
      name: limit
      in: query
      required: false
      description: Results per page, 1 to 100 (default 50). Above 100 it is clamped; below 1 or not an
        integer it is `400`.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
    Cursor:
      name: cursor
      in: query
      required: false
      description: The previous page's `next_cursor`; omit it for the first page. A cursor this list did
        not issue is `400`.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A naturali API key (nat_sk_…) or a session JWT.
    oauth2:
      type: oauth2
      description: "A connected app's OAuth access token, issued by this API's authorization server
        (discovery: /.well-known/oauth-authorization-server). Its one scope carries every operation,
        confined to the projects the user chose when approving the app."
      flows:
        authorizationCode:
          authorizationUrl: https://api.naturali.ai/authorize
          tokenUrl: https://api.naturali.ai/token
          refreshUrl: https://api.naturali.ai/token
          scopes:
            mcp:access: Every operation this API serves, on the projects the grant covers.
  responses:
    BadRequest:
      description: The request was malformed or failed validation.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    TooManyRequests:
      description: "`QUOTA_EXCEEDED` — a `requests` quota on the calling API key or its project is spent
        for the window; `Retry-After` says when it reopens"
      headers:
        Retry-After:
          description: Seconds until the quota window admits a request again
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    PayloadTooLarge:
      description: "`REQUEST_REJECTED` — the request body is over the size the body parser accepts"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    AdmissionUnavailable:
      description: The deployment's admission service is asked about this write and did not answer —
        `ADMISSION_UNAVAILABLE`; the write did not happen
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    AdmissionRefused:
      description: The deployment's admission service refused this write — answered under the service's
        own `4xx` status, with its `code` (matching `^[A-Za-z_][A-Za-z0-9_]{0,63}$`, not necessarily
        an `ERROR_CODES` key), `message` and `meta`; the write did not happen. A status this
        operation also declares on its own is documented there
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    InternalError:
      description: Unexpected server error — `INTERNAL_ERROR`, with the raw message never forwarded
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    ProjectNotFound:
      description: The project does not exist or the caller is not a member of it (`RESOURCE_NOT_FOUND`).
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
