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

# Create an upload

> A new upload, with its files when sent as multipart, and a signed upload_url that takes more files.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/uploads
openapi: 3.1.0
info:
  title: ProvenMetal API
  version: 1.0.0
  description: >-
    Everything the ProvenMetal MCP does, over HTTP with an API key: upload a
    design, get a live JLCPCB quote and checkout link, follow it to delivery,
    pay with saved details, and check parts and designs. Formal quotes for any
    fab or assembler are under Orders.
servers:
  - url: https://api.provenmetal.com
security:
  - ApiKey: []
tags:
  - name: Uploads
  - name: Quotes
  - name: Saved details
  - name: Checks
  - name: Buy links
  - name: Orders
  - name: Account
paths:
  /v1/uploads:
    post:
      tags:
        - Uploads
      summary: Create an upload
      description: >-
        A new upload, with its files when sent as multipart, and a signed
        upload_url that takes more files.
      operationId: create_upload_v1_uploads_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_create_upload_v1_uploads_post'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UploadReply'
        '422':
          description: >-
            A field was refused, or the design needs an answer first
            (needs_details...)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReply'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReply'
          description: Client Error
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorReply'
          description: Server Error
components:
  schemas:
    Body_create_upload_v1_uploads_post:
      properties:
        files:
          type: array
          items:
            type: string
            format: binary
          title: Files
          description: >-
            Design files, each as a files part: a KiCad project or Gerber zip, a
            BOM and pick-and-place for assembly, any fabrication drawing or
            README. A .tgz is unpacked. Up to 20 files, 50 MB each, 100 MB in
            all. Leave out to get only the upload link.
      type: object
      title: Body_create_upload_v1_uploads_post
    UploadReply:
      properties:
        ok:
          type: boolean
          title: Ok
        upload_id:
          type: string
          title: Upload Id
        upload_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Upload Url
          description: >-
            A signed link that takes more files for this upload for two hours,
            without an API key (multipart field files; a .tgz is unpacked).
        expires_in_minutes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Expires In Minutes
          description: How long upload_url takes files.
        files:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Files
          description: The files the upload holds.
        expires_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Expires At
          description: >-
            When the upload's files are deleted: six hours after the last
            arrived.
        quote_takes:
          anyOf:
            - type: string
            - type: 'null'
          title: Quote Takes
          description: How long a quote of these files takes, bare and assembled.
        command:
          anyOf:
            - type: string
            - type: 'null'
          title: Command
          description: A shell command that sends files to upload_url.
      additionalProperties: true
      type: object
      required:
        - ok
        - upload_id
      title: UploadReply
    ErrorReply:
      properties:
        ok:
          type: boolean
          const: false
          title: Ok
          default: false
        error:
          type: string
          title: Error
          description: >-
            The MCP's error code, for example needs_details, rate_limited or
            no_files.
        message:
          type: string
          title: Message
          description: What went wrong and what to do, in words to relay.
        questions:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Questions
          description: >-
            needs_details: each open question with its option, choices and usual
            answer. Answer them and send the same quote again with those fields.
        known:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Known
          description: 'needs_details: what the files already said.'
        parts:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Parts
          description: >-
            needs_part_numbers (and needs_details): the BOM lines to name
            exactly.
        off_board_parts:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Off Board Parts
          description: BOM lines with no pick-and-place position.
        retry_after_s:
          anyOf:
            - type: integer
            - type: 'null'
          title: Retry After S
          description: 'rate_limited: seconds to wait. Also in the Retry-After header.'
        checkout_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Checkout Url
          description: >-
            card_declined / authentication_required: where the customer pays
            instead.
        fields:
          anyOf:
            - items:
                additionalProperties:
                  type: string
                type: object
              type: array
            - type: 'null'
          title: Fields
          description: 'invalid_request: each field that was refused and why.'
      additionalProperties: true
      type: object
      required:
        - error
        - message
      title: ErrorReply
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Your ProvenMetal API key (`pm_live_...`). `Authorization: Bearer <key>`
        also works.

````

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