Skip to content

Lexi API — HTTP reference

Generated from FastAPI OpenAPI and versioned with the source code. Edit routes, Pydantic schemas and their examples, then run python -m scripts.update_http_reference to update this page.

Lexi API on this instance: Swagger · ReDoc · Live OpenAPI JSON

Paths below include the application mount. Add your deployment prefix when calling them. Live Swagger/ReDoc includes deployment-specific defaults; this static snapshot uses source defaults and never reads tenant databases.

11 HTTP operations. WebSocket and MCP transports are documented separately. Metrics and framework routes excluded from OpenAPI are not HTTP contract entries.

Use the Live OpenAPI JSON link above for the complete schema served by this application.

Operations

Method Mounted path Summary
POST /lexi/api/v1/find_duplicates Find Duplicates
POST /lexi/api/v1/jobs/assign_families Assign Families
POST /lexi/api/v1/jobs/generate_skills Jsm Get Skills Lexi
POST /lexi/api/v1/jobs/get_skill_descriptions Get Skill Descriptions
POST /lexi/api/v1/jobs/get_skill_level_descriptions Get Skill Level Descriptions
POST /lexi/api/v1/jobs/get_skill_levels Get Skill Levels
POST /lexi/api/v1/jobs/suggest_missions Suggest Missions
POST /lexi/api/v1/jobs/suggest_skills Suggest Skills
POST /lexi/api/v1/referentials/analyze Analyze Lexi Referential
POST /lexi/api/v1/skills/assign_to_jobs Assign Skills To Jobs
POST /lexi/api/v1/skills/normalize_labels Normalize Labels

POST /lexi/api/v1/find_duplicates

Find Duplicates

Database compatibility: MongoDB + PostgreSQL.

Group semantically duplicate objects.

Path parameters and metadata

{}

Authentication

[
  {
    "APIKeyHeader": []
  },
  {
    "Client-ID": []
  },
  {
    "HTTPBearer": []
  }
]

Parameters

[]

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/FindDuplicatesInput"
          },
          {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        ],
        "description": "Labels to compare using embeddings and OpenAI Decisions.",
        "title": "Payload"
      }
    }
  },
  "required": true
}

Referenced definitions: components/schemas/FindDuplicatesInput.

Responses

{
  "200": {
    "content": {
      "application/json": {
        "example": [
          [
            "Project management",
            "Managing projects"
          ],
          [
            "Data analysis"
          ]
        ],
        "schema": {
          "items": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "title": "Response Find Duplicates Api V1 Find Duplicates Post",
          "type": "array"
        }
      }
    },
    "description": "Confirmed groups, including unmatched singleton labels."
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Referenced definitions: components/schemas/HTTPValidationError.

Operation metadata

{
  "operationId": "find_duplicates_api_v1_find_duplicates_post",
  "tags": [
    "Lexi"
  ],
  "x-database-compatibility": "MongoDB + PostgreSQL"
}

POST /lexi/api/v1/jobs/assign_families

Assign Families

Database compatibility: MongoDB + PostgreSQL.

Assign jobs to the most relevant job family.

Path parameters and metadata

{}

Authentication

[
  {
    "APIKeyHeader": []
  },
  {
    "Client-ID": []
  },
  {
    "HTTPBearer": []
  }
]

Parameters

[]

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AssignFamiliesInput",
        "description": "Job families and jobs to classify"
      }
    }
  },
  "required": true
}

Referenced definitions: components/schemas/AssignFamiliesInput.

Responses

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Referenced definitions: components/schemas/HTTPValidationError.

Operation metadata

{
  "operationId": "assign_families_api_v1_jobs_assign_families_post",
  "tags": [
    "Lexi"
  ],
  "x-database-compatibility": "MongoDB + PostgreSQL"
}

POST /lexi/api/v1/jobs/generate_skills

Jsm Get Skills Lexi

Database compatibility: MongoDB + PostgreSQL.

Generate normalized skills for a collection of jobs.

Path parameters and metadata

{}

Authentication

[
  {
    "APIKeyHeader": []
  },
  {
    "Client-ID": []
  },
  {
    "HTTPBearer": []
  }
]

Parameters

[]

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/LexiJobToSkillsRequest"
      }
    }
  },
  "required": true
}

Referenced definitions: components/schemas/LexiJobToSkillsRequest.

Responses

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Referenced definitions: components/schemas/HTTPValidationError.

Operation metadata

{
  "operationId": "jsm_get_skills_lexi_api_v1_jobs_generate_skills_post",
  "tags": [
    "Lexi"
  ],
  "x-database-compatibility": "MongoDB + PostgreSQL"
}

POST /lexi/api/v1/jobs/get_skill_descriptions

Get Skill Descriptions

Database compatibility: MongoDB + PostgreSQL.

Generate descriptions for job skills.

Path parameters and metadata

{}

Authentication

[
  {
    "APIKeyHeader": []
  },
  {
    "Client-ID": []
  },
  {
    "HTTPBearer": []
  }
]

Parameters

[]

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/LexiSkillDescriptionsRequest",
        "description": "Skills whose descriptions must be generated"
      }
    }
  },
  "required": true
}

Referenced definitions: components/schemas/LexiSkillDescriptionsRequest.

Responses

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/LexiSkillDescriptionsResponse"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Referenced definitions: components/schemas/HTTPValidationError, components/schemas/LexiSkillDescriptionsResponse.

Operation metadata

{
  "operationId": "get_skill_descriptions_api_v1_jobs_get_skill_descriptions_post",
  "tags": [
    "Lexi"
  ],
  "x-database-compatibility": "MongoDB + PostgreSQL"
}

POST /lexi/api/v1/jobs/get_skill_level_descriptions

Get Skill Level Descriptions

Database compatibility: MongoDB + PostgreSQL.

Generate contextual descriptions for every level of each skill.

Path parameters and metadata

{}

Authentication

[
  {
    "APIKeyHeader": []
  },
  {
    "Client-ID": []
  },
  {
    "HTTPBearer": []
  }
]

Parameters

[]

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/LexiSkillLevelDescriptionsRequest",
        "description": "Skills whose proficiency-level descriptions must be generated"
      }
    }
  },
  "required": true
}

Referenced definitions: components/schemas/LexiSkillLevelDescriptionsRequest.

Responses

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/LexiSkillLevelDescriptionsResponse"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Referenced definitions: components/schemas/HTTPValidationError, components/schemas/LexiSkillLevelDescriptionsResponse.

Operation metadata

{
  "operationId": "get_skill_level_descriptions_api_v1_jobs_get_skill_level_descriptions_post",
  "tags": [
    "Lexi"
  ],
  "x-database-compatibility": "MongoDB + PostgreSQL"
}

POST /lexi/api/v1/jobs/get_skill_levels

Get Skill Levels

Database compatibility: MongoDB + PostgreSQL.

Infer proficiency levels for job skills.

Path parameters and metadata

{}

Authentication

[
  {
    "APIKeyHeader": []
  },
  {
    "Client-ID": []
  },
  {
    "HTTPBearer": []
  }
]

Parameters

[]

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/LexiSkillLevelsRequest",
        "description": "Jobs with their skills and the requested proficiency scale"
      }
    }
  },
  "required": true
}

Referenced definitions: components/schemas/LexiSkillLevelsRequest.

Responses

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/LexiSkillLevelsResponse"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Referenced definitions: components/schemas/HTTPValidationError, components/schemas/LexiSkillLevelsResponse.

Operation metadata

{
  "operationId": "get_skill_levels_api_v1_jobs_get_skill_levels_post",
  "tags": [
    "Lexi"
  ],
  "x-database-compatibility": "MongoDB + PostgreSQL"
}

POST /lexi/api/v1/jobs/suggest_missions

Suggest Missions

Database compatibility: MongoDB + PostgreSQL.

Suggest representative missions for a job.

Path parameters and metadata

{}

Authentication

[
  {
    "APIKeyHeader": []
  },
  {
    "Client-ID": []
  },
  {
    "HTTPBearer": []
  }
]

Parameters

[]

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/LexiJobMissionSuggestionsRequest",
        "description": "Jobs whose missing missions must be suggested"
      }
    }
  },
  "required": true
}

Referenced definitions: components/schemas/LexiJobMissionSuggestionsRequest.

Responses

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/LexiJobMissionSuggestionsResponse"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Referenced definitions: components/schemas/HTTPValidationError, components/schemas/LexiJobMissionSuggestionsResponse.

Operation metadata

{
  "operationId": "suggest_missions_api_v1_jobs_suggest_missions_post",
  "tags": [
    "Lexi"
  ],
  "x-database-compatibility": "MongoDB + PostgreSQL"
}

POST /lexi/api/v1/jobs/suggest_skills

Suggest Skills

Database compatibility: MongoDB + PostgreSQL.

Suggest new competencies for a job on a theme, grounded in the existing referential.

Path parameters and metadata

{}

Authentication

[
  {
    "APIKeyHeader": []
  },
  {
    "Client-ID": []
  },
  {
    "HTTPBearer": []
  }
]

Parameters

[]

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/LexiJobSkillSuggestionsRequest",
        "description": "Jobs whose missing skills must be suggested for a theme"
      }
    }
  },
  "required": true
}

Referenced definitions: components/schemas/LexiJobSkillSuggestionsRequest.

Responses

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/LexiJobSkillSuggestionsResponse"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Referenced definitions: components/schemas/HTTPValidationError, components/schemas/LexiJobSkillSuggestionsResponse.

Operation metadata

{
  "operationId": "suggest_skills_api_v1_jobs_suggest_skills_post",
  "tags": [
    "Lexi"
  ],
  "x-database-compatibility": "MongoDB + PostgreSQL"
}

POST /lexi/api/v1/referentials/analyze

Analyze Lexi Referential

Database compatibility: MongoDB + PostgreSQL.

Analyze an authorized complete snapshot without persisting client data.

Path parameters and metadata

{}

Authentication

[
  {
    "APIKeyHeader": []
  },
  {
    "Client-ID": []
  },
  {
    "HTTPBearer": []
  }
]

Parameters

[]

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ReferentialAnalysisRequest"
      }
    }
  },
  "required": true
}

Referenced definitions: components/schemas/ReferentialAnalysisRequest.

Responses

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/ReferentialAnalysisResponse"
            },
            {
              "$ref": "#/components/schemas/ReferentialAnalysisAccepted"
            }
          ],
          "title": "Response Analyze Lexi Referential Api V1 Referentials Analyze Post"
        }
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Referenced definitions: components/schemas/HTTPValidationError, components/schemas/ReferentialAnalysisAccepted, components/schemas/ReferentialAnalysisResponse.

Operation metadata

{
  "operationId": "analyze_lexi_referential_api_v1_referentials_analyze_post",
  "tags": [
    "Lexi"
  ],
  "x-database-compatibility": "MongoDB + PostgreSQL"
}

POST /lexi/api/v1/skills/assign_to_jobs

Assign Skills To Jobs

Database compatibility: MongoDB + PostgreSQL.

Assign skills to their most relevant jobs.

Path parameters and metadata

{}

Authentication

[
  {
    "APIKeyHeader": []
  },
  {
    "Client-ID": []
  },
  {
    "HTTPBearer": []
  }
]

Parameters

[]

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AssignSkillsToJobsInput",
        "description": "Skills and jobs to classify"
      }
    }
  },
  "required": true
}

Referenced definitions: components/schemas/AssignSkillsToJobsInput.

Responses

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Referenced definitions: components/schemas/HTTPValidationError.

Operation metadata

{
  "operationId": "assign_skills_to_jobs_api_v1_skills_assign_to_jobs_post",
  "tags": [
    "Lexi"
  ],
  "x-database-compatibility": "MongoDB + PostgreSQL"
}

POST /lexi/api/v1/skills/normalize_labels

Normalize Labels

Database compatibility: MongoDB + PostgreSQL.

Normalize skill labels into concise names.

Path parameters and metadata

{}

Authentication

[
  {
    "APIKeyHeader": []
  },
  {
    "Client-ID": []
  },
  {
    "HTTPBearer": []
  }
]

Parameters

[]

Request body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/NormalizeLabelsInput",
        "description": "Skills and optional skill format to normalize"
      }
    }
  },
  "required": true
}

Referenced definitions: components/schemas/NormalizeLabelsInput.

Responses

{
  "200": {
    "content": {
      "application/json": {
        "schema": {}
      }
    },
    "description": "Successful Response"
  },
  "422": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/HTTPValidationError"
        }
      }
    },
    "description": "Validation Error"
  }
}

Referenced definitions: components/schemas/HTTPValidationError.

Operation metadata

{
  "operationId": "normalize_labels_api_v1_skills_normalize_labels_post",
  "tags": [
    "Lexi"
  ],
  "x-database-compatibility": "MongoDB + PostgreSQL"
}

Shared definitions

AnalysisJob (schemas)

{
  "additionalProperties": false,
  "description": "Model AnalysisJob for the shared Lexi quality contract.",
  "properties": {
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "id": {
      "title": "Id",
      "type": "string"
    },
    "job_familly": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Familly"
    },
    "missions": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Missions"
    },
    "referential_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Referential Id"
    },
    "title": {
      "title": "Title",
      "type": "string"
    }
  },
  "required": [
    "id",
    "title"
  ],
  "title": "AnalysisJob",
  "type": "object"
}

AnalysisReferential (schemas)

{
  "additionalProperties": false,
  "description": "Model AnalysisReferential for the shared Lexi quality contract.",
  "properties": {
    "id": {
      "title": "Id",
      "type": "string"
    },
    "name": {
      "default": "",
      "title": "Name",
      "type": "string"
    },
    "skills_per_job": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Skills Per Job"
    }
  },
  "required": [
    "id"
  ],
  "title": "AnalysisReferential",
  "type": "object"
}

AnalysisRequirement (schemas)

{
  "additionalProperties": false,
  "description": "Model AnalysisRequirement for the shared Lexi quality contract.",
  "properties": {
    "job_id": {
      "title": "Job Id",
      "type": "string"
    },
    "required_level": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Required Level"
    },
    "skill_id": {
      "title": "Skill Id",
      "type": "string"
    }
  },
  "required": [
    "job_id",
    "skill_id"
  ],
  "title": "AnalysisRequirement",
  "type": "object"
}

AnalysisSkill (schemas)

{
  "additionalProperties": false,
  "description": "Model AnalysisSkill for the shared Lexi quality contract.",
  "properties": {
    "category_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Category Id"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "external_skill_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "External Skill Code"
    },
    "id": {
      "title": "Id",
      "type": "string"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "referential_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Referential Id"
    },
    "skill_group": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Skill Group"
    },
    "type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Type"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "title": "AnalysisSkill",
  "type": "object"
}

AnalysisSnapshot (schemas)

{
  "additionalProperties": false,
  "description": "A complete authorized scope; never a sampled page of a referential.",
  "properties": {
    "dgi_available": {
      "default": false,
      "title": "Dgi Available",
      "type": "boolean"
    },
    "dgi_ratio": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dgi Ratio"
    },
    "external_skills": {
      "items": {
        "$ref": "#/components/schemas/AnalysisSkill"
      },
      "title": "External Skills",
      "type": "array"
    },
    "jobs": {
      "items": {
        "$ref": "#/components/schemas/AnalysisJob"
      },
      "title": "Jobs",
      "type": "array"
    },
    "outside_skill_usage": {
      "additionalProperties": {
        "type": "integer"
      },
      "title": "Outside Skill Usage",
      "type": "object"
    },
    "population_job_count": {
      "anyOf": [
        {
          "minimum": 0.0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Population Job Count"
    },
    "referential_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Referential Id"
    },
    "referentials": {
      "items": {
        "$ref": "#/components/schemas/AnalysisReferential"
      },
      "title": "Referentials",
      "type": "array"
    },
    "requirements": {
      "items": {
        "$ref": "#/components/schemas/AnalysisRequirement"
      },
      "title": "Requirements",
      "type": "array"
    },
    "semantic_label_order": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "title": "Semantic Label Order",
      "type": "object"
    },
    "skills": {
      "items": {
        "$ref": "#/components/schemas/AnalysisSkill"
      },
      "title": "Skills",
      "type": "array"
    },
    "suppressed_skill_pairs": {
      "items": {
        "maxItems": 2,
        "minItems": 2,
        "prefixItems": [
          {
            "type": "string"
          },
          {
            "type": "string"
          }
        ],
        "type": "array"
      },
      "title": "Suppressed Skill Pairs",
      "type": "array"
    },
    "validated_job_ids": {
      "items": {
        "type": "string"
      },
      "title": "Validated Job Ids",
      "type": "array"
    }
  },
  "title": "AnalysisSnapshot",
  "type": "object"
}

Referenced definitions: components/schemas/AnalysisJob, components/schemas/AnalysisReferential, components/schemas/AnalysisRequirement, components/schemas/AnalysisSkill.

AssignFamiliesInput (schemas)

{
  "description": "Validate and serialize assign families input data.",
  "examples": [
    {
      "job_families": [
        "Data and analytics",
        "Human resources"
      ],
      "jobs_to_classify": [
        "Data analyst",
        "Recruitment specialist"
      ]
    }
  ],
  "properties": {
    "family_populations": {
      "additionalProperties": {
        "type": "integer"
      },
      "title": "Family Populations",
      "type": "object"
    },
    "job_families": {
      "items": {
        "type": "string"
      },
      "title": "Job Families",
      "type": "array"
    },
    "jobs_to_classify": {
      "items": {
        "type": "string"
      },
      "title": "Jobs To Classify",
      "type": "array"
    },
    "policy_version": {
      "anyOf": [
        {
          "const": "lexi-referential-v1",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Policy Version"
    }
  },
  "required": [
    "job_families",
    "jobs_to_classify"
  ],
  "title": "AssignFamiliesInput",
  "type": "object"
}

AssignSkillsToJobsInput (schemas)

{
  "description": "Validate and serialize assign skills to jobs input data.",
  "examples": [
    {
      "jobs": [
        "Data analyst",
        "Project manager"
      ],
      "skills": [
        "Data analysis",
        "Project planning",
        "Stakeholder communication"
      ]
    }
  ],
  "properties": {
    "jobs": {
      "items": {
        "type": "string"
      },
      "title": "Jobs",
      "type": "array"
    },
    "skills": {
      "items": {
        "type": "string"
      },
      "title": "Skills",
      "type": "array"
    }
  },
  "required": [
    "jobs",
    "skills"
  ],
  "title": "AssignSkillsToJobsInput",
  "type": "object"
}

CatalogReference (schemas)

{
  "additionalProperties": false,
  "description": "Identify and authenticate the exact catalogue bytes.",
  "properties": {
    "fingerprint": {
      "description": "SHA-256 digest of the exact catalogue file bytes; compute it for your file.",
      "examples": [
        "c3b5b7293f1cb413f3e6c1e97996c016f5d4e49b4d02ba79dfca77d8c27d1acd"
      ],
      "pattern": "^[a-f0-9]{64}$",
      "title": "Fingerprint",
      "type": "string"
    },
    "run_id": {
      "examples": [
        "b88c9f26-3de6-4a7f-891b-09ee84a83593"
      ],
      "format": "uuid",
      "title": "Run Id",
      "type": "string"
    },
    "url": {
      "description": "Private signed download URL for the catalogue file.",
      "examples": [
        "https://storage.example.com/catalogs/skills.json"
      ],
      "title": "Url",
      "type": "string"
    }
  },
  "required": [
    "run_id",
    "fingerprint",
    "url"
  ],
  "title": "CatalogReference",
  "type": "object"
}

FindDuplicatesInput (schemas)

{
  "additionalProperties": false,
  "description": "Validate and serialize find duplicates input data.",
  "examples": [
    {
      "objects": [
        "Project management",
        "Managing projects",
        "Data analysis"
      ]
    }
  ],
  "properties": {
    "objects": {
      "items": {
        "type": "string"
      },
      "title": "Objects",
      "type": "array"
    }
  },
  "required": [
    "objects"
  ],
  "title": "FindDuplicatesInput",
  "type": "object"
}

HTTPValidationError (schemas)

{
  "properties": {
    "detail": {
      "items": {
        "$ref": "#/components/schemas/ValidationError"
      },
      "title": "Detail",
      "type": "array"
    }
  },
  "title": "HTTPValidationError",
  "type": "object"
}

Referenced definitions: components/schemas/ValidationError.

JsonValue (schemas)

{}

LLMEnum (schemas)

{
  "description": "Enumerate supported LLM values.",
  "enum": [
    "openAI",
    "Anthropic"
  ],
  "title": "LLMEnum",
  "type": "string"
}

LexiIdentifiedJobSkill (schemas)

{
  "additionalProperties": true,
  "description": "Model Lexi identified job skill state.",
  "properties": {
    "skill_code": {
      "minLength": 1,
      "title": "Skill Code",
      "type": "string"
    },
    "skill_title": {
      "minLength": 1,
      "title": "Skill Title",
      "type": "string"
    }
  },
  "required": [
    "skill_title",
    "skill_code"
  ],
  "title": "LexiIdentifiedJobSkill",
  "type": "object"
}

LexiJobMissionInput (schemas)

{
  "additionalProperties": true,
  "description": "Validate and serialize Lexi job mission input data.",
  "properties": {
    "job_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Code"
    },
    "job_description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Description"
    },
    "job_family": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Family"
    },
    "job_title": {
      "minLength": 1,
      "title": "Job Title",
      "type": "string"
    },
    "missions": {
      "items": {
        "type": "string"
      },
      "title": "Missions",
      "type": "array"
    },
    "missions_text": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Missions Text"
    },
    "skills": {
      "items": {
        "$ref": "#/components/schemas/LexiJobSkill"
      },
      "title": "Skills",
      "type": "array"
    }
  },
  "required": [
    "job_title"
  ],
  "title": "LexiJobMissionInput",
  "type": "object"
}

Referenced definitions: components/schemas/LexiJobSkill.

LexiJobMissionSuggestionResult (schemas)

{
  "additionalProperties": true,
  "description": "Model Lexi job mission suggestion result state.",
  "properties": {
    "job_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Code"
    },
    "job_description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Description"
    },
    "job_family": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Family"
    },
    "job_title": {
      "minLength": 1,
      "title": "Job Title",
      "type": "string"
    },
    "missions": {
      "items": {
        "type": "string"
      },
      "title": "Missions",
      "type": "array"
    },
    "skills": {
      "items": {
        "$ref": "#/components/schemas/LexiJobSkill"
      },
      "title": "Skills",
      "type": "array"
    },
    "suggested_missions": {
      "items": {
        "type": "string"
      },
      "title": "Suggested Missions",
      "type": "array"
    }
  },
  "required": [
    "job_title",
    "suggested_missions"
  ],
  "title": "LexiJobMissionSuggestionResult",
  "type": "object"
}

Referenced definitions: components/schemas/LexiJobSkill.

LexiJobMissionSuggestionsRequest (schemas)

{
  "description": "Validate and serialize Lexi job mission suggestions request data.",
  "examples": [
    {
      "jobs": [
        {
          "job_code": "JOB-501",
          "job_family": "Data and analytics",
          "job_title": "Data analyst",
          "missions": [
            "Build monthly sales reports"
          ],
          "skills": [
            {
              "skill_title": "Data analysis"
            }
          ]
        }
      ],
      "missionsNumber": 6,
      "outputLanguage": "en"
    }
  ],
  "properties": {
    "clientContext": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Clientcontext"
    },
    "debug": {
      "default": false,
      "title": "Debug",
      "type": "boolean"
    },
    "jobs": {
      "items": {
        "$ref": "#/components/schemas/LexiJobMissionInput"
      },
      "minItems": 1,
      "title": "Jobs",
      "type": "array"
    },
    "missionsNumber": {
      "default": 6,
      "maximum": 8.0,
      "minimum": 1.0,
      "title": "Missionsnumber",
      "type": "integer"
    },
    "mode": {
      "default": "complete",
      "enum": [
        "complete",
        "extend"
      ],
      "title": "Mode",
      "type": "string"
    },
    "outputLanguage": {
      "default": "en",
      "minLength": 1,
      "title": "Outputlanguage",
      "type": "string"
    },
    "policy_version": {
      "anyOf": [
        {
          "const": "lexi-referential-v1",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Policy Version"
    }
  },
  "required": [
    "jobs"
  ],
  "title": "LexiJobMissionSuggestionsRequest",
  "type": "object"
}

Referenced definitions: components/schemas/LexiJobMissionInput.

LexiJobMissionSuggestionsResponse (schemas)

{
  "description": "Validate and serialize Lexi job mission suggestions response data.",
  "properties": {
    "jobs": {
      "items": {
        "$ref": "#/components/schemas/LexiJobMissionSuggestionResult"
      },
      "title": "Jobs",
      "type": "array"
    }
  },
  "required": [
    "jobs"
  ],
  "title": "LexiJobMissionSuggestionsResponse",
  "type": "object"
}

Referenced definitions: components/schemas/LexiJobMissionSuggestionResult.

LexiJobSkill (schemas)

{
  "additionalProperties": true,
  "description": "Validate and serialize Lexi job skill data.",
  "properties": {
    "skill_title": {
      "minLength": 1,
      "title": "Skill Title",
      "type": "string"
    }
  },
  "required": [
    "skill_title"
  ],
  "title": "LexiJobSkill",
  "type": "object"
}

LexiJobSkillLevelInput (schemas)

{
  "additionalProperties": true,
  "description": "Validate and serialize Lexi job skill level input data.",
  "properties": {
    "job_code": {
      "minLength": 1,
      "title": "Job Code",
      "type": "string"
    },
    "job_description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Description"
    },
    "job_title": {
      "minLength": 1,
      "title": "Job Title",
      "type": "string"
    },
    "skills": {
      "items": {
        "$ref": "#/components/schemas/LexiSkillLevelInput"
      },
      "minItems": 1,
      "title": "Skills",
      "type": "array"
    }
  },
  "required": [
    "job_code",
    "job_title",
    "skills"
  ],
  "title": "LexiJobSkillLevelInput",
  "type": "object"
}

Referenced definitions: components/schemas/LexiSkillLevelInput.

LexiJobSkillLevelsResult (schemas)

{
  "additionalProperties": true,
  "description": "Validate and serialize Lexi job skill levels result data.",
  "properties": {
    "job_code": {
      "title": "Job Code",
      "type": "string"
    },
    "job_title": {
      "title": "Job Title",
      "type": "string"
    },
    "skills": {
      "items": {
        "$ref": "#/components/schemas/LexiSkillLevelResult"
      },
      "title": "Skills",
      "type": "array"
    }
  },
  "required": [
    "job_code",
    "job_title",
    "skills"
  ],
  "title": "LexiJobSkillLevelsResult",
  "type": "object"
}

Referenced definitions: components/schemas/LexiSkillLevelResult.

LexiJobSkillSuggestionInput (schemas)

{
  "additionalProperties": true,
  "description": "Validate and serialize Lexi job skill suggestion input data.",
  "properties": {
    "job_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Code"
    },
    "job_description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Description"
    },
    "job_family": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Family"
    },
    "job_title": {
      "minLength": 1,
      "title": "Job Title",
      "type": "string"
    },
    "skills": {
      "items": {
        "$ref": "#/components/schemas/LexiJobSkill"
      },
      "title": "Skills",
      "type": "array"
    }
  },
  "required": [
    "job_title"
  ],
  "title": "LexiJobSkillSuggestionInput",
  "type": "object"
}

Referenced definitions: components/schemas/LexiJobSkill.

LexiJobSkillSuggestionResult (schemas)

{
  "additionalProperties": true,
  "description": "Model Lexi job skill suggestion result state.",
  "properties": {
    "job_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Code"
    },
    "job_description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Description"
    },
    "job_family": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Job Family"
    },
    "job_title": {
      "minLength": 1,
      "title": "Job Title",
      "type": "string"
    },
    "skills": {
      "items": {
        "$ref": "#/components/schemas/LexiJobSkill"
      },
      "title": "Skills",
      "type": "array"
    },
    "suggested_skills": {
      "items": {
        "type": "string"
      },
      "title": "Suggested Skills",
      "type": "array"
    }
  },
  "required": [
    "job_title",
    "suggested_skills"
  ],
  "title": "LexiJobSkillSuggestionResult",
  "type": "object"
}

Referenced definitions: components/schemas/LexiJobSkill.

LexiJobSkillSuggestionsRequest (schemas)

{
  "description": "Validate and serialize Lexi job skill suggestions request data.",
  "examples": [
    {
      "jobs": [
        {
          "job_code": "JOB-501",
          "job_family": "Data and analytics",
          "job_title": "Data analyst",
          "skills": [
            {
              "skill_title": "Data analysis"
            }
          ]
        }
      ],
      "outputLanguage": "en",
      "skillsNumber": 8,
      "theme": "Business intelligence"
    }
  ],
  "properties": {
    "clientContext": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Clientcontext"
    },
    "debug": {
      "default": false,
      "title": "Debug",
      "type": "boolean"
    },
    "jobs": {
      "items": {
        "$ref": "#/components/schemas/LexiJobSkillSuggestionInput"
      },
      "minItems": 1,
      "title": "Jobs",
      "type": "array"
    },
    "outputLanguage": {
      "default": "en",
      "minLength": 1,
      "title": "Outputlanguage",
      "type": "string"
    },
    "skillsNumber": {
      "default": 8,
      "maximum": 20.0,
      "minimum": 1.0,
      "title": "Skillsnumber",
      "type": "integer"
    },
    "theme": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Theme"
    }
  },
  "required": [
    "jobs"
  ],
  "title": "LexiJobSkillSuggestionsRequest",
  "type": "object"
}

Referenced definitions: components/schemas/LexiJobSkillSuggestionInput.

LexiJobSkillSuggestionsResponse (schemas)

{
  "description": "Validate and serialize Lexi job skill suggestions response data.",
  "properties": {
    "jobs": {
      "items": {
        "$ref": "#/components/schemas/LexiJobSkillSuggestionResult"
      },
      "title": "Jobs",
      "type": "array"
    }
  },
  "required": [
    "jobs"
  ],
  "title": "LexiJobSkillSuggestionsResponse",
  "type": "object"
}

Referenced definitions: components/schemas/LexiJobSkillSuggestionResult.

LexiJobToSkillsRequest (schemas)

{
  "description": "Validate and serialize Lexi job to skills request data.",
  "examples": [
    {
      "clientContext": "A technology company building business analytics products.",
      "organizationId": "4261260b-5d03-4e69-a47c-d66b6735e676",
      "outputLanguage": "en",
      "referentialHRX": "dd2d02b4-36f9-4d71-b33c-3b72b469607e",
      "repartitionTypeSkill": {
        "Hard": 70,
        "Soft": 30
      },
      "resultsNumber": 5,
      "searchQueries": [
        {
          "job_id": "e5262247-b76c-431c-9a98-65e12cc9d3e8",
          "role_description": "Analyze business data and communicate actionable findings.",
          "role_family": "Data and analytics",
          "role_name": "Data analyst"
        }
      ],
      "skillGroups": [
        "Technical",
        "Interpersonal"
      ],
      "skillsSource": "generated",
      "typeLLM": {
        "cleaning_phase": "openAI",
        "description_phase": "openAI",
        "generation_phase": "openAI"
      }
    }
  ],
  "properties": {
    "addSkillDescription": {
      "default": false,
      "title": "Addskilldescription",
      "type": "boolean"
    },
    "clientContext": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Clientcontext"
    },
    "crashStep": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Crashstep"
    },
    "debug": {
      "default": false,
      "title": "Debug",
      "type": "boolean"
    },
    "email": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": "",
      "title": "Email"
    },
    "generationMode": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": "",
      "title": "Generationmode"
    },
    "organizationId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Organizationid"
    },
    "outputLanguage": {
      "default": "en",
      "title": "Outputlanguage",
      "type": "string"
    },
    "policy_version": {
      "anyOf": [
        {
          "const": "lexi-referential-v1",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Policy Version"
    },
    "quality_context": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/AnalysisSnapshot"
        },
        {
          "type": "null"
        }
      ]
    },
    "quality_source": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/QualityReference"
        },
        {
          "type": "null"
        }
      ]
    },
    "referentialHRX": {
      "default": "",
      "title": "Referentialhrx",
      "type": "string"
    },
    "repartitionTypeSkill": {
      "title": "Repartitiontypeskill"
    },
    "resultsNumber": {
      "default": 5,
      "title": "Resultsnumber",
      "type": "integer"
    },
    "searchQueries": {
      "title": "Searchqueries"
    },
    "skillCatalog": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/CatalogReference"
        },
        {
          "type": "null"
        }
      ]
    },
    "skillFormat": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Skillformat"
    },
    "skillGroups": {
      "title": "Skillgroups"
    },
    "skillLevelScale": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Skilllevelscale"
    },
    "skill_group_types": {
      "additionalProperties": {
        "enum": [
          "hard",
          "soft"
        ],
        "type": "string"
      },
      "title": "Skill Group Types",
      "type": "object"
    },
    "skillsSource": {
      "default": "generated",
      "enum": [
        "generated",
        "provided"
      ],
      "title": "Skillssource",
      "type": "string"
    },
    "typeLLM": {
      "default": "openAI",
      "title": "Typellm"
    }
  },
  "title": "LexiJobToSkillsRequest",
  "type": "object"
}

Referenced definitions: components/schemas/AnalysisSnapshot, components/schemas/CatalogReference, components/schemas/QualityReference.

LexiSkillDescriptionResult (schemas)

{
  "additionalProperties": true,
  "description": "Model Lexi skill description result state.",
  "properties": {
    "skill_code": {
      "minLength": 1,
      "title": "Skill Code",
      "type": "string"
    },
    "skill_definition": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Skill Definition"
    },
    "skill_title": {
      "minLength": 1,
      "title": "Skill Title",
      "type": "string"
    }
  },
  "required": [
    "skill_title",
    "skill_code"
  ],
  "title": "LexiSkillDescriptionResult",
  "type": "object"
}

LexiSkillDescriptionsRequest (schemas)

{
  "description": "Validate and serialize Lexi skill descriptions request data.",
  "examples": [
    {
      "outputLanguage": "en",
      "skills": [
        {
          "skill_code": "SKILL-001",
          "skill_title": "Data analysis"
        }
      ],
      "typeLLM": "openAI"
    }
  ],
  "properties": {
    "debug": {
      "default": false,
      "title": "Debug",
      "type": "boolean"
    },
    "outputLanguage": {
      "default": "en",
      "minLength": 1,
      "title": "Outputlanguage",
      "type": "string"
    },
    "skills": {
      "items": {
        "$ref": "#/components/schemas/LexiIdentifiedJobSkill"
      },
      "minItems": 1,
      "title": "Skills",
      "type": "array"
    },
    "typeLLM": {
      "$ref": "#/components/schemas/LLMEnum",
      "default": "openAI"
    }
  },
  "required": [
    "skills"
  ],
  "title": "LexiSkillDescriptionsRequest",
  "type": "object"
}

Referenced definitions: components/schemas/LLMEnum, components/schemas/LexiIdentifiedJobSkill.

LexiSkillDescriptionsResponse (schemas)

{
  "description": "Validate and serialize Lexi skill descriptions response data.",
  "properties": {
    "skills": {
      "items": {
        "$ref": "#/components/schemas/LexiSkillDescriptionResult"
      },
      "title": "Skills",
      "type": "array"
    }
  },
  "required": [
    "skills"
  ],
  "title": "LexiSkillDescriptionsResponse",
  "type": "object"
}

Referenced definitions: components/schemas/LexiSkillDescriptionResult.

LexiSkillLevelDescriptionResult (schemas)

{
  "additionalProperties": true,
  "description": "Model generated descriptions for every level of one skill.",
  "properties": {
    "level_descriptions": {
      "additionalProperties": {
        "type": "string"
      },
      "title": "Level Descriptions",
      "type": "object"
    },
    "skill_code": {
      "minLength": 1,
      "title": "Skill Code",
      "type": "string"
    },
    "skill_definition": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Skill Definition"
    },
    "skill_title": {
      "minLength": 1,
      "title": "Skill Title",
      "type": "string"
    }
  },
  "required": [
    "skill_title",
    "skill_code",
    "level_descriptions"
  ],
  "title": "LexiSkillLevelDescriptionResult",
  "type": "object"
}

LexiSkillLevelDescriptionsRequest (schemas)

{
  "additionalProperties": false,
  "description": "Validate a request for contextual skill-level descriptions.",
  "examples": [
    {
      "clientContext": "A business analytics team.",
      "outputLanguage": "en",
      "skillLevelScale": 5,
      "skills": [
        {
          "skill_code": "SKILL-001",
          "skill_definition": "Analyze datasets to identify trends and support business decisions.",
          "skill_title": "Data analysis"
        }
      ]
    }
  ],
  "properties": {
    "clientContext": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Clientcontext"
    },
    "debug": {
      "default": false,
      "title": "Debug",
      "type": "boolean"
    },
    "outputLanguage": {
      "default": "en",
      "minLength": 1,
      "title": "Outputlanguage",
      "type": "string"
    },
    "skillLevelScale": {
      "enum": [
        4,
        5
      ],
      "title": "Skilllevelscale",
      "type": "integer"
    },
    "skills": {
      "items": {
        "$ref": "#/components/schemas/LexiSkillLevelInput"
      },
      "maxItems": 50,
      "minItems": 1,
      "title": "Skills",
      "type": "array"
    }
  },
  "required": [
    "skills",
    "skillLevelScale"
  ],
  "title": "LexiSkillLevelDescriptionsRequest",
  "type": "object"
}

Referenced definitions: components/schemas/LexiSkillLevelInput.

LexiSkillLevelDescriptionsResponse (schemas)

{
  "description": "Serialize contextual descriptions generated for skill levels.",
  "properties": {
    "skills": {
      "items": {
        "$ref": "#/components/schemas/LexiSkillLevelDescriptionResult"
      },
      "title": "Skills",
      "type": "array"
    }
  },
  "required": [
    "skills"
  ],
  "title": "LexiSkillLevelDescriptionsResponse",
  "type": "object"
}

Referenced definitions: components/schemas/LexiSkillLevelDescriptionResult.

LexiSkillLevelInput (schemas)

{
  "additionalProperties": true,
  "description": "Validate and serialize Lexi skill level input data.",
  "properties": {
    "skill_code": {
      "minLength": 1,
      "title": "Skill Code",
      "type": "string"
    },
    "skill_definition": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Skill Definition"
    },
    "skill_title": {
      "minLength": 1,
      "title": "Skill Title",
      "type": "string"
    }
  },
  "required": [
    "skill_title",
    "skill_code"
  ],
  "title": "LexiSkillLevelInput",
  "type": "object"
}

LexiSkillLevelResult (schemas)

{
  "additionalProperties": true,
  "description": "Model Lexi skill level result state.",
  "properties": {
    "required_skill_level": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Required Skill Level"
    },
    "skill_code": {
      "minLength": 1,
      "title": "Skill Code",
      "type": "string"
    },
    "skill_title": {
      "minLength": 1,
      "title": "Skill Title",
      "type": "string"
    }
  },
  "required": [
    "skill_title",
    "skill_code"
  ],
  "title": "LexiSkillLevelResult",
  "type": "object"
}

LexiSkillLevelsRequest (schemas)

{
  "description": "Validate and serialize Lexi skill levels request data.",
  "examples": [
    {
      "clientContext": "A business analytics team.",
      "jobs": [
        {
          "job_code": "JOB-501",
          "job_description": "Analyze business data and build reports.",
          "job_title": "Data analyst",
          "skills": [
            {
              "skill_code": "SKILL-001",
              "skill_definition": "Analyze datasets to identify trends and support business decisions.",
              "skill_title": "Data analysis"
            }
          ]
        }
      ],
      "skillLevelScale": 5
    }
  ],
  "properties": {
    "clientContext": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Clientcontext"
    },
    "debug": {
      "default": false,
      "title": "Debug",
      "type": "boolean"
    },
    "jobs": {
      "items": {
        "$ref": "#/components/schemas/LexiJobSkillLevelInput"
      },
      "minItems": 1,
      "title": "Jobs",
      "type": "array"
    },
    "skillLevelScale": {
      "enum": [
        4,
        5
      ],
      "title": "Skilllevelscale",
      "type": "integer"
    }
  },
  "required": [
    "jobs",
    "skillLevelScale"
  ],
  "title": "LexiSkillLevelsRequest",
  "type": "object"
}

Referenced definitions: components/schemas/LexiJobSkillLevelInput.

LexiSkillLevelsResponse (schemas)

{
  "description": "Validate and serialize Lexi skill levels response data.",
  "properties": {
    "jobs": {
      "items": {
        "$ref": "#/components/schemas/LexiJobSkillLevelsResult"
      },
      "title": "Jobs",
      "type": "array"
    }
  },
  "required": [
    "jobs"
  ],
  "title": "LexiSkillLevelsResponse",
  "type": "object"
}

Referenced definitions: components/schemas/LexiJobSkillLevelsResult.

NormalizeLabelsInput (schemas)

{
  "description": "Validate and serialize normalize labels input data.",
  "examples": [
    {
      "skillFormat": "noun-only",
      "skills": [
        "Data analysis",
        "Managing projects"
      ]
    }
  ],
  "properties": {
    "skillFormat": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Skillformat"
    },
    "skills": {
      "items": {
        "type": "string"
      },
      "title": "Skills",
      "type": "array"
    }
  },
  "required": [
    "skills"
  ],
  "title": "NormalizeLabelsInput",
  "type": "object"
}

QualityReference (schemas)

{
  "additionalProperties": false,
  "description": "No caller-controlled URL or storage path is accepted.",
  "properties": {
    "organization_id": {
      "format": "uuid",
      "title": "Organization Id",
      "type": "string"
    },
    "referential_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Referential Id"
    },
    "run_id": {
      "format": "uuid",
      "title": "Run Id",
      "type": "string"
    }
  },
  "required": [
    "organization_id",
    "referential_id",
    "run_id"
  ],
  "title": "QualityReference",
  "type": "object"
}

ReferentialAnalysisAccepted (schemas)

{
  "additionalProperties": false,
  "description": "The caller polls HRX for the result of a paginated analysis.",
  "properties": {
    "source": {
      "$ref": "#/components/schemas/QualityReference"
    },
    "status": {
      "const": "pending",
      "default": "pending",
      "title": "Status",
      "type": "string"
    }
  },
  "required": [
    "source"
  ],
  "title": "ReferentialAnalysisAccepted",
  "type": "object"
}

Referenced definitions: components/schemas/QualityReference.

ReferentialAnalysisRequest (schemas)

{
  "additionalProperties": false,
  "description": "Model ReferentialAnalysisRequest for the shared Lexi quality contract.",
  "examples": [
    {
      "checks": "deterministic",
      "jobs": [
        {
          "id": "job-example",
          "referential_id": "ref-example",
          "title": "Data analyst"
        }
      ],
      "policy_version": "lexi-referential-v1",
      "referential_id": "ref-example",
      "referentials": [
        {
          "id": "ref-example",
          "name": "Business jobs",
          "skills_per_job": 15
        }
      ],
      "requirements": [],
      "skills": []
    }
  ],
  "properties": {
    "checks": {
      "default": "deterministic",
      "enum": [
        "deterministic",
        "semantic"
      ],
      "title": "Checks",
      "type": "string"
    },
    "dgi_available": {
      "default": false,
      "title": "Dgi Available",
      "type": "boolean"
    },
    "dgi_ratio": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dgi Ratio"
    },
    "external_skills": {
      "items": {
        "$ref": "#/components/schemas/AnalysisSkill"
      },
      "title": "External Skills",
      "type": "array"
    },
    "jobs": {
      "items": {
        "$ref": "#/components/schemas/AnalysisJob"
      },
      "title": "Jobs",
      "type": "array"
    },
    "outside_skill_usage": {
      "additionalProperties": {
        "type": "integer"
      },
      "title": "Outside Skill Usage",
      "type": "object"
    },
    "policy_version": {
      "const": "lexi-referential-v1",
      "default": "lexi-referential-v1",
      "title": "Policy Version",
      "type": "string"
    },
    "population_job_count": {
      "anyOf": [
        {
          "minimum": 0.0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Population Job Count"
    },
    "referential_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Referential Id"
    },
    "referentials": {
      "items": {
        "$ref": "#/components/schemas/AnalysisReferential"
      },
      "title": "Referentials",
      "type": "array"
    },
    "requirements": {
      "items": {
        "$ref": "#/components/schemas/AnalysisRequirement"
      },
      "title": "Requirements",
      "type": "array"
    },
    "semantic_label_order": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "title": "Semantic Label Order",
      "type": "object"
    },
    "skills": {
      "items": {
        "$ref": "#/components/schemas/AnalysisSkill"
      },
      "title": "Skills",
      "type": "array"
    },
    "source": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/QualityReference"
        },
        {
          "type": "null"
        }
      ]
    },
    "suppressed_skill_pairs": {
      "items": {
        "maxItems": 2,
        "minItems": 2,
        "prefixItems": [
          {
            "type": "string"
          },
          {
            "type": "string"
          }
        ],
        "type": "array"
      },
      "title": "Suppressed Skill Pairs",
      "type": "array"
    },
    "validated_job_ids": {
      "items": {
        "type": "string"
      },
      "title": "Validated Job Ids",
      "type": "array"
    }
  },
  "title": "ReferentialAnalysisRequest",
  "type": "object"
}

Referenced definitions: components/schemas/AnalysisJob, components/schemas/AnalysisReferential, components/schemas/AnalysisRequirement, components/schemas/AnalysisSkill, components/schemas/QualityReference.

ReferentialAnalysisResponse (schemas)

{
  "additionalProperties": false,
  "description": "UI projections retain their established camelCase field names.",
  "examples": [
    {
      "checks": "semantic",
      "duplicates": {
        "jobs": [],
        "skills": []
      },
      "issues": [],
      "job_skills": {},
      "jobs": {},
      "policy": {},
      "policy_version": "lexi-referential-v1",
      "skills": {},
      "status": "complete",
      "unavailable_checks": []
    }
  ],
  "properties": {
    "checks": {
      "enum": [
        "deterministic",
        "semantic"
      ],
      "title": "Checks",
      "type": "string"
    },
    "duplicate_metrics": {
      "additionalProperties": {
        "type": "number"
      },
      "title": "Duplicate Metrics",
      "type": "object"
    },
    "duplicates": {
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "title": "Duplicates",
      "type": "object"
    },
    "issues": {
      "items": {
        "additionalProperties": {
          "$ref": "#/components/schemas/JsonValue"
        },
        "type": "object"
      },
      "title": "Issues",
      "type": "array"
    },
    "job_skills": {
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "title": "Job Skills",
      "type": "object"
    },
    "jobs": {
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "title": "Jobs",
      "type": "object"
    },
    "policy": {
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "title": "Policy",
      "type": "object"
    },
    "policy_version": {
      "const": "lexi-referential-v1",
      "default": "lexi-referential-v1",
      "title": "Policy Version",
      "type": "string"
    },
    "skills": {
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonValue"
      },
      "title": "Skills",
      "type": "object"
    },
    "status": {
      "default": "complete",
      "enum": [
        "complete",
        "partial"
      ],
      "title": "Status",
      "type": "string"
    },
    "unavailable_checks": {
      "items": {
        "type": "string"
      },
      "title": "Unavailable Checks",
      "type": "array"
    }
  },
  "required": [
    "checks"
  ],
  "title": "ReferentialAnalysisResponse",
  "type": "object"
}

Referenced definitions: components/schemas/JsonValue.

ValidationError (schemas)

{
  "properties": {
    "ctx": {
      "title": "Context",
      "type": "object"
    },
    "input": {
      "title": "Input"
    },
    "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"
}

APIKeyHeader (securitySchemes)

{
  "in": "header",
  "name": "X-API-Key",
  "type": "apiKey"
}

Client-ID (securitySchemes)

{
  "description": "Optional client identifier.",
  "in": "header",
  "name": "Client-ID",
  "type": "apiKey"
}

HTTPBearer (securitySchemes)

{
  "scheme": "bearer",
  "type": "http"
}

Functional guide.