> ## Documentation Index
> Fetch the complete documentation index at: https://pinata-mintlify-a8f2129e.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Generate Pinata API Key

> Create a Pinata API key



## OpenAPI

````yaml post /users/generateApiKey
openapi: 3.0.0
info:
  title: Pinata API
  description: ''
  termsOfService: https://www.pinata.cloud/terms-conditions
  contact:
    name: Pinata Team
    email: team@pinata.cloud
  version: 1.0.0
servers:
  - url: https://api.pinata.cloud
security:
  - bearerAuth: []
paths:
  /users/generateApiKey:
    post:
      summary: Generate Pinata API Key
      description: Create a Pinata API key
      requestBody:
        description: 'Body is comprised of keyName, permissions, and maxUses (optional). '
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/users_generateApiKey_body'
      responses:
        '200':
          description: |-
            {
                "pinata_api_key": "KEY",
                "pinata_api_secret": "SECRET",
                "JWT": "JWT"
            }
          content:
            application/json: {}
            application/xml:
              schema:
                $ref: '#/components/schemas/inline_response_200_6'
      security:
        - bearerAuth: []
      servers:
        - url: https://api.pinata.cloud
components:
  schemas:
    users_generateApiKey_body:
      required:
        - keyName
        - permissions
      type: object
      properties:
        keyName:
          type: string
        permissions:
          $ref: '#/components/schemas/usersgenerateApiKey_permissions'
        maxUses:
          type: integer
      x-examples:
        Example 1:
          keyName: Required name for your key
          maxUses: 0
          permissions:
            admin: false
            endpoints:
              data:
                pinList: false
                userPinnedDataTotal: false
              pinning:
                hashMetadata: false
                hashPinPolicy: false
                pinByHash: false
                pinFileToIPFS: false
                pinJSONToIPFS: false
                pinJobs: false
                unpin: false
                userPinPolicy: false
    inline_response_200_6:
      type: object
      properties:
        pinata_api_key:
          type: string
        pinata_api_secret:
          type: string
        JWT:
          type: string
      x-examples:
        Example 1:
          pinata_api_key: KEY
          pinata_api_secret: SECRET
          JWT: JWT
    usersgenerateApiKey_permissions:
      type: object
      properties:
        admin:
          type: boolean
        endpoints:
          $ref: '#/components/schemas/usersgenerateApiKey_permissions_endpoints'
    usersgenerateApiKey_permissions_endpoints:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/usersgenerateApiKey_permissions_endpoints_data'
        pinning:
          $ref: >-
            #/components/schemas/usersgenerateApiKey_permissions_endpoints_pinning
    usersgenerateApiKey_permissions_endpoints_data:
      type: object
      properties:
        pinList:
          type: boolean
        userPinnedDataTotal:
          type: boolean
    usersgenerateApiKey_permissions_endpoints_pinning:
      type: object
      properties:
        hashMetadata:
          type: boolean
        hashPinPolicy:
          type: boolean
        pinByHash:
          type: boolean
        pinFileToIPFS:
          type: boolean
        pinJSONToIPFS:
          type: boolean
        pinJobs:
          type: boolean
        unpin:
          type: boolean
        userPinPolicy:
          type: boolean
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````