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

# Introduction

> Fribl API — AI-powered CV analysis, job parsing, and intelligent candidate matching

# Welcome to the Fribl API

The Fribl API provides programmatic access to AI-powered recruitment intelligence. Analyze CVs and job descriptions, match candidates to positions with configurable scoring, search a multilingual skills taxonomy, and source candidates from external databases.

<Card title="Fribl Console" icon="gauge-high" href="https://console.fribl.co" horizontal>
  Your account home. Sign in to **create API keys**, **buy and manage tokens**, and **administer your organization and team** at [console.fribl.co](https://console.fribl.co).
</Card>

## Core capabilities

<CardGroup cols={2}>
  <Card title="CV Analysis" icon="file-user">
    Extract structured data from CVs including personal information, work experience, education, and skills — via text input or file upload.
  </Card>

  <Card title="Job Analysis" icon="briefcase">
    Parse job descriptions to extract requirements, preferred qualifications, skills, and role information automatically.
  </Card>

  <Card title="Candidate Matching" icon="arrows-rotate">
    Match analyzed CVs against jobs with configurable weights across experience, skills, and education dimensions. Receive ranked results with detailed scoring explanations.
  </Card>

  <Card title="Skills Search" icon="lightbulb">
    Query the ESCO-based skills taxonomy with support for multiple languages and filtering by skill type.
  </Card>

  <Card title="Candidate Sourcing" icon="magnifying-glass">
    Search and discover candidate profiles from external databases, then ingest selected profiles into your workspace.
  </Card>

  <Card title="Full CRUD" icon="database">
    Create, read, update, and delete both CVs and jobs. List all resources with pagination support.
  </Card>

  <Card title="Usage & Tokens" icon="wallet">
    Track consumption with a usage-based token system. Check your balance, review a full usage ledger, and see live per-action pricing.
  </Card>
</CardGroup>

## How it works

The typical Fribl workflow follows three steps:

<Steps>
  <Step title="Analyze">
    Submit CVs and job descriptions for AI-powered analysis. The API processes them asynchronously and returns task IDs. You can submit multiple documents in a single request.
  </Step>

  <Step title="Poll for status">
    Check processing status using the status endpoints. Poll until each task reaches `COMPLETED`. While work is still active, the status endpoint returns `PENDING`. If you poll an unknown ID, the endpoint returns `NOT_FOUND` for that item.
  </Step>

  <Step title="Match">
    Once both CVs and jobs reach `COMPLETED` status, run a match request with your preferred scoring weights. Fribl returns ranked candidates with per-dimension score breakdowns and natural language explanations.
  </Step>
</Steps>

<Note>
  Analyzing, matching, and sourcing consume **tokens** from your workspace balance. You're only charged for work that completes — failed tasks are refunded automatically. See [Tokens & Billing](/tokens) for pricing and balance management.
</Note>

## Quick links

<CardGroup cols={2}>
  <Card title="Quickstart" icon="bolt" href="/quickstart">
    Make your first API call and match a candidate to a job.
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Set up API key authentication for your requests.
  </Card>

  <Card title="Tokens & Billing" icon="wallet" href="/tokens">
    Understand pricing, check your balance, and handle insufficient-token responses.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Browse all endpoints with interactive examples.
  </Card>

  <Card title="Supported Languages" icon="globe" href="/supported-languages">
    View all languages available for skill translation.
  </Card>
</CardGroup>