# AUTO-GENERATED tier-A mirror spec — do not edit.
# Source: openapi/runtime/ingestion-rules.yaml (runtime 0.124.0)
#  + policy: openapi/mirror-policies/ingestion-rules.json
# Regenerate: node scripts/generate-mirror-specs.mjs
openapi: 3.0.3
info:
  title: naturali.ai — Ingestion Rules API
  version: 1.0.0
  description: >-
    Ingestion rules: how a document becomes retrievable — which files a rule matches, the converter
    that turns them into text, and the chunking and embedding the resulting pass applies. 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: Ingestion Rules
    description: Route content types to converter tools or agents during ingestion
security:
  - bearerAuth: []
  - oauth2:
      - mcp:access
paths:
  /v1/projects/{project_id}/ingestion-rules:
    get:
      tags:
        - Ingestion Rules
      summary: List ingestion rules
      description: Returns the ingestion rules for a project
      operationId: listIngestionRules
      parameters:
        - $ref: "#/components/parameters/Limit"
        - $ref: "#/components/parameters/Cursor"
      responses:
        "200":
          description: List of ingestion rules
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/Page"
                  - properties:
                      data:
                        type: array
                        items:
                          $ref: "#/components/schemas/IngestionRule"
        "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:
        - Ingestion Rules
      summary: Create an ingestion rule
      description: Creates a rule mapping a content_type glob to a converter. Exactly one of tool_id or
        agent_id must be set.
      operationId: createIngestionRule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - content_type_glob
                - policy_ids
              oneOf:
                - required:
                    - tool_id
                - required:
                    - agent_id
              additionalProperties: false
              properties:
                policy_ids:
                  description: The policies every conversion the rule starts acts under.
                  allOf:
                    - $ref: "#/components/schemas/AttachedPolicyIds"
                content_type_glob:
                  type: string
                  description: MIME type glob matched against a file's content_type. At most 4 wildcards and 255
                    characters — a MIME glob needs one on each side of the slash at most.
                  maxLength: 255
                  example: image/*
                tool_id:
                  x-naturali-ref: tools
                  type: string
                  description: Converter tool id (mutually exclusive with agent_id)
                  example: tool_V1StGXR8Z5jdHi6B
                agent_id:
                  x-naturali-ref: agents
                  type: string
                  description: Converter agent id (mutually exclusive with tool_id)
                  example: agent_V1StGXR8Z5jdHi6B
                action:
                  type: string
                  description: Operation id, required for mcp tool converters, and for builtin unless a
                    preset_parameters (the rule's or the tool's) names action
                preset_parameters:
                  type: object
                  description: Merged into the tool input before invocation (tool converters only)
                native_extraction:
                  type: string
                  enum:
                    - first
                    - skip
                  description: "For native types (PDF/text): `first` (default) converts only when native extraction
                    yields no text; `skip` always converts."
                file_delivery:
                  type: string
                  enum:
                    - base64
                    - download_url
                  description: How the file reaches a tool converter (default base64)
                chunk_strategy:
                  type: string
                  enum:
                    - page
                    - whole
                    - size
                  description: Default chunk strategy, overridable per ingest request
                chunk_size:
                  type: integer
                  description: Default window size in characters for the size strategy
                chunk_overlap:
                  type: integer
                  description: Default overlap in characters for the size strategy
                metadata:
                  description: Arbitrary JSON metadata
                  allOf:
                    - $ref: "#/components/schemas/MetadataBag"
      responses:
        "201":
          description: Ingestion rule created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/IngestionRule"
        "400":
          description: Validation failed (e.g. tool_id and agent_id both set or both missing)
          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 rule for this content_type_glob 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}/ingestion-rules/{ingestion_rule_id}:
    get:
      tags:
        - Ingestion Rules
      summary: Get an ingestion rule
      description: Returns a specific ingestion rule
      operationId: getIngestionRule
      parameters:
        - name: ingestion_rule_id
          in: path
          required: true
          description: Ingestion rule ID
          schema:
            type: string
            example: igr_V1StGXR8Z5jdHi6B
      responses:
        "200":
          description: Ingestion rule details
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/IngestionRule"
        "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: Ingestion rule not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalError"
    patch:
      tags:
        - Ingestion Rules
      summary: Update an ingestion rule
      description: Updates fields of an ingestion rule
      operationId: updateIngestionRule
      parameters:
        - name: ingestion_rule_id
          in: path
          required: true
          description: Ingestion rule ID
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                policy_ids:
                  description: Replaces the policies every conversion the rule starts acts under.
                  allOf:
                    - $ref: "#/components/schemas/AttachedPolicyIds"
                content_type_glob:
                  type: string
                  description: MIME type glob matched against a file's content_type. At most 4 wildcards and 255
                    characters.
                  maxLength: 255
                tool_id:
                  x-naturali-ref: tools
                  type: string
                  nullable: true
                agent_id:
                  x-naturali-ref: agents
                  type: string
                  nullable: true
                action:
                  type: string
                  nullable: true
                preset_parameters:
                  type: object
                  nullable: true
                native_extraction:
                  type: string
                  enum:
                    - first
                    - skip
                file_delivery:
                  type: string
                  enum:
                    - base64
                    - download_url
                chunk_strategy:
                  type: string
                  enum:
                    - page
                    - whole
                    - size
                    - null
                  nullable: true
                  description: Send `null` to clear the rule's override and fall back to the per-request default.
                chunk_size:
                  type: integer
                  nullable: true
                chunk_overlap:
                  type: integer
                  nullable: true
                metadata:
                  $ref: "#/components/schemas/NullableMetadataBag"
      responses:
        "200":
          description: Ingestion rule updated
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/IngestionRule"
        "400":
          description: Validation failed
          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: Ingestion rule not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "409":
          description: A rule for this content_type_glob 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:
        - Ingestion Rules
      summary: Delete an ingestion rule
      description: Deletes an ingestion rule
      operationId: deleteIngestionRule
      parameters:
        - name: ingestion_rule_id
          in: path
          required: true
          description: Ingestion rule ID
          schema:
            type: string
      responses:
        "204":
          description: Ingestion rule deleted
        "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: Ingestion rule not found
          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:
    IngestionRule:
      type: object
      properties:
        policy_ids:
          description: The policies every conversion the rule starts acts under. Empty for one written without
            any, which does not run until a write gives it one.
          type: array
          items:
            x-naturali-ref: policies
            type: string
          example:
            - pol_V1StGXR8Z5jdHi6B
        id:
          type: string
          example: igr_V1StGXR8Z5jdHi6B
        project_id:
          x-naturali-ref: projects
          type: string
        content_type_glob:
          type: string
          example: image/*
        tool_id:
          x-naturali-ref: tools
          type: string
          nullable: true
        agent_id:
          x-naturali-ref: agents
          type: string
          nullable: true
        action:
          type: string
          nullable: true
        preset_parameters:
          type: object
          nullable: true
        native_extraction:
          type: string
          enum:
            - first
            - skip
        file_delivery:
          type: string
          enum:
            - base64
            - download_url
        chunk_strategy:
          type: string
          nullable: true
        chunk_size:
          type: integer
          nullable: true
        chunk_overlap:
          type: integer
          nullable: true
        metadata:
          $ref: "#/components/schemas/MetadataBag"
        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`.
    AttachedPolicyIds:
      type: array
      minItems: 1
      items:
        x-naturali-ref: policies
        type: string
      description: The policies the resource acts under; an event subscriber receives an event only when
        they allow reading its resource. The caller must hold every grant of each one it attaches
        inside the project, else `403 POLICY_GRANT_NOT_HELD`.
      example:
        - pol_V1StGXR8Z5jdHi6B
    MetadataBag:
      type: object
      description: >-
        Caller-owned annotations on a resource, stored as the object they were written as: the types
        a value was written with are the types a read returns, so a filter can ask an ordering
        question about a number. Unlike other body fields, keys are stored and returned verbatim in
        the casing supplied — they are not converted between snake_case and camelCase.


        No key is reserved, and that is the point: every piece of state the platform owns lives in
        its own typed column, so nothing written here reaches platform state. The platform never
        reads the bag — it is not an IAM context, not a policy input and not part of a prompt —
        which is what separates it from a tag bag.
      example:
        author: John
        revision: 2
    NullableMetadataBag:
      type: object
      nullable: true
      description: "A `MetadataBag` on a request field where `null` is meaningful: a full-replacement
        update that clears the bag. A record whose bag is unset leaves the field out."
      example:
        author: John
        revision: 2
  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"
