Developer Portal

API Reference

Base URL: https://employeeforge.com/api/public/v1

Website Audits

Queue website audits and read the resulting scores.

POST/auditsrequires write scope

Queue a new website audit

Parameters

Name	In	Type	Description
url*	body	string (url)	Website URL to audit
label	body	string	Friendly label (max 200 chars)

Request body

{ "url": "https://example.com", "label": "Marketing site" }

Example response

{ "target": { "id": "…", "url": "https://example.com", "next_scan_at": "2026-07-26T…" }, "message": "Audit queued for scanning" }

GET/auditsrequires read scope

List recent audit scans for your workspace

Parameters

Name	In	Type	Description
limit	query	number (1–200)	How many to return (default 50)

Example response

{ "scans": [ { "id": "…", "scores": { "seo": 82, "performance": 91 }, "created_at": "…" } ] }

Read the employee roster and their capabilities.

GET/employeesrequires read scope

List all AI employees available in your workspace

Example response

{ "employees": [ { "key": "seo_writer", "name": "SEO Writer", "department": "growth" } ] }

Read and create job postings the AI recruiter can act on.

GET/jobsrequires read scope

List job postings

Example response

{ "jobs": [ { "id": "…", "title": "Sales Engineer", "status": "open" } ] }

POST/jobsrequires write scope

Create a new job posting

Parameters

Name	In	Type	Description
title*	body	string	Job title
description	body	string	Full description

Request body

{ "title": "Sales Engineer", "description": "…" }

Example response

{ "job": { "id": "…", "title": "Sales Engineer", "status": "open" } }

Read candidates and their scored resumes.

GET/candidatesrequires read scope

List candidates in your pipeline

Example response

{ "candidates": [ { "id": "…", "name": "Jane Doe", "score": 87 } ] }

Get AI-generated resume fit scores.

GET/resume-scoresrequires read scope

List resume scoring results

Example response

{ "scores": [ { "candidate_id": "…", "score": 87, "reasoning": "…" } ] }