> ## 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 Key

> Create a new Developer API key with optional scopes.

- **name**: Descriptive name for the key
- **scopes**: Optional list of scopes. If not provided, defaults to read-only access.
  Available scopes:
  - conversations:read
  - conversations:write
  - memories:read
  - memories:write
  - action_items:read
  - action_items:write
  - goals:read
  - goals:write



## OpenAPI

````yaml /api-reference/openapi.json post /v1/dev/keys
openapi: 3.1.0
info:
  contact:
    name: Omi
    url: https://omi.me/
  description: >-
    Programmatic access to your Omi data - memories, conversations, action
    items, goals, folders, and API keys. Build custom integrations, analytics
    dashboards, and automation workflows.
  license:
    name: MIT
    url: https://github.com/BasedHardware/omi/blob/main/LICENSE
  title: Omi Developer API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.omi.me
security: []
tags:
  - description: Read and write user memories - timeless facts, preferences, and insights.
    name: Memories
  - description: Create and retrieve conversation transcripts with AI-generated summaries.
    name: Conversations
  - description: Retrieve user-defined folders for organizing conversations.
    name: Folders
  - description: Manage tasks and to-dos extracted from conversations or created manually.
    name: Action Items
  - description: Manage user goals and progress history.
    name: Goals
  - description: Create, list, and revoke developer API keys.
    name: API Keys
paths:
  /v1/dev/keys:
    post:
      tags:
        - API Keys
      summary: Create Key
      description: >-
        Create a new Developer API key with optional scopes.


        - **name**: Descriptive name for the key

        - **scopes**: Optional list of scopes. If not provided, defaults to
        read-only access.
          Available scopes:
          - conversations:read
          - conversations:write
          - memories:read
          - memories:write
          - action_items:read
          - action_items:write
          - goals:read
          - goals:write
      operationId: createApiKey
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DevApiKeyCreate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevApiKeyCreated'
          description: Successful Response
        '401':
          $ref: '#/components/responses/Error401'
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - firebaseBearer: []
components:
  schemas:
    DevApiKeyCreate:
      properties:
        name:
          title: Name
          type: string
        scopes:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Scopes
      required:
        - name
      title: DevApiKeyCreate
      type: object
    DevApiKeyCreated:
      properties:
        created_at:
          format: date-time
          title: Created At
          type: string
        id:
          title: Id
          type: string
        key:
          title: Key
          type: string
        key_prefix:
          title: Key Prefix
          type: string
        last_used_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Last Used At
        name:
          title: Name
          type: string
        scopes:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Scopes
      required:
        - id
        - name
        - key_prefix
        - created_at
        - key
      title: DevApiKeyCreated
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ErrorResponse:
      properties:
        detail:
          anyOf:
            - type: string
            - type: array
            - type: object
          description: Error detail returned by the API.
      required:
        - detail
      title: ErrorResponse
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  responses:
    Error401:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Missing or invalid authentication credentials.
  securitySchemes:
    firebaseBearer:
      bearerFormat: Firebase ID token
      description: 'Send `Authorization: Bearer <firebase_id_token>`.'
      scheme: bearer
      type: http

````