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

# Generate Manifest

> Generate a manifest from natural language description.

    Uses AI to create a valid YAML manifest from a natural language description
    of desired resources. The generated manifest can be reviewed and applied.

    **Example:**
    ```bash
    curl -X POST /v1/manifest/generate \
      -H "Authorization: Bearer $API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "description": "I need a bucket of images that feeds into a multimodal extractor and a retriever",
        "manifest_name": "image-search-setup"
      }'
    ```

    The model is given the live extractor and retriever-stage catalogs. The
    answer is checked with the same rules as POST /v1/manifest/validate, and
    when that finds errors the model is shown them and asked to repair its
    answer, up to 2 times.

    **Response:**
    ```json
    {
      "manifest": "version: '1.0'
metadata:
  name: image-search-setup
...",
      "format": "yaml",
      "manifest_name": "image-search-setup",
      "description": "I need a bucket of images...",
      "validation": {"valid": true, "errors": [], "warnings": []},
      "repair_rounds": 1,
      "cost_estimate": {"per_1k_items_usd": 1.5, "per_month_usd": 15.4, "...": "..."},
      "suggested": {"templates": ["..."], "models": ["siglip-base-patch16-224"]}
    }
    ```

    `cost_estimate` prices the returned manifest at list rates: per 1,000 items,
    and per month at the volume in `monthly_volume`. `suggested` names the
    namespace templates and catalog models the generator was offered as the
    closest matches to the description.

    `validation.valid` is false when the manifest still has errors after the
    repair rounds; the errors are listed so you can fix them by hand.

    Send the fields as a JSON body (above) or as query parameters. With an
    `inventory` the answer also carries `quote`: what indexing those files is
    charged, the monthly price and the unit prices, the same quote
    POST /v1/organizations/billing/estimate returns for this manifest. A bucket
    in `inventory` that the generated manifest does not declare is reported in
    `quote.error`.

    **Next Steps:**
    1. Review the generated manifest
    2. Apply it using POST /v1/manifest/apply



## OpenAPI

````yaml post /v1/manifest/generate
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security:
  - BearerAuth: []
paths:
  /v1/manifest/generate:
    post:
      tags:
        - Manifest
      summary: Generate Manifest
      description: |-
        Generate a manifest from natural language description.

            Uses AI to create a valid YAML manifest from a natural language description
            of desired resources. The generated manifest can be reviewed and applied.

            **Example:**
            ```bash
            curl -X POST /v1/manifest/generate \
              -H "Authorization: Bearer $API_KEY" \
              -H "Content-Type: application/json" \
              -d '{
                "description": "I need a bucket of images that feeds into a multimodal extractor and a retriever",
                "manifest_name": "image-search-setup"
              }'
            ```

            The model is given the live extractor and retriever-stage catalogs. The
            answer is checked with the same rules as POST /v1/manifest/validate, and
            when that finds errors the model is shown them and asked to repair its
            answer, up to 2 times.

            **Response:**
            ```json
            {
              "manifest": "version: '1.0'
        metadata:
          name: image-search-setup
        ...",
              "format": "yaml",
              "manifest_name": "image-search-setup",
              "description": "I need a bucket of images...",
              "validation": {"valid": true, "errors": [], "warnings": []},
              "repair_rounds": 1,
              "cost_estimate": {"per_1k_items_usd": 1.5, "per_month_usd": 15.4, "...": "..."},
              "suggested": {"templates": ["..."], "models": ["siglip-base-patch16-224"]}
            }
            ```

            `cost_estimate` prices the returned manifest at list rates: per 1,000 items,
            and per month at the volume in `monthly_volume`. `suggested` names the
            namespace templates and catalog models the generator was offered as the
            closest matches to the description.

            `validation.valid` is false when the manifest still has errors after the
            repair rounds; the errors are listed so you can fix them by hand.

            Send the fields as a JSON body (above) or as query parameters. With an
            `inventory` the answer also carries `quote`: what indexing those files is
            charged, the monthly price and the unit prices, the same quote
            POST /v1/organizations/billing/estimate returns for this manifest. A bucket
            in `inventory` that the generated manifest does not declare is reported in
            `quote.error`.

            **Next Steps:**
            1. Review the generated manifest
            2. Apply it using POST /v1/manifest/apply
      operationId: generate_manifest_v1_manifest_generate_post
      parameters:
        - name: description
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Same as the body field
            title: Description
          description: Same as the body field
        - name: manifest_name
          in: query
          required: false
          schema:
            type: string
            default: generated-manifest
            title: Manifest Name
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/GenerateManifestRequest'
                - type: 'null'
              title: Body
        description: >-
          Keys this body does not declare are refused with 422 extra_forbidden
          naming the accepted keys (since 2026-11-02).
        x-unknown-keys:
          until: '2026-11-02'
          then: 422 extra_forbidden
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '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: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    GenerateManifestRequest:
      properties:
        description:
          type: string
          minLength: 1
          title: Description
          description: What the namespace should do, in plain words
        manifest_name:
          type: string
          title: Manifest Name
          description: metadata.name
          default: generated-manifest
        inventory:
          anyOf:
            - additionalProperties:
                additionalProperties:
                  type: number
                type: object
              type: object
            - type: 'null'
          title: Inventory
          description: >-
            Optional files per bucket name the manifest will declare (objects,
            videos, minutes, audio_minutes, images, pages, tokens). When given,
            the answer carries `quote`, priced as POST
            /v1/organizations/billing/estimate prices a manifest
        queries_per_month:
          type: integer
          minimum: 0
          title: Queries Per Month
          description: For the quote's monthly price
          default: 0
      type: object
      required:
        - description
      title: GenerateManifestRequest
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Mixpeek API key, sent as `Authorization: Bearer mxp_sk_...`. Create one
        in Studio under Settings → API Keys, or with an admin key via `POST
        /v1/organizations/users/{user_email}/api-keys`. A missing, malformed,
        unknown, revoked, inactive or expired key returns 401; a key without the
        permission, scope or plan an operation needs returns 403.

````

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