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

> Create a new goal. Supports up to 3 active goals; the oldest is deactivated if at max.

- **title**: The goal title/description (1-500 characters)
- **goal_type**: Type of goal metric: boolean, scale, or numeric (default: scale)
- **target_value**: Target value to achieve
- **current_value**: Current progress (default: 0)
- **min_value**: Minimum scale value (default: 0)
- **max_value**: Maximum scale value (default: 10)
- **unit**: Optional unit label (e.g., 'users', 'points')



## OpenAPI

````yaml /api-reference/openapi.json post /v1/dev/user/goals
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/user/goals:
    post:
      tags:
        - Goals
      summary: Create Goal
      description: >-
        Create a new goal. Supports up to 3 active goals; the oldest is
        deactivated if at max.


        - **title**: The goal title/description (1-500 characters)

        - **goal_type**: Type of goal metric: boolean, scale, or numeric
        (default: scale)

        - **target_value**: Target value to achieve

        - **current_value**: Current progress (default: 0)

        - **min_value**: Minimum scale value (default: 0)

        - **max_value**: Maximum scale value (default: 10)

        - **unit**: Optional unit label (e.g., 'users', 'points')
      operationId: createGoal
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGoalRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperGoal'
          description: Successful Response
        '401':
          $ref: '#/components/responses/Error401'
        '403':
          $ref: '#/components/responses/Error403'
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - developerApiKey: []
components:
  schemas:
    CreateGoalRequest:
      properties:
        current_value:
          default: 0
          description: Current progress value
          title: Current Value
          type: number
        goal_type:
          $ref: '#/components/schemas/GoalType'
          default: scale
          description: 'Type of goal metric: boolean, scale, or numeric'
        max_value:
          default: 10
          description: Maximum value of the scale
          title: Max Value
          type: number
        min_value:
          default: 0
          description: Minimum value of the scale
          title: Min Value
          type: number
        target_value:
          description: Target value to achieve
          title: Target Value
          type: number
        title:
          description: The goal title/description
          maxLength: 500
          minLength: 1
          title: Title
          type: string
        unit:
          anyOf:
            - type: string
            - type: 'null'
          description: Unit label (e.g., 'users', 'points')
          title: Unit
      required:
        - title
        - target_value
      title: CreateGoalRequest
      type: object
    DeveloperGoal:
      properties:
        created_at:
          format: date-time
          title: Created At
          type: string
        current_value:
          title: Current Value
          type: number
        goal_type:
          title: Goal Type
          type: string
        id:
          title: Id
          type: string
        is_active:
          title: Is Active
          type: boolean
        max_value:
          title: Max Value
          type: number
        min_value:
          title: Min Value
          type: number
        target_value:
          title: Target Value
          type: number
        title:
          title: Title
          type: string
        unit:
          anyOf:
            - type: string
            - type: 'null'
          title: Unit
        updated_at:
          format: date-time
          title: Updated At
          type: string
      required:
        - id
        - title
        - goal_type
        - target_value
        - current_value
        - min_value
        - max_value
        - is_active
        - created_at
        - updated_at
      title: DeveloperGoal
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    GoalType:
      enum:
        - boolean
        - scale
        - numeric
      title: GoalType
      type: string
    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.
    Error403:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Authenticated, but the token does not grant the required scope.
  securitySchemes:
    developerApiKey:
      bearerFormat: Omi Developer API key
      description: 'Send `Authorization: Bearer <omi_developer_api_key>`.'
      scheme: bearer
      type: http

````