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

# Mint a self-serve public-API key

> Creates a new API key for the caller, scoped to the fixed default set of public-API scopes. The `secret` is returned in plaintext only on this response and cannot be retrieved again afterward.



## OpenAPI

````yaml /openapi.json post /api/v1/api-keys
openapi: 3.1.0
info:
  title: VyomFlow API
  version: 1.0.0
  description: >-
    The versioned public REST surface (`/api/public/v1/*`, bearer API-key auth)
    plus the app's own internal `/api/v1/*` surface (Clerk session-token auth),
    generated directly from the same Zod contracts the Route Handlers validate
    against — never a hand-maintained duplicate. The MCP endpoint (`/api/mcp`)
    is a separate streamable-HTTP JSON-RPC transport, not expressible here — see
    the MCP guide.
servers:
  - url: https://api.vyomflow.co.in
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
paths:
  /api/v1/api-keys:
    post:
      tags:
        - API Keys
      summary: Mint a self-serve public-API key
      description: >-
        Creates a new API key for the caller, scoped to the fixed default set of
        public-API scopes. The `secret` is returned in plaintext only on this
        response and cannot be retrieved again afterward.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 256
                expirationDays:
                  type: integer
                  exclusiveMinimum: 0
              required:
                - name
      responses:
        '201':
          description: The newly created key, including its plaintext secret.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyResponse'
        '400':
          description: Malformed request body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - ClerkBearer: []
components:
  schemas:
    ApiKeyResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        secret:
          type: string
          description: The raw key value. Shown exactly once, on creation.
        scopes:
          type: array
          items:
            type: string
        expiresAt:
          type:
            - string
            - 'null'
      required:
        - id
        - name
        - secret
        - scopes
        - expiresAt
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    ClerkBearer:
      type: http
      scheme: bearer
      description: >-
        Clerk session token, `Authorization: Bearer <token>` — the first-party
        browser app's own auth. Used only by this internal `/api/v1/*` surface,
        never by `/api/public/v1/*`.

````