TalentPrism CLI

tp is the command line for TalentPrism. It reads team-scoped recruiting data (sequences, candidates, interviews, reminders, campaign and activity summaries, evidence records) and makes changes through the same permissions and validation as the web app. It prints JSON that scripts and AI agents can parse, and reports errors as structured JSON with a stable code.

Full documentation: https://talentprism.ai/help/talentprism-cli/

Install

pipx install talentprism-cli
# or
uv tool install talentprism-cli

tp --version

Requires Python 3.11 or newer.

Sign in

People sign in with the browser:

tp login

Pick a team and approve. The CLI keeps short-lived tokens in ~/.talentprism/config.toml and refreshes them on its own. Use tp login --no-browser over SSH, and tp logout to sign out.

Scripts, CI jobs and AI agents use a team-scoped API key instead:

export TALENTPRISM_API_KEY="<your api key>"

New API keys expire one year after they are created. Your account page shows each key's expiry date and when it was last used; create a replacement key before the old one expires.

When several credentials are present, tp uses the first of: the --api-key flag, TALENTPRISM_API_KEY, login tokens in the profile, api_key in the profile. The server is https://talentprism.ai unless you set TALENTPRISM_BASE_URL (local development only).

Examples

tp whoami
tp sequences list --status Active --json
tp candidates search --query "aircraft assembler North Charleston" --json
tp activity summary --days 14 --json
tp candidates timeline <candidate_id> --days 30 --json

Changing data

Every write is two steps. Run the command once to get a preview and a one-time approval token. Nothing changes. Then run the same command again with --confirm-write --approval-token <token>:

tp candidates add-note 123 --text "Prefers second shift"
tp candidates add-note 123 --text "Prefers second shift" --confirm-write --approval-token <token>

Rate limits

Per credential (each API key, or each login), per minute: 300 reads, 60 changes, and 30 copilot questions (tp copilot ask and tp copilot brief). Previews count as reads. When a limit is hit the CLI reports rate_limited with a retry_after value.

Help

• tp --help and tp <command> --help list every command and flag.
• tp skill print prints the agent skill text bundled with the CLI.
• Errors come with a remediation line. The help page has a troubleshooting table keyed by error code.

License

Proprietary. The CLI is provided for use with a TalentPrism account; see LICENSE.txt in the package.