Coding agent documentation index Fetch the complete documentation index at: https://docs.worklittle.com/docs-agent-manifest.json Use this file to discover all available pages before exploring further.

CLI

worklittle command-line client. JSON on stdout.

Install

Requires Node 18+ (Homebrew installs it for you).

| Method | Command |
| --- | --- |
| Homebrew (recommended) | `brew install worklittle/tap/worklittle` |
| npm | `npm install -g worklittle` |
| curl (macOS, Linux) | `curl -fsSL https://worklittle.com/install \| bash` |

The curl script verifies the checksum in manifest.json and installs to ~/.local/bin/worklittle. Set WORKLITTLE_INSTALL_PREFIX to change the prefix.

Check the install:

worklittle help

Authentication

Send your key as a bearer token. Create one under API keys in Worklittle Business.

Authorization: Bearer sk-wl-api01-...

The SDKs and CLI read WORKLITTLE_API_KEY. Prefer the env var over --api-key, which is visible in process lists.

Public job board reads and public survey submit need no key.

Usage

worklittle <group> <action> [ID...] [--flag value] [--body '{}'] [--pretty]

Flags take a space-separated value. --flag=value is not supported by this CLI.

| Flag | Effect |
| --- | --- |
| `--pretty` | Indented JSON. Default is compact (`--json` forces compact) |
| `--body` | JSON string request body |
| `--api-key` | Overrides `WORKLITTLE_API_KEY` |
| `--base-url` | Overrides `https://api.worklittle.com`. Your key is sent here, so only use hosts you trust |
| `--id` | Same as the positional ID. Also sent as a query parameter |
| any other `--name value` | Sent as a query parameter |

jobs search accepts every GET /jobs filter by name, for example --workplace_type, --posted_within_days, --near_lat. Prefix a --company, --title, or --q value with - to exclude it.

| Exit code | Meaning |
| --- | --- |
| 0 | Success |
| 1 | Any other error |
| 2 | 401 or 403 |
| 3 | 402. Do not retry until billing is fixed |

Errors are JSON on stderr.

Example

worklittle jobs search --q "software engineer" --limit 1 --pretty
worklittle jobs search --title "software engineer, -senior" --company "-lucid-motors,-tesla" --limit 5 --pretty
worklittle jobs get JOB_ID --pretty

{
  "data": [
    {
      "job_id": "...",
      "title": "Software Engineer",
      "company_name": "Example Co",
      "location": "San Francisco, CA"
    }
  ],
  "meta": { "limit": 1, "next_cursor": "..." }
}

Board > apply

worklittle boards get YOUR_ORG_SLUG --include facets --pretty
worklittle boards job YOUR_ORG_SLUG JOB_SLUG_OR_ID --pretty
worklittle boards apply YOUR_ORG_SLUG JOB_SLUG_OR_ID --body '{
  "name": "Alex Rivera",
  "email": "alex@example.com",
  "answers": {}
}'

See Embedded job board.

Candidates

worklittle candidates list --limit 10 --pretty
worklittle candidates get CANDIDATE_ID --pretty

Requires the jobs:applications scope. See Manage candidates.

Commands

Jobs

API reference

worklittle jobs search --q "product designer" --workplace_type remote --limit 10
worklittle jobs get JOB_ID
worklittle jobs map
worklittle jobs salary-average

Companies

API reference

worklittle companies search --q stripe

Market stats

API reference

worklittle stats get

Public job board

API reference

worklittle boards list COMPANY
worklittle boards profile COMPANY
worklittle boards jobs COMPANY
worklittle boards job COMPANY JOB_ID
worklittle boards facets COMPANY
worklittle boards parse-resume COMPANY JOB_ID --body '{}'
worklittle boards apply COMPANY JOB_ID --body '{}'

Apply

API reference

worklittle apply submit JOB_ID --body '{}'

Apply with AI

API reference

worklittle apply-with-ai start --body '{"job_id":"JOB_ID"}'
worklittle apply-with-ai status SESSION_ID
worklittle apply-with-ai continue SESSION_ID --body '{"answers":{"QUESTION":"ANSWER"}}'
worklittle apply-with-ai approve SESSION_ID
worklittle apply-with-ai stop SESSION_ID

Applied jobs

API reference

worklittle applied list
worklittle applied counts
worklittle applied track --body '{}'
worklittle applied update ID --body '{}'

Resumes

API reference

worklittle resumes create --body '{}'
worklittle resumes draft --body '{}'

Cover letters

API reference

worklittle cover-letters create --body '{}'
worklittle cover-letters draft --body '{}'

Job listings

API reference

worklittle listings list
worklittle listings create --body '{}'
worklittle listings update ID --body '{}'
worklittle listings delete ID

Employer jobs

API reference

worklittle employer-jobs list
worklittle employer-jobs create --body '{}'
worklittle employer-jobs update ID --body '{}'
worklittle employer-jobs delete ID
worklittle employer-jobs applications ID
worklittle employer-jobs org-get
worklittle employer-jobs org-set --body '{}'

Candidates

API reference

worklittle candidates list
worklittle candidates get CANDIDATE_ID
worklittle candidates update --body '{}'
worklittle candidates import --body '{}'
worklittle candidates stages

Offers

API reference

worklittle offers list
worklittle offers create --body '{}'
worklittle offers update --body '{}'
worklittle offers delete --offer_id OFFER_ID

Email

API reference

worklittle email list
worklittle email create --body '{}'
worklittle email update --body '{}'
worklittle email delete --body '{}'
worklittle email preview --body '{}'
worklittle email send --body '{}'
worklittle email sends
worklittle email send-get SEND_ID
worklittle email send-events SEND_ID

Employees

API reference

worklittle employees list
worklittle employees get EMPLOYEE_ID
worklittle employees create --body '{}'
worklittle employees update EMPLOYEE_ID --body '{}'
worklittle employees delete EMPLOYEE_ID

Organization

API reference

worklittle org list
worklittle org create --body '{}'
worklittle org update --body '{}'
worklittle org delete --organization_id ORGANIZATION_ID
worklittle org interview-questions

HR documents

API reference

worklittle documents list
worklittle documents create --body '{}'
worklittle documents templates

Attendance

API reference

worklittle attendance list
worklittle attendance employee EMPLOYEE_ID
worklittle attendance get ID
worklittle attendance create --body '{}'
worklittle attendance update ID --body '{}'

Surveys

API reference

worklittle surveys list
worklittle surveys get SURVEY_ID
worklittle surveys create --body '{}'
worklittle surveys update SURVEY_ID --body '{}'
worklittle surveys responses SURVEY_ID

Webhooks

API reference

worklittle webhooks list
worklittle webhooks create --body '{}'
worklittle webhooks get WEBHOOK_ID
worklittle webhooks update WEBHOOK_ID --body '{}'
worklittle webhooks delete WEBHOOK_ID
worklittle webhooks test WEBHOOK_ID
worklittle webhooks rotate-secret WEBHOOK_ID
worklittle webhooks deliveries

Usage

API reference

worklittle usage list --source public_api --limit 20

Billing

API reference

worklittle billing balance
worklittle billing invoices
worklittle billing usage

Limits

API reference

worklittle limits get
worklittle limits budget
worklittle limits budget-set --body '{}'

Agent tools

API reference

worklittle agent tools
worklittle agent tool TOOL_NAME --body '{}'

Health

worklittle health

Any --flag value you add becomes a query parameter, and --body takes a JSON string. A flag with no value is sent as true. Replace {} in --body with the fields from the linked API page.

Python CLI

pip install worklittle installs a worklittle command that covers a subset of the commands above, and also accepts --flag=value. It exits 1 on 402. See SDK.