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

# Ask Conversations

> Answer a natural-language question grounded in the user's own conversations.

Semantically searches the user's conversations for the question, then synthesizes a
cited answer from the most relevant ones — the same retrieval + RAG the chat surface
uses, exposed for headless / Developer-API callers (CLI, CI, scripts). Read-only:
it never writes; discarded conversations are excluded from retrieval and locked
conversations are re-checked on the authoritative record before any go to the LLM.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/dev/user/ask
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/ask:
    post:
      tags:
        - Conversations
      summary: Ask Conversations
      description: >-
        Answer a natural-language question grounded in the user's own
        conversations.


        Semantically searches the user's conversations for the question, then
        synthesizes a

        cited answer from the most relevant ones — the same retrieval + RAG the
        chat surface

        uses, exposed for headless / Developer-API callers (CLI, CI, scripts).
        Read-only:

        it never writes; discarded conversations are excluded from retrieval and
        locked

        conversations are re-checked on the authoritative record before any go
        to the LLM.
      operationId: ask
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeveloperAskRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeveloperAskResponse'
          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:
    DeveloperAskRequest:
      properties:
        limit:
          default: 5
          description: How many of the most relevant conversations to ground the answer on
          maximum: 10
          minimum: 1
          title: Limit
          type: integer
        question:
          description: A natural-language question about the user's life/conversations
          maxLength: 1000
          minLength: 1
          title: Question
          type: string
        timezone:
          default: UTC
          description: IANA timezone used to resolve relative dates in the answer
          title: Timezone
          type: string
      required:
        - question
      title: DeveloperAskRequest
      type: object
    DeveloperAskResponse:
      properties:
        answer:
          title: Answer
          type: string
        sources:
          items:
            $ref: '#/components/schemas/DeveloperAskSource'
          title: Sources
          type: array
      required:
        - answer
        - sources
      title: DeveloperAskResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    DeveloperAskSource:
      properties:
        created_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Created At
        id:
          title: Id
          type: string
        title:
          title: Title
          type: string
      required:
        - id
        - title
      title: DeveloperAskSource
      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.
    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

````