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

# Match text to skills

> Turn free text into official skills; `suggestion` is `auto` (use it), `confirm` (ask the recruiter) or `none`.

**Scope:** `skills:read` · **Idempotency-Key:** optional



## OpenAPI

````yaml /blue-collar-api/api-reference/openapi.json post /skills/match
openapi: 3.1.0
info:
  title: Record Blue Collar API
  version: 1.0.0
  description: >-
    Run Record candidate verification from your own system. You need two things:
    your **key id** and your **secret**. Everything else is generated. See
    Authentication for how.
servers:
  - url: https://api-bc.userecord.io/api/v1/partner
    description: Blue Collar API
security: []
tags:
  - name: Skills
    description: The skill taxonomy, read live a page at a time
  - name: Skill requests
    description: Ask Record to add a missing skill
  - name: Lookups
    description: >-
      Lookups for filling in a job mandate: places in India, the countries an
      abroad job can be in, and the employment types and shifts the playground
      offers
  - name: Workflows
    description: >-
      Your organisation's blue-collar workflows (read all; change and
      soft-delete only the ones you created)
  - name: Job mandates
    description: >-
      Your organisation's job mandates, addressed by Record's mandate_id (read
      all; change only the ones you created)
  - name: Campaigns
    description: Contact candidates for one of your jobs and verify them. Spends credits
  - name: Results
    description: >-
      What Record collected from each candidate: status (pending, completed,
      declined, failed) and an output of answers and verdicts
  - name: Events
    description: >-
      Pull your result events and acknowledge them: the safety net behind the
      webhook, and a way to receive results without exposing a URL
  - name: Webhooks
    description: >-
      Endpoints that Record POSTs result events to: signed, retried until you
      acknowledge, replayable
  - name: Analytics
    description: >-
      The workflow Overview analytics of the Record playground: funnel,
      channels, follow-ups, calls, drop-offs, languages (read-only, scope
      analytics:read)
paths:
  /skills/match:
    post:
      tags:
        - Skills
      summary: Match text to skills
      description: >-
        Turn free text into official skills; `suggestion` is `auto` (use it),
        `confirm` (ask the recruiter) or `none`.


        **Scope:** `skills:read` · **Idempotency-Key:** optional
      operationId: matchSkills
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
            maxLength: 255
          description: >-
            Optional. A retry with the same key returns the first answer (kept
            24 h). Leave empty in Try it: a new one is made for every call.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                texts:
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 200
                  minItems: 1
                  maxItems: 20
                collar:
                  type: string
                  enum:
                    - blue
                    - grey
                    - white
                top_k:
                  type: integer
                  minimum: 1
                  maximum: 3
                  default: 3
              required:
                - texts
              additionalProperties: false
            example:
              texts:
                - Forklift Basic Operation
                - warehouse picking
                - reach truck driver
              top_k: 2
      responses:
        '200':
          description: One result per text, in the order sent
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    const: true
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            text:
                              type: string
                            suggestion:
                              type: string
                              enum:
                                - auto
                                - confirm
                                - none
                            matches:
                              type: array
                              items:
                                type: object
                                properties:
                                  skill:
                                    type: object
                                    properties:
                                      skill_id:
                                        type: string
                                        description: Stable taxonomy id, e.g. sk_27338
                                      name:
                                        type: string
                                      sub_domain:
                                        type: object
                                        properties:
                                          id:
                                            type: string
                                          name:
                                            type: string
                                      domain:
                                        type: object
                                        properties:
                                          id:
                                            type: string
                                          name:
                                            type: string
                                      collar:
                                        type: string
                                        enum:
                                          - blue
                                          - grey
                                          - white
                                      verifiable:
                                        type: boolean
                                        description: >-
                                          Whether Record can generate
                                          skill-verification questions for it
                                  confidence:
                                    type: number
                                    minimum: 0
                                    maximum: 1
              example:
                success: true
                data:
                  items:
                    - text: Forklift Basic Operation
                      suggestion: auto
                      matches:
                        - skill:
                            skill_id: sk_36440
                            name: Forklift Basic Operation
                            sub_domain:
                              id: >-
                                sub_architecture_and_construction__heavy_equipment_operation
                              name: Heavy Equipment Operation
                            domain:
                              id: dom_architecture_and_construction
                              name: Architecture and Construction
                            collar: blue
                            verifiable: true
                          confidence: 1
                    - text: warehouse picking
                      suggestion: confirm
                      matches:
                        - skill:
                            skill_id: sk_2381
                            name: Warehousing
                            sub_domain:
                              id: >-
                                sub_logistics_and_mobility_management__inventory_and_warehousing
                              name: Inventory and Warehousing
                            domain:
                              id: dom_logistics_and_mobility_management
                              name: Logistics & Mobility Management
                            collar: white
                            verifiable: true
                          confidence: 0.72
                    - text: reach truck driver
                      suggestion: none
                      matches: []
        '400':
          description: '`VALIDATION_FAILED`: Send 1–20 texts; `top_k` 1–3.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: '`DAILY_CAP`: 50,000 matches already used today.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKey: []
          SecretKey: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            pcall POST "/api/v1/partner/skills/match" '{
              "texts": [
                "Forklift Basic Operation",
                "warehouse picking",
                "reach truck driver"
              ],
              "top_k": 2
            }'
        - lang: javascript
          label: JavaScript
          source: |-
            const res = await call("POST", "/api/v1/partner/skills/match", {
              "texts": [
                "Forklift Basic Operation",
                "warehouse picking",
                "reach truck driver"
              ],
              "top_k": 2
            });
            const { data } = await res.json();
        - lang: python
          label: Python
          source: |-
            res = call("POST", "/api/v1/partner/skills/match", {
                "texts": [
                    "Forklift Basic Operation",
                    "warehouse picking",
                    "reach truck driver"
                ],
                "top_k": 2
            })
            data = res.json()["data"]
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          const: false
          type: boolean
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - VALIDATION_FAILED
                - LIMIT_EXCEEDED
                - UNAUTHORIZED
                - SCOPE_MISSING
                - FORBIDDEN
                - HTTPS_REQUIRED
                - NOT_FOUND
                - CONFLICT
                - WORKFLOW_IN_USE
                - INSUFFICIENT_CREDITS
                - IDEMPOTENCY_KEY_REQUIRED
                - IDEMPOTENCY_KEY_REUSED
                - IDEMPOTENCY_IN_PROGRESS
                - PAYLOAD_TOO_LARGE
                - UNSUPPORTED_MEDIA_TYPE
                - RATE_LIMITED
                - COOLDOWN
                - DAILY_CAP
                - SERVICE_DISABLED
                - SERVER_ERROR
            message:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  path:
                    type: string
                  message:
                    type: string
            request_id:
              type: string
              description: Quote it to Record support
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your key id, `VFN_TEST_…` or `VFN_LIVE_…`. Sent on every request.
    SecretKey:
      type: apiKey
      in: header
      name: x-secret-key
      description: >-
        Your secret, `VFN_SK_…`. **Not a real header, and never sent to the
        API.** It is only a form field for Try it, which uses it to sign your
        request in your browser. In your own code you sign each request with the
        secret and send `x-api-key`, `x-timestamp` and `x-signature` (see
        Authentication).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.