> ## 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 a buy link

> For a partner site's Buy button: a permanent link where a shopper picks the quantity and destination, gets a
live price and checks out. 100 a day per key.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/buy-links
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/buy-links:
    post:
      tags:
        - Buy links
      summary: Create a buy link
      description: >-
        For a partner site's Buy button: a permanent link where a shopper picks
        the quantity and destination, gets a

        live price and checks out. 100 a day per key.
      operationId: buy_link_v1_buy_links_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuyLinkRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuyLinkReply'
        '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:
    BuyLinkRequest:
      properties:
        upload_id:
          type: string
          maxLength: 64
          title: Upload Id
          description: The upload_id from POST /v1/uploads.
        project_name:
          type: string
          maxLength: 200
          title: Project Name
          description: The board's name, shown to shoppers.
        source_url:
          anyOf:
            - type: string
              maxLength: 2000
            - type: 'null'
          title: Source Url
          description: The board's page.
        assembly:
          type: boolean
          title: Assembly
          description: true if the board can be ordered assembled.
          default: false
        layers:
          anyOf:
            - type: integer
            - type: 'null'
          title: Layers
        thickness_mm:
          anyOf:
            - type: number
            - type: 'null'
          title: Thickness Mm
        surface_finish:
          anyOf:
            - type: string
            - type: 'null'
          title: Surface Finish
        solder_mask:
          anyOf:
            - type: string
            - type: 'null'
          title: Solder Mask
        copper_oz:
          anyOf:
            - type: integer
            - type: 'null'
          title: Copper Oz
        material:
          anyOf:
            - type: string
            - type: 'null'
          title: Material
        board:
          anyOf:
            - type: string
            - type: 'null'
          title: Board
        skip_board_checks:
          type: boolean
          title: Skip Board Checks
          default: false
        itar:
          type: boolean
          title: Itar
          description: >-
            true if the design is ITAR-controlled: it is refused before anything
            is read.
          default: false
      additionalProperties: false
      type: object
      required:
        - upload_id
        - project_name
      title: BuyLinkRequest
    BuyLinkReply:
      properties:
        ok:
          type: boolean
          title: Ok
        buy_url:
          type: string
          title: Buy Url
        notes:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Notes
      additionalProperties: true
      type: object
      required:
        - ok
        - buy_url
      title: BuyLinkReply
    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.