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

# Create API key

> Create a new developer API key. The full key is only returned once — store it securely immediately.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/dev/keys
openapi: 3.1.0
info:
  title: Omi Developer API
  description: >-
    Programmatic access to your Omi data — memories, conversations, action
    items, and API keys. Build custom integrations, analytics dashboards, and
    automation workflows.
  version: 1.0.0
  contact:
    name: Omi
    url: https://omi.me
  license:
    name: MIT
    url: https://github.com/BasedHardware/omi/blob/main/LICENSE
servers:
  - url: https://api.omi.me
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Memories
    description: Read and write user memories — timeless facts, preferences, and insights.
  - name: Conversations
    description: Create and retrieve conversation transcripts with AI-generated summaries.
  - name: Folders
    description: Retrieve user-defined folders for organizing conversations.
  - name: Action Items
    description: Manage tasks and to-dos extracted from conversations or created manually.
  - name: API Keys
    description: Create, list, and revoke developer API keys.
paths:
  /v1/dev/keys:
    post:
      tags:
        - API Keys
      summary: Create API key
      description: >-
        Create a new developer API key. The full key is only returned once —
        store it securely immediately.
      operationId: createApiKey
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApiKey'
            example:
              name: My New Integration
      responses:
        '200':
          description: The created API key with full secret.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyCreated'
              example:
                id: key_789ghi
                name: My New Integration
                key_prefix: omi_dev_ghi789
                key: omi_dev_ghi789_full_secret_key_here
                created_at: '2025-01-20T15:00:00Z'
                last_used_at: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    CreateApiKey:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          description: Descriptive name for the key.
        scopes:
          type: array
          items:
            type: string
            enum:
              - conversations:read
              - conversations:write
              - memories:read
              - memories:write
              - action_items:read
              - action_items:write
              - goals:read
              - goals:write
          description: >-
            Optional scopes to assign. Defaults to read-only
            (conversations:read, memories:read, action_items:read, goals:read)
            if not provided.
    ApiKeyCreated:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        key_prefix:
          type: string
        key:
          type: string
          description: The full API key. **Only returned once during creation.**
        created_at:
          type: string
          format: date-time
        last_used_at:
          type:
            - string
            - 'null'
          format: date-time
        scopes:
          type:
            - array
            - 'null'
          items:
            type: string
          description: >-
            Permission scopes assigned to the API key. Null for legacy keys
            (treated as read-only).
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
          description: Error description.
  responses:
    Unauthorized:
      description: Invalid or missing API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            detail: Invalid API key
    ValidationError:
      description: Validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            detail: 'Validation error: content is required'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Developer API key. Get one from **Settings → Developer → Create Key** in
        the Omi app. Keys are prefixed with `omi_dev_`.

````