Skip to main content

​
Endpoint

POST /api/jobs
Creates a new job entry in your tracker. This endpoint is commonly used by the browser extension to capture job postings, but can also be used to programmatically add jobs from other sources.

​
Authentication

Requires a valid Bearer token in the Authorization header. 
Authorization: Bearer YOUR_API_TOKEN

​
Request Body

​
title
string
required
The job title or position name.Example: "Senior Software Engineer"
​
company
string
required
The company name offering the position.Example: "Acme Corp"
​
location
string
required
The job location. Can be a city, country, or “Remote”.Example: "San Francisco, CA" or "Remote"
​
description
string
required
The full job description. This is analyzed by AI for matching.Example: "We are seeking an experienced software engineer..."
​
sourceUrl
string
required
The URL where the job posting was found. Must be a valid URL.Example: "https://example.com/careers/software-engineer"
Jobs with duplicate source URLs will not be created again. The existing job ID will be returned instead.
​
jobType
string
The employment type. Defaults to "other" if not specified.Options: full_time, part_time, contract, intern, remote, freelance, otherExample: "full_time"
​
applicationUrl
string
The URL to apply for the job. If different from the source URL.Example: "https://example.com/apply/12345"
​
notes
string
Optional notes about the job posting.Example: "Requires 5+ years of Go experience"

​
Response

​
message
string
Success message confirming job creation.Value: "Job created successfully"
​
jobId
integer
The unique ID of the created job.Example: 42

​
Example Request

curl -X POST https://api.vegaai.com/api/jobs \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Senior Software Engineer",
    "company": "Acme Corp",
    "location": "San Francisco, CA",
    "description": "We are seeking an experienced software engineer to join our team. You will work on building scalable backend services using Go and cloud technologies.",
    "jobType": "full_time",
    "sourceUrl": "https://example.com/careers/senior-engineer",
    "applicationUrl": "https://example.com/apply/12345",
    "notes": "Great benefits package mentioned"
  }'

​
Example Response

{
  "message": "Job created successfully",
  "jobId": 42
}

​
Behavior Notes

Duplicate Detection: If a job with the same sourceUrl already exists in your tracker, the API returns the existing job’s ID with a success message. This does not count against your quota.
Quota Tracking: Only newly created jobs count toward your monthly job capture quota. You can check your remaining quota using the Get Quota Status endpoint.
AI Analysis: After creating a job, Vega AI automatically analyzes it against your profile to generate a match score. This happens asynchronously and may take a few seconds.

​
Source Code Reference

The implementation can be found in:

​
Next Steps

Check Your Quota

Monitor your remaining job captures

Jobs API Overview

Learn more about the Jobs API

Build docs developers (and LLMs) love

Get started for freeTalk to us