Software Documentation

https://jobops.dakheera47.com/docs/
Admin
This project provides comprehensive documentation for a software system, covering various features,...
Tokens:52,650
Snippets:761
Trust Score:4.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Build and Start JobOps Docker Compose Stack Locally

Source: https://jobops.dakheera47.com/docs/getting-started/self-hosting

Starts the JobOps stack locally, building the image from source. Use this if you need to make local modifications.

```bash
docker compose up -d --build
```

--------------------------------

### Start Gmail OAuth

Source: https://jobops.dakheera47.com/docs/next/workflows/post-application-workflow

Initiate the Gmail OAuth flow to connect your account. The accountKey parameter specifies which account to use.

```bash
curl "http://localhost:3001/api/post-application/providers/gmail/oauth/start?accountKey=default"

```

--------------------------------

### Example Extractor Manifest

Source: https://jobops.dakheera47.com/docs/next/workflows/add-an-extractor

This is an example of an extractor manifest file. It defines the extractor's ID, display name, required environment variables, and the run function that generates job data.

```typescript
import type { ExtractorManifest } from "@shared/types/extractors";  
  
export const manifest: ExtractorManifest = {  
  id: "myextractor",  
  displayName: "My Extractor",  
  providesSources: ["myextractor"],  
  requiredEnvVars: ["MYEXTRACTOR_API_KEY"],  
  async run(context) {  
    // context.searchTerms, context.settings, context.onProgress, context.shouldCancel  
    const jobs = [];  
    return { success: true, jobs };  
  },  
};  
  
export default manifest;  


```

--------------------------------

### Start Gmail OAuth Flow

Source: https://jobops.dakheera47.com/docs/next/features/post-application-tracking

Initiates the OAuth 2.0 flow for connecting a Gmail account.

```APIDOC
## GET /api/post-application/providers/gmail/oauth/start

### Description
Starts the OAuth flow for Gmail integration.

### Method
GET

### Endpoint
/api/post-application/providers/gmail/oauth/start
```

--------------------------------

### Start JobOps Docker Compose Stack

Source: https://jobops.dakheera47.com/docs/getting-started/self-hosting

Starts the JobOps API, UI, and scrapers in detached mode. This command pulls the pre-built image from GHCR.

```bash
docker compose up -d
```

--------------------------------

### Set API Token in .env

Source: https://jobops.dakheera47.com/docs/next/extractors/seek

Add your Apify API token to the .env file to enable the Seek source in your pipeline. This is a required setup step.

```bash
APIFY_TOKEN=apify_api_xxxxxxxxxxxx  

```

--------------------------------

### Run Hiring Cafe Extractor Locally

Source: https://jobops.dakheera47.com/docs/extractors/hiring-cafe

Example of how to run the Hiring Cafe extractor locally using npm. It sets environment variables for search terms, country, and the maximum number of jobs per term.

```bash
HIRING_CAFE_SEARCH_TERMS='["backend engineer"]' \
HIRING_CAFE_COUNTRY='united kingdom' \
HIRING_CAFE_MAX_JOBS_PER_TERM='50' \
npm --workspace hiringcafe-extractor run start  

```

--------------------------------

### Start Gmail OAuth

Source: https://jobops.dakheera47.com/docs/next/workflows/post-application-workflow

Initiates the OAuth flow for connecting a Gmail account to JobOps for email syncing.

```APIDOC
## GET /api/post-application/providers/gmail/oauth/start

### Description
Starts the OAuth 2.0 authorization process for Gmail integration.

### Method
GET

### Endpoint
/api/post-application/providers/gmail/oauth/start

### Parameters
#### Query Parameters
- **accountKey** (string) - Required - Identifies the account for which to start the OAuth flow (e.g., "default").

### Request Example
(No explicit request body or parameters shown in example, only URL)

### Response
#### Success Response (200)
(No specific response body documented in source)

#### Response Example
(No example provided in source)
```

--------------------------------

### Restore Database from Backup File

Source: https://jobops.dakheera47.com/docs/getting-started/database-backups

Illustrates the manual process of restoring the JobOps database by stopping the application, replacing the main database file with a backup, and restarting the application. Adjust paths according to your system setup.

```shell
# Example only: adjust paths for your setup
cp /path/to/data/jobs_manual_2026_02_15_10_20_30.db /path/to/data/jobs.db
```

--------------------------------

### Start OAuth flow

Source: https://jobops.dakheera47.com/docs/features/post-application-tracking

Initiates the OAuth 2.0 flow for connecting a Gmail account. This endpoint redirects the user to Google's authorization server.

```APIDOC
## GET /api/post-application/providers/gmail/oauth/start

### Description
Start the OAuth flow for Gmail integration.

### Method
GET

### Endpoint
/api/post-application/providers/gmail/oauth/start
```

--------------------------------

### Example Search Terms for Jobindex

Source: https://jobops.dakheera47.com/docs/extractors/jobindex

Provide search terms in the 'Run jobs' interface to find relevant software engineering roles on Jobindex.

```text
software engineer
platform engineer
backend developer

```

--------------------------------

### Get Effective Settings

Source: https://jobops.dakheera47.com/docs/next/features/settings

Retrieves the current effective settings, combining defaults and overrides. Use this to inspect the active configuration.

```shell
# Get effective settings (defaults + overrides)  
curl "http://localhost:3001/api/settings"  

```

--------------------------------

### Example Visa Sponsor Provider Manifest

Source: https://jobops.dakheera47.com/docs/next/workflows/add-a-visa-sponsor-provider

Defines a manifest for a visa sponsor provider, including its ID, display name, country key, and fetch function. Ensure the `fetchSponsors` function returns an array of `VisaSponsor` objects or throws on failure.

```typescript
import type {  
  VisaSponsor,  
  VisaSponsorProviderManifest,  
} from "../../shared/src/types/visa-sponsors";  
  
export const manifest: VisaSponsorProviderManifest = {  
  id: "au",  
  displayName: "Australia",  
  countryKey: "australia",  
  scheduledUpdateHour: 3,  
  
  async fetchSponsors(): Promise<VisaSponsor[]> {  
    // Fetch and parse the upstream register here.  
    // Return an array of VisaSponsor objects.  
    // Throw on failure — the service layer handles error state.  
    return [];  
  },  
};  
  
export default manifest;  


```

--------------------------------

### Get Effective Settings

Source: https://jobops.dakheera47.com/docs/features/reactive-resume

Retrieves the current effective settings, including resolved resume projects and the base resume ID.

```APIDOC
## Get Effective Settings

### Description
Retrieves the current effective settings, including resolved resume projects and the base resume ID.

### Method
GET

### Endpoint
/api/settings

### Request Example
```bash
curl "http://localhost:3001/api/settings"
```

### Response
#### Success Response (200)
- **rxresumeBaseResumeId** (string) - The ID of the base resume from Reactive Resume.
- **resumeProjects** (object) - Controls for resume projects.
  - **maxProjects** (integer) - The maximum number of projects to include.
  - **lockedProjectIds** (array) - A list of project IDs that are locked.
  - **aiSelectableProjectIds** (array) - A list of project IDs that can be selected by AI.
```

--------------------------------

### Get Effective Settings

Source: https://jobops.dakheera47.com/docs/next/features/reactive-resume

Retrieve the current effective settings, including resolved resume projects and the base resume ID. This is useful for understanding the current configuration state.

```bash
# Get effective settings (includes resolved resumeProjects and base resume id)  
curl "http://localhost:3001/api/settings"
```

--------------------------------

### Example Catalog Update for Visa Sponsor Providers

Source: https://jobops.dakheera47.com/docs/next/workflows/add-a-visa-sponsor-provider

Updates the shared catalog by adding a new provider ID to `VISA_SPONSOR_PROVIDER_IDS` and its metadata to `VISA_SPONSOR_PROVIDER_METADATA`. This ensures the provider is recognized at runtime.

```typescript
export const VISA_SPONSOR_PROVIDER_IDS = ["uk", "au"] as const;  
  
export const VISA_SPONSOR_PROVIDER_METADATA = {  
  uk: { label: "United Kingdom", countryKey: "united kingdom" },  
  au: { label: "Australia", countryKey: "australia" },  
};  


```

--------------------------------

### Build Docs Site

Source: https://jobops.dakheera47.com/docs/next/troubleshooting/common-problems

Run this command to build the documentation site. Ensure the docs build artifact is included in production deployments.

```bash
npm --workspace docs-site run build
```

--------------------------------

### Configure Self-hosted Reactive Resume

Source: https://jobops.dakheera47.com/docs/next/getting-started/self-hosting

Set these environment variables if you are self-hosting Reactive Resume and want to integrate it with JobOps.

```bash
RXRESUME_URL=http://rxresume.local.net
RXRESUME_API_KEY=... (or configure rxresumeApiKey in JobOps Settings)
```

--------------------------------

### Get Job Chat Messages

Source: https://jobops.dakheera47.com/docs/features/ghostwriter

Retrieves the chat messages for a specific job.

```APIDOC
## GET /api/jobs/:id/chat/messages

### Description
Retrieves the chat messages for a specific job.

### Method
GET

### Endpoint
/api/jobs/:id/chat/messages

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the job.

### Response
#### Success Response (200)
- **messages** (array) - A list of chat messages.
- **runId** (string) - The ID of the current chat run.
- **assistantMessageId** (string) - The ID of the assistant's last message.
```

--------------------------------

### Get effective settings

Source: https://jobops.dakheera47.com/docs/next/features/settings

Retrieves the current effective settings, including defaults and any applied overrides.

```APIDOC
## GET /api/settings

### Description
Retrieves the current effective settings (defaults + overrides).

### Method
GET

### Endpoint
/api/settings

### Response
#### Success Response (200)
- **settings** (object) - The current settings configuration.
```

--------------------------------

### List Available Reactive Resume Resumes

Source: https://jobops.dakheera47.com/docs/next/features/reactive-resume

Fetch a list of all available resumes from your Reactive Resume instance. This is helpful for populating dropdowns or selection interfaces.

```bash
# List available Reactive Resume resumes  
curl "http://localhost:3001/api/settings/rx-resumes"
```

--------------------------------

### Get one organization's entries

Source: https://jobops.dakheera47.com/docs/features/visa-sponsors

Retrieves all licensed routes and details for a specific organization.

```APIDOC
## GET /api/visa-sponsors/organization/{companyName}

### Description
Retrieves all licensed routes and details for a specific organization.

### Method
GET

### Endpoint
/api/visa-sponsors/organization/{companyName}

### Parameters
#### Path Parameters
- **companyName** (string) - Required - The name of the organization to retrieve details for. URL-encoded.

### Response
#### Success Response (200)
- **company** (string) - The name of the company.
- **location** (string) - The location of the company (if available).
- **routes** (array) - A list of licensed routes for the company.
  - **type** (string) - The type of license.
  - **rating** (string) - The rating of the license.
- **lastRefresh** (string) - The timestamp of the last refresh for the provider.
- **provider** (string) - The name of the provider.

#### Response Example
{
  "company": "Monzo Bank Ltd",
  "location": "United Kingdom",
  "routes": [
    {
      "type": "Skilled Worker",
      "rating": "A"
    }
  ],
  "lastRefresh": "2023-10-27T02:00:00Z",
  "provider": "uk"
}
```

--------------------------------

### List and Create Backups

Source: https://jobops.dakheera47.com/docs/features/settings

Manages backups by listing existing backups and creating new ones on demand. This functionality is restricted to system administrators.

```curl
# List and create backups (used by the Backup section)  
curl "http://localhost:3001/api/backups"  
curl -X POST "http://localhost:3001/api/backups"  
```

--------------------------------

### Create Manual Backup

Source: https://jobops.dakheera47.com/docs/getting-started/database-backups

Triggers the creation of a manual database backup.

```APIDOC
## POST /api/backups

### Description
Creates a manual database backup. If a filename collision occurs, JobOps appends `_1`, `_2`, etc. to the filename.

### Method
POST

### Endpoint
/api/backups

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X POST "http://localhost:3001/api/backups"
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the backup was created.

#### Response Example
```json
{
  "message": "Manual backup created successfully."
}
```
```

--------------------------------

### Get status of all registered providers

Source: https://jobops.dakheera47.com/docs/features/visa-sponsors

Retrieves the current status and refresh information for all registered visa sponsor providers.

```APIDOC
## GET /api/visa-sponsors/status

### Description
Retrieves the current status and refresh information for all registered visa sponsor providers.

### Method
GET

### Endpoint
/api/visa-sponsors/status

### Response
#### Success Response (200)
- **providers** (object) - An object where keys are provider IDs and values contain status information.
  - **providerId** (string) - The ID of the provider.
  - **lastRefresh** (string) - The timestamp of the last successful refresh.
  - **sponsorCount** (integer) - The number of sponsors registered with this provider.
  - **error** (string) - Any error message if the last refresh failed.

#### Response Example
{
  "providers": {
    "uk": {
      "providerId": "uk",
      "lastRefresh": "2023-10-27T02:00:00Z",
      "sponsorCount": 5000,
      "error": null
    },
    "us": {
      "providerId": "us",
      "lastRefresh": "2023-10-26T02:00:00Z",
      "sponsorCount": 12000,
      "error": "Failed to connect to upstream source."
    }
  }
}
```

--------------------------------

### Manage Backups

Source: https://jobops.dakheera47.com/docs/next/features/settings

Lists existing backups and creates a new one. This API is used for managing data backups within the system.

```shell
# List and create backups (used by the Backup section)  
curl "http://localhost:3001/api/backups"  
curl -X POST "http://localhost:3001/api/backups"  

```

--------------------------------

### Get Effective Settings

Source: https://jobops.dakheera47.com/docs/features/settings

Retrieves the current effective settings, combining defaults and overrides. Use this to inspect the active configuration.

```curl
# Get effective settings (defaults + overrides)  
curl "http://localhost:3001/api/settings"  
```

--------------------------------

### List Available Reactive Resume Resumes

Source: https://jobops.dakheera47.com/docs/features/reactive-resume

Retrieves a list of all available resumes from the configured Reactive Resume instance.

```APIDOC
## List Available Reactive Resume Resumes

### Description
Retrieves a list of all available resumes from the configured Reactive Resume instance.

### Method
GET

### Endpoint
/api/settings/rx-resumes

### Response
#### Success Response (200)
- **resumes** (array) - A list of available resumes, where each item contains resume details like ID and name.
```

--------------------------------

### Configure GitHub Token for Local Builds

Source: https://jobops.dakheera47.com/docs/getting-started/self-hosting

Sets a GITHUB_TOKEN environment variable for local builds to bypass potential GitHub rate limits during Camoufox download. The token is passed as a BuildKit secret and not stored in the runtime container.

```bash
echo "GITHUB_TOKEN=ghp_your_token_here" >> .env
docker compose up -d --build
```

--------------------------------

### Jobindex Search Terms Example

Source: https://jobops.dakheera47.com/docs/next/extractors/jobindex

Enter search terms such as 'software engineer', 'platform engineer', or 'backend developer' when configuring the Jobindex extractor.

```plaintext
software engineer  
platform engineer  
backend developer  

```

--------------------------------

### Get Organization Sponsor Entries

Source: https://jobops.dakheera47.com/docs/features/visa-sponsors

Retrieve all licensed routes for a specific organization. This is useful for viewing detailed sponsorship information for a known company.

```curl
curl "http://localhost:3001/api/visa-sponsors/organization/Monzo%20Bank%20Ltd"
```

--------------------------------

### Smart Router Flowchart

Source: https://jobops.dakheera47.com/docs/features/post-application-tracking

Illustrates the decision-making process of the Smart Router AI in analyzing recruitment emails and determining the appropriate action based on match confidence.

```mermaid
flowchart TD  
A[Recruitment email arrives in Gmail] --> B[Smart Router AI analyzes content]  
B --> C{How confident is the match?}  

C -->|95-100%| D[Auto-linked to job]  
D --> E[Timeline updated automatically]  

C -->|50-94%| F[Goes to Inbox for review with suggested match]  

C -->|<50%| G{Is it relevant?}  
G -->|Yes| H[Goes to Inbox as orphan]  
G -->|No| I[Ignored]  

```

--------------------------------

### Get one organization's entries

Source: https://jobops.dakheera47.com/docs/next/features/visa-sponsors

Retrieves all licensed route details for a specific organization. Requires the organization's name as a URL-encoded parameter.

```APIDOC
## GET /api/visa-sponsors/organization/{organizationName}

### Description
Retrieves all licensed route details for a specific organization. Requires the organization's name as a URL-encoded parameter.

### Method
GET

### Endpoint
/api/visa-sponsors/organization/{organizationName}

### Parameters
#### Path Parameters
- **organizationName** (string) - Required - The URL-encoded name of the organization to retrieve details for.

### Response
#### Success Response (200)
- **company** (string) - The name of the organization.
- **location** (string) - The location of the organization (if available).
- **routes** (array) - Details of all licensed routes and type/rating for the organization.
  - **type** (string) - The type of license route.
  - **rating** (string) - The rating for the license route.
- **lastRefresh** (string) - The last refresh time for the provider.
- **sponsorCount** (integer) - The total number of sponsors for the provider.

#### Response Example
{
  "company": "Monzo Bank Ltd",
  "location": "United Kingdom",
  "routes": [
    {
      "type": "Skilled Worker",
      "rating": "A"
    },
    {
      "type": "Health and Care Worker",
      "rating": "A"
    }
  ],
  "lastRefresh": "2023-10-27T02:00:00Z",
  "sponsorCount": 5000
}
```

--------------------------------

### Fetch Projects from a Reactive Resume

Source: https://jobops.dakheera47.com/docs/features/reactive-resume

Fetches the projects associated with a specific resume from Reactive Resume.

```APIDOC
## Fetch Projects from a Reactive Resume

### Description
Fetches the projects associated with a specific resume from Reactive Resume.

### Method
GET

### Endpoint
/api/settings/rx-resumes/<resumeId>/projects

### Parameters
#### Path Parameters
- **resumeId** (string) - Required - The ID of the resume to fetch projects from.
```

--------------------------------

### Get Effective Settings API

Source: https://jobops.dakheera47.com/docs/features/reactive-resume

Use this curl command to retrieve the effective settings, including resolved resume projects and the base resume ID.

```bash
# Get effective settings (includes resolved resumeProjects and base resume id)  
curl "http://localhost:3001/api/settings"  
```
Tokens:
Raw