AI Agent Integration

HireSquire for AI Agents

Integrate AI-powered candidate screening into LangChain, AutoGen, Claude Desktop, OpenAI Custom GPTs, OpenClaw, Claude Code, Codex, or any CLI-capable agent.

Supports REST API, MCP server, Python SDK, and CLI for resume analysis, candidate scoring, interview questions, and automated email generation.

For Business Users & AI Operators

Looking for fast onboarding? You don't need to write code to use HireSquire with Claude, ChatGPT, or Cursor. We have 1-click setup guides and copy-paste prompts ready for you in our AI Workspaces Hub.

Explore AI Workspaces

Quick Start

HireSquire provides multiple ways to integrate with AI agents. Choose the method that best fits your workflow:

🧠 Skill File

Copy/paste into any agent's system prompt

🔌 GPT Plugin

1-click import into OpenAI Custom GPTs

🐍 Python SDK

pip install hiresquire for LangChain

⚡ MCP Server

JSON-RPC for Claude Code & agents

🔑 Agent Keys

API keys with spend limits

💳 Prepaid Credits

Pay-as-you-go for agents

Note: All agent integrations require an API token. Get your token from your profile settings.

Command Line Interface (CLI)

The HireSquire CLI is the fastest way to integrate with CLI-capable agents like OpenClaw, Claude Code, OpenCode, and Codex. View on npm → | GitHub →

Installation

npm install -g hiresquire-cli

Configuration

hiresquire init --token YOUR_TOKEN

Quick Commands

hiresquire screen --title "Job Title" --description "Job description" --resumes ./resumes/
hiresquire results --job 123 --json
hiresquire status --job 123 --watch

Options

  • --json - Output as JSON for agent parsing
  • --watch - Poll for completion automatically
  • --min-score N - Filter results by minimum score
  • --only-top-n N - Return only top N candidates

Skill File

Copy and paste this into your AI agent's system prompt. It teaches the agent how to use HireSquire with the async polling pattern.

skill.md

# HireSquire Agent Skills

You have access to the HireSquire API for AI-powered candidate screening.

## Authentication
All requests require: Authorization: Bearer YOUR_API_TOKEN

## Async Workflow (CRITICAL)
1. POST /api/v1/jobs with resumes → get job_id
2. Poll GET /api/v1/jobs/{job_id} until status="completed"  
3. GET /api/v1/jobs/{job_id}/results

## Endpoints
- POST /api/v1/jobs - Submit screening
- GET /api/v1/jobs/{id} - Check status  
- GET /api/v1/jobs/{id}/results - Get results

See: https://hiresquireai.com/skill.md

View full skill.md →

OpenAI GPT Plugin

Import HireSquire directly into OpenAI Custom GPTs with 1 click. The plugin provides:

  • Automatic OpenAPI schema discovery
  • User authentication via Bearer token
  • Full access to all API endpoints

Plugin URL

https://hiresquireai.com/.well-known/ai-plugin.json

How to Import

  1. Go to chat.openai.com
  2. Click "Explore" → "Create new GPT"
  3. Select "Configure" tab
  4. Under "Actions", click "Import from URL"
  5. Paste: https://hiresquireai.com/.well-known/ai-plugin.json

LangChain Python SDK

Install via pip and use in LangChain agents with @tool decorators. View on PyPI → | GitHub →

pip install hiresquire

Usage

from hiresquire import get_hiresquire_tools
from langchain.agents import AgentExecutor

tools = get_hiresquire_tools()

# Use in your LangChain agent
agent = create_openai_functions_agent(llm, tools)
executor = AgentExecutor(agent=agent, tools=tools)

View full SDK source →

Model Context Protocol (MCP)

The HireSquire MCP server provides JSON-RPC 2.0 endpoints for AI agents like Claude Code, OpenCode, and Codex. This protocol enables native tool calling without HTTP REST overhead. Source Code (GitHub) →

Endpoint

POST https://hiresquireai.com/api/v1/mcp

Available Tools

Tool Description
Screening & Candidates
create_screening Submit a new candidate screening job
get_screening_status Check the status of a screening job
get_results Get screening results and candidate scores
cancel_screening_job Cancel a running screening job
generate_email Generate interview invites or rejection emails
report_hiring_outcome Report hiring outcome to improve AI accuracy
Payments & Credits
get_credit_balance Check current prepaid credit balance
estimate_screening_cost Estimate cost before submitting a job
purchase_credits Purchase credits with saved payment method
create_checkout_session Generate a Stripe checkout link
enable_auto_reload Enable automatic credit recharging
disable_auto_reload Disable automatic credit recharging
list_credit_packs List available credit purchase packs
get_credit_transactions View credit transaction history
Calendar & Scheduling
list_calendar_connections List connected tools (Calendly, Cal.com)
create_calendar_connection Connect a new calendar provider via API key
get_available_slots Get available time slots from provider
create_interview Schedule an interview event
generate_meeting_link Create a Zoom or Google Meet link
System & Utilities
whoami Verify token and check account info
get_api_schema Get JSON schema for all API endpoints
test_webhook Send a test ping to a webhook URL

Example Request

{
  "jsonrpc": "2.0",
  "method": "create_screening",
  "params": {
    "title": "Senior PHP Developer",
    "description": "Looking for experienced PHP developer...",
    "resumes": [
      {"filename": "john.pdf", "content": "John Doe\n5 years PHP..."}
    ]
  },
  "id": 1
}

💡 Claude Desktop Integration

To use with Claude Desktop, add this to your Claude config:

{
  "mcpServers": {
    "hiresquire": {
      "command": "npx",
      "args": ["-y", "hiresquire-cli", "mcp"]
    }
  }
}

Calendar & Meeting Integrations

Automate interview scheduling by connecting calendar and meeting tools.

Quick Option: Simple Scheduling Link (Recommended)

Add your public calendar URL directly in Profile Settings (/profile):

  • ✅ Works with ANY scheduling tool (Calendly, Cal.com, Google Appointment Schedule, HubSpot Meetings, Microsoft Teams, etc.)
  • ✅ Just paste your public booking link - no API keys needed
  • ✅ Automatically included in interview invitation emails

Supported URL formats:

https://calendly.com/yourname https://cal.com/yourname https://goog.le/appointment-schedule/... Any public scheduling URL

Advanced: API Integrations (Optional)

For automatic status updates when candidates book:

Supported Tools

Tool Auth Method Setup Time
Any Public Link None (URL only) 30 seconds
Calendly API Key 2 min
Cal.com API Key 2 min

CLI Commands (For Agents)

# Connect calendar tools
hiresquire calendar:connect calendly --token YOUR_TOKEN
hiresquire calendar:connect calcom --token YOUR_TOKEN

# List connections
hiresquire calendar:list

# Schedule interview (after screening)
hiresquire interviews:schedule --job 123 --candidate 456 --time "2026-04-28 10:00"

REST API Endpoints

Manage Calendar Connections

GET|POST|DELETE /api/v1/calendar/connections

Get Available Slots

GET /api/v1/calendar/slots?provider=calendly&date=2026-04-27

Create Interview

POST /api/v1/interviews
{
  "job_id": 123,
  "candidate_id": 456,
  "scheduled_at": "2026-04-28T10:00:00Z"
}

Python SDK Methods

from hiresquire import HireSquire

client = HireSquire("TOKEN")

# Connect calendar
client.calendar.connect(
    provider="calendly",
    api_key="YOUR_TOKEN"
)

# Or connect Cal.com
client.calendar.connect(
    provider="calcom",
    api_key="YOUR_API_KEY"
)

# Get available slots
slots = client.calendar.get_slots(
    provider="calendly",
    date="2026-04-27"
)

# Create interview
interview = client.calendar.create_interview(
    job_id=123,
    candidate_id=456,
    scheduled_at="2026-04-28T10:00:00Z"
)

User-Specific Setup

AI Agents (Claude Code, OpenClaw, Codex)

  • Use CLI --json output for parsing
  • Store API keys in environment variables
  • Automate connection via REST API in agent workflows

Technical Managers

  • Use web dashboard or CLI
  • Configure webhooks for real-time updates
  • Leverage Python SDK for custom automation

Non-Technical Hiring Managers

  • Navigate to Profile → Integrations
  • Follow on-screen prompts
  • Paste API keys (no code required for Calendly/Cal.com)

Advanced Features

Additional endpoints for enhanced agent workflows:

Cancel a Job

Stop a processing job mid-way.

POST /api/v1/jobs/{job_id}/cancel

Compare Candidates

Side-by-side comparison of multiple candidates.

GET /api/v1/jobs/{job_id}/compare?ids=1,2,3

Report Hiring Outcome

Feedback loop to improve future screening accuracy.

POST /api/v1/jobs/{job_id}/outcome

Test Webhook

Verify your webhook endpoint is working.

POST /api/v1/webhooks/test

Validate Token

Verify API token is valid without using credits.

GET /api/v1/schema/validate

Bulk Job Submission

Submit up to 10 screening jobs at once.

POST /api/v1/jobs/bulk

Agent API Keys with Spend Controls

Create dedicated API keys for AI agents with built-in spend limits. Perfect for controlling costs while allowing agents to operate autonomously.

Create Agent Key

{
  "name": "My Agent",
  "monthly_spend_limit": 100,
  "daily_spend_limit": 10,
  "lifetime_spend_limit": null
}

Spend Limit Options

Limit Type Description
daily_spend_limit Maximum dollars per day ($1.00 = 100 credits)
monthly_spend_limit Maximum dollars per month
lifetime_spend_limit Total dollars allowed over key lifetime

Agent Key Endpoints

GET /api/v1/agent-keys - List all agent keys
GET /api/v1/agent-keys/{id} - Get key details + usage summary
GET /api/v1/agent-keys/{id}/usage - Detailed real-time tracking
DELETE /api/v1/agent-keys/{id} - Revoke key

Spend Limit Units

All limits are in dollars ($0.01 = 1 credit). A daily_spend_limit of 5.00 means the agent can spend up to $5.00 per day.

Usage Webhooks

Configure webhooks to get notified when an agent approaches its spend limit:

{
  "event": "agent_key.threshold_reached",
  "key_id": 1,
  "key_name": "My Agent",
  "usage": 80,
  "limit": 100,
  "remaining": 20
}

Webhook events: threshold_reached, daily_limit, monthly_limit, credits_exhausted

Prepaid Credits for Agents

Purchase prepaid credits for pay-as-you-go agent usage. No subscription required.

Pouch

$5

500 credits

$0.01/candidate

Satchel

$25

2,750 credits (+250 bonus)

$0.0089/candidate

Chest

$100

12,000 credits (+2,000 bonus)

$0.0083/candidate

Credit API Endpoints

GET /api/v1/credits/balance - Check current balance
GET /api/v1/credits/estimate-cost?candidate_count=N - Estimate cost
GET /api/v1/credits/transactions - View transaction history
POST /api/v1/credits/checkout - Create Stripe checkout
POST /api/v1/credits/purchase - Direct purchase with saved PM
POST /api/v1/credits/auto-reload/enable - Enable auto-recharge
POST /api/v1/credits/auto-reload/disable - Disable auto-recharge

Free Monthly Credits

All accounts receive 30 free credits per month automatically. No signup required. Perfect for testing and light usage.

Auto-Reload Feature

Enable auto-reload to automatically purchase more credits when your balance falls below $1 or 5% of your largest purchase. Never run out of credits mid-screening.

Advanced Tutorials & Case Studies

REST API Reference

For detailed API documentation including all endpoints, request/response formats, and webhooks: