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

# Ingest candidate profiles

> Ingest selected candidate profiles from a sourcing search into your Fribl workspace. Ingested profiles are processed and made available as candidates for matching against job descriptions. Billable — charges the `sourcing_ingest` action once per candidate in `selected_ids`; each is charged independently and failed imports are refunded. See `GET /tokens/costs` for live pricing.



## OpenAPI

````yaml /api-reference/openapi.json post /sourcing/ingest
openapi: 3.1.0
info:
  title: Fribl API
  description: >-
    The Fribl API enables intelligent talent matching powered by AI. Analyze CVs
    and job descriptions from text or file uploads, search and manage skills,
    match candidates to positions with configurable scoring weights, and source
    candidate profiles from external databases. All document processing is
    asynchronous — submit documents for analysis, poll for status, and retrieve
    structured results when ready.
  version: 1.0.0
  contact:
    name: Fribl Support
    url: https://fribl.co
servers:
  - url: https://api-service.fribl.co/api/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: CVs
    description: >-
      Upload, analyze, retrieve, update, and delete candidate CVs. CVs can be
      submitted as raw text or as PDF file uploads. Processing is asynchronous —
      use the status endpoint to track progress.
  - name: Jobs
    description: >-
      Upload, analyze, retrieve, update, and delete job descriptions. Jobs can
      be submitted as raw text or as PDF file uploads. Processing is
      asynchronous — use the status endpoint to track progress.
  - name: Matching
    description: >-
      Match analyzed CVs against job descriptions using AI-powered scoring.
      Configure weights across experience, hard skills, soft skills, and
      education dimensions to tailor match results to your hiring priorities.
  - name: Sourcing
    description: >-
      Search for candidate profiles from external sources, retrieve cached
      search results, and ingest selected profiles into your Fribl workspace for
      matching.
  - name: Skills
    description: >-
      Search the Fribl skills taxonomy and retrieve available languages for
      skill translation. These endpoints are publicly accessible and do not
      require authentication.
  - name: Tokens
    description: >-
      Inspect your workspace's usage-based token balance, review the ledger of
      every charge and refund, and read the live per-action price list. Billable
      endpoints deduct tokens and return 402 when the balance is insufficient.
      Tokens are purchased and managed in the Fribl Console
      (https://console.fribl.co).
paths:
  /sourcing/ingest:
    post:
      tags:
        - Sourcing
      summary: Ingest candidate profiles
      description: >-
        Ingest selected candidate profiles from a sourcing search into your
        Fribl workspace. Ingested profiles are processed and made available as
        candidates for matching against job descriptions. Billable — charges the
        `sourcing_ingest` action once per candidate in `selected_ids`; each is
        charged independently and failed imports are refunded. See `GET
        /tokens/costs` for live pricing.
      operationId: ingestCandidateProfiles
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SourcingIngestBody'
      responses:
        '200':
          description: Ingestion request accepted.
          content:
            application/json:
              schema:
                type: object
                properties:
                  task_ids:
                    type: array
                    items:
                      type: string
                    description: Identifiers for the ingestion tasks created.
                  status:
                    type: string
                    description: Status of the ingestion request.
                  message:
                    type: string
                    description: Human-readable status message.
                required:
                  - task_ids
                  - status
                  - message
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
components:
  schemas:
    SourcingIngestBody:
      type: object
      description: Request body for ingesting candidate profiles from a sourcing search.
      properties:
        session_id:
          type: string
          description: >-
            Session ID from the sourcing search containing the profiles to
            ingest.
        selected_ids:
          type: array
          items:
            type: string
          maxItems: 100
          description: List of candidate profile IDs to ingest. Maximum 100 per request.
      required:
        - session_id
        - selected_ids
    ErrorResponse:
      type: object
      description: Standard error response.
      properties:
        error:
          type: string
          description: Human-readable error message.
      required:
        - error
    InsufficientTokensError:
      type: object
      description: >-
        Returned with HTTP 402 when the workspace balance can't cover a billable
        request. No work is performed and nothing is charged.
      properties:
        code:
          type: string
          enum:
            - INSUFFICIENT_TOKENS
          description: Machine-readable error code. Switch on this rather than the message.
          example: INSUFFICIENT_TOKENS
        message:
          type: string
          example: 'Insufficient tokens: have 3, need 10'
        balance:
          type: integer
          description: Current workspace balance.
          example: 3
        required:
          type: integer
          description: Tokens required for this request (worst case for sourcing searches).
          example: 10
      required:
        - code
        - message
        - balance
        - required
  responses:
    BadRequest:
      description: The request was malformed or contained invalid parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: >-
        Authentication failed. Provide a valid API key in the `x-api-key`
        header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    PaymentRequired:
      description: >-
        The workspace has insufficient tokens for the requested operation.
        Nothing was charged.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InsufficientTokensError'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key in UUID format. Include this header with every authenticated
        request.

````