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

# vectorSimilaritySearch

> Perform vector similarity search (public)



## OpenAPI

````yaml api-reference/convex-openapi.yaml post /api/run/embeddings/queries/vectorSimilaritySearch
openapi: 3.0.3
info:
  title: Connvo Convex API
  version: 1.0.0
  description: >-
    HTTP interface for Connvo's Convex backend, exposing vetted query, mutation,
    and action endpoints.
servers:
  - url: https://Connvo-dev.convex.cloud
    description: Dev Convex deployment
  - url: https://Connvo-staging.convex.cloud
    description: Staging Convex deployment
  - url: https://Connvo-prod.convex.cloud
    description: Prod Convex deployment
security:
  - bearerAuth: []
tags:
  - name: Users
    description: Identity, profile, and authentication operations for Connvo users.
  - name: Meetings
    description: Scheduling, managing, and retrieving meeting data.
  - name: Transcripts
    description: Endpoints for accessing call transcripts and transcription controls.
  - name: Insights
    description: AI-generated insights, summaries, and analytics derived from meetings.
  - name: Prompts
    description: Prompt management and AI conversation guidance.
  - name: Notes
    description: Collaborative meeting notes and follow-up documentation.
  - name: WebRTC
    description: Real-time communication, session signalling, and media utilities.
  - name: System
    description: General system endpoints such as health checks and diagnostics.
paths:
  /api/run/embeddings/queries/vectorSimilaritySearch:
    post:
      tags:
        - System
      summary: vectorSimilaritySearch
      description: Perform vector similarity search (public)
      operationId: postApiRunEmbeddingsQueriesVectorSimilaritySearch
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/Request_embeddings.queries.vectorSimilaritySearch
        required: true
      responses:
        '200':
          description: Convex executed your request and returned a result
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Response_embeddings.queries.vectorSimilaritySearch
        '400':
          description: Failed operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
        '500':
          description: Convex Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    Request_embeddings.queries.vectorSimilaritySearch:
      type: object
      required:
        - args
      properties:
        args:
          type: object
          required:
            - queryVector
          properties:
            limit:
              type: number
            model:
              type: string
            queryVector:
              type: string
              format: binary
            sourceTypes:
              type: array
              items:
                oneOf:
                  - type: string
                    enum:
                      - user
                  - type: string
                    enum:
                      - profile
                  - type: string
                    enum:
                      - meeting
                  - type: string
                    enum:
                      - note
                  - type: string
                    enum:
                      - transcriptSegment
            threshold:
              type: number
    Response_embeddings.queries.vectorSimilaritySearch:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - success
            - error
        errorMessage:
          type: string
        errorData:
          type: object
        value:
          type: array
          items:
            type: object
            required:
              - embedding
              - score
            properties:
              embedding:
                type: object
                required:
                  - _creationTime
                  - _id
                  - createdAt
                  - dimensions
                  - metadata
                  - model
                  - sourceId
                  - sourceType
                  - vector
                  - version
                properties:
                  _creationTime:
                    type: number
                  _id:
                    type: string
                    description: ID from table "embeddings"
                  createdAt:
                    type: number
                  dimensions:
                    type: number
                  metadata:
                    type: object
                  model:
                    type: string
                  sourceId:
                    type: string
                  sourceType:
                    oneOf:
                      - type: string
                        enum:
                          - user
                      - type: string
                        enum:
                          - profile
                      - type: string
                        enum:
                          - meeting
                      - type: string
                        enum:
                          - note
                      - type: string
                        enum:
                          - transcriptSegment
                  vector:
                    type: string
                    format: binary
                  version:
                    type: string
              score:
                type: number
              sourceData: {}
    FailedResponse:
      type: object
      properties: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Standard user authentication token issued via WorkOS. Provide as
        `Authorization: Bearer <user-token>`.

````