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

# calculateCompatibilityScore

> Calls a action at the path matching/index.js:calculateCompatibilityScore



## OpenAPI

````yaml api-reference/convex-openapi.yaml post /api/run/matching/index/calculateCompatibilityScore
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/matching/index/calculateCompatibilityScore:
    post:
      tags:
        - System
      summary: calculateCompatibilityScore
      description: Calls a action at the path matching/index.js:calculateCompatibilityScore
      operationId: postApiRunMatchingIndexCalculateCompatibilityScore
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/Request_matching.index.calculateCompatibilityScore
        required: true
      responses:
        '200':
          description: Convex executed your request and returned a result
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Response_matching.index.calculateCompatibilityScore
        '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_matching.index.calculateCompatibilityScore:
      type: object
      required:
        - args
      properties:
        args:
          type: object
          required:
            - user1Constraints
            - user1Id
            - user2Constraints
            - user2Id
          properties:
            customWeights:
              type: object
              required:
                - experienceGap
                - industryMatch
                - interestOverlap
                - languageOverlap
                - orgConstraintMatch
                - roleComplementarity
                - timezoneCompatibility
                - vectorSimilarity
              properties:
                experienceGap:
                  type: number
                industryMatch:
                  type: number
                interestOverlap:
                  type: number
                languageOverlap:
                  type: number
                orgConstraintMatch:
                  type: number
                roleComplementarity:
                  type: number
                timezoneCompatibility:
                  type: number
                vectorSimilarity:
                  type: number
            user1Constraints:
              type: object
              required:
                - interests
                - roles
              properties:
                interests:
                  type: array
                  items:
                    type: string
                orgConstraints:
                  type: string
                roles:
                  type: array
                  items:
                    type: string
            user1Id:
              type: string
              description: ID from table "users"
            user2Constraints:
              type: object
              required:
                - interests
                - roles
              properties:
                interests:
                  type: array
                  items:
                    type: string
                orgConstraints:
                  type: string
                roles:
                  type: array
                  items:
                    type: string
            user2Id:
              type: string
              description: ID from table "users"
    Response_matching.index.calculateCompatibilityScore:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - success
            - error
        errorMessage:
          type: string
        errorData:
          type: object
        value:
          type: object
          required:
            - explanation
            - features
            - score
          properties:
            explanation:
              type: array
              items:
                type: string
            features:
              type: object
              required:
                - experienceGap
                - industryMatch
                - interestOverlap
                - languageOverlap
                - orgConstraintMatch
                - roleComplementarity
                - timezoneCompatibility
              properties:
                experienceGap:
                  type: number
                industryMatch:
                  type: number
                interestOverlap:
                  type: number
                languageOverlap:
                  type: number
                orgConstraintMatch:
                  type: number
                roleComplementarity:
                  type: number
                timezoneCompatibility:
                  type: number
                vectorSimilarity:
                  type: number
            score:
              type: number
    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>`.

````