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

# Create an API key

> Create a key for the workspace. The raw secret is returned once, here, and never again.



## OpenAPI

````yaml https://api.spreadjam.com/openapi.json post /v1/api-keys
openapi: 3.0.0
info:
  title: SpreadJam API
  version: 1.0.0
servers: []
security: []
tags:
  - name: Meta
    description: Identity and metadata about the authenticated key.
  - name: Keywords
    description: Keyword and topic visibility rankings.
  - name: API keys
    description: Manage the workspace's API keys.
  - name: Analytics
    description: AI-visibility analytics for the workspace.
  - name: Brand
    description: The workspace's brand profile and competitors.
  - name: Prompts
    description: Tracked GEO prompts and their cap state.
paths:
  /v1/api-keys:
    post:
      tags:
        - API keys
      summary: Create an API key
      description: >-
        Create a key for the workspace. The raw secret is returned once, here,
        and never again.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueApiKey'
      responses:
        '201':
          description: The created key, including the raw secret.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssuedApiKey'
      security:
        - bearerAuth: []
components:
  schemas:
    IssueApiKey:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 80
          description: A label so you can find the key later.
        environment:
          type: string
          enum:
            - test
          default: test
          description: >-
            The key environment. Only `test` is issued today; live keys require
            a paid plan.
      required:
        - name
    IssuedApiKey:
      type: object
      properties:
        id:
          type: string
        key:
          type: string
          description: The raw secret key. Shown once, at creation; store it now.
        keyPrefix:
          type: string
      required:
        - id
        - key
        - keyPrefix
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A workspace API key issued in Settings → Developer, sent as `Bearer
        sk_…`.

````

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