Crossmint Minting API SFTs API

openapi: 3.2.0
info:
  contact:
    email: support@crossmint.com
    name: Crossmint Support
    url: https://www.crossmint.com
  description: Generated from Crossmint's published product API specifications. Do not edit by hand.
  title: Crossmint Minting API SFTs API
  version: 1.0.0
servers:
- description: Staging environment (testnets)
  url: https://staging.crossmint.com/api
- description: Production environment (mainnets)
  url: https://www.crossmint.com/api
tags:
- name: Minting API SFTs
paths:
  /2022-06-09/collections/{collectionId}/sfts:
    post:
      description: Create a new SFT
      operationId: sfts.create
      parameters:
      - in: path
        name: collectionId
        required: true
        schema:
          type: string
      - in: header
        name: idempotency-key
        required: true
        schema:
          type: string
      - in: header
        name: x-idempotency-key
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SFTCreationDTO'
        required: true
      responses:
        '200':
          description: SFT creation started successfully
      security:
      - apiKey: []
      summary: Create SFT
      tags:
      - Minting API SFTs
components:
  schemas:
    SFTCreationDTO:
      properties:
        amount:
          maximum: 9007199254740991
          minimum: 1
          type: integer
        contractArguments:
          additionalProperties: {}
          description: The contract arguments if you are using your own contract.
          propertyNames:
            type: string
          type: object
        locale:
          description: The locale for the recipient's notification.
          enum:
          - Klingon
          - de-DE
          - en-US
          - es-ES
          - fr-FR
          - it-IT
          - ja-JP
          - ko-KR
          - pt-PT
          - ru-RU
          - th-TH
          - tr-TR
          - uk-UA
          - vi-VN
          - zh-CN
          - zh-TW
          type: string
        recipient:
          description: The recipient of the SFT
          type: string
        sendNotification:
          description: Whether to send a notification to the recipient.
          type: boolean
        templateId:
          description: The templateId of the SFT
          type: string
      required:
      - recipient
      type: object
  securitySchemes:
    apiKey:
      description: API key required for authentication
      in: header
      name: X-API-KEY
      type: apiKey
    orderClientSecret:
      description: The `clientSecret` returned when the order was created, sent as the raw `Authorization` header value. Lets a browser or mobile client read and continue its own order without a server-side API key.
      in: header
      name: Authorization
      type: apiKey
    userJwt:
      bearerFormat: JWT
      description: 'The end user''s JWT, sent as `Authorization: Bearer <JWT>` together with a client-side API key. Validated against the project''s external JWT configuration.'
      scheme: bearer
      type: http
x-provenance:
  method: harvested
  publisher: Crossmint
  source: https://www.crossmint.com/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)