HireSquire SDK - AI-powered candidate screening for agents and humans
Project description
HireSquire Python SDK
Python SDK for HireSquire's AI-powered candidate screening API. Includes native LangChain and AutoGen integration.
Installation
pip install hiresquire
Quick Start
Option 1: Client Class (Recommended)
from hiresquire import HireSquire
client = HireSquire("YOUR_API_TOKEN")
# Submit and wait automatically
job = client.screen(
title="Senior Python Developer",
description="Looking for experienced Python developer with Django experience...",
resumes=["./resumes/john_doe.pdf", "./resumes/jane_smith.pdf"]
)
# Get results when complete
results = client.wait_for_completion(job["job_id"])
for candidate in results["candidates"]:
print(f"{candidate['name']}: {candidate['score']}/100")
Option 2: Direct Function Calls
from hiresquire import create_screening_job, get_screening_status, get_screening_results
# Submit a screening job
result = create_screening_job(
title="Senior Python Developer",
description="Looking for experienced Python developer with Django experience...",
resumes=[
{"filename": "john_doe.pdf", "content": "John Doe\n5 years Python experience..."}
]
)
job_id = result["job_id"]
# Poll for completion
status = get_screening_status(job_id=job_id)
while status["status"] == "processing":
time.sleep(3)
status = get_screening_status(job_id=job_id)
# Get results
results = get_screening_results(job_id=job_id)
for candidate in results["candidates"]:
print(f"{candidate['name']}: {candidate['score']}/100")
Environment Variables
Set these before using the SDK:
export HIRESQUIRE_API_TOKEN="your_api_token_here"
export HIRESQUIRE_BASE_URL="https://api.hiresquireai.com/api/v1" # optional
LangChain Integration
from langchain.agents import AgentExecutor, create_openai_functions_agent
from langchain_openai import ChatOpenAI
from hiresquire import get_hiresquire_tools
llm = ChatOpenAI(temperature=0)
tools = get_hiresquire_tools()
agent = create_openai_functions_agent(llm, tools)
executor = AgentExecutor(agent=agent, tools=tools, verbose=True)
# Use in an agent
result = executor.invoke({
"input": "Submit a screening job for a Python developer and find candidates with score > 80"
})
Available Tools
| Tool | Description |
|---|---|
create_screening_job |
Submit a new screening job |
get_screening_status |
Check job status |
get_screening_results |
Get completed job results |
wait_for_screening_completion |
Poll until job completes |
generate_candidate_email |
Generate outreach email |
get_candidates_by_score |
Filter candidates by score |
compare_candidates |
Compare candidates side-by-side |
report_hiring_outcome |
Report hiring outcome |
test_webhook |
Test a webhook endpoint |
get_rate_limit |
Check API rate limit status |
whoami |
Verify token and get profile info |
get_credit_balance |
Check current credit balance |
estimate_screening_cost |
Estimate cost for N candidates |
list_credit_packs |
List available credit packs |
get_credit_transactions |
View credit transaction history |
enable_auto_reload |
Enable automatic credit reloading |
disable_auto_reload |
Disable automatic credit reloading |
list_calendar_connections |
List connected calendar tools |
create_calendar_connection |
Connect Calendly or Cal.com |
get_available_slots |
Get available time slots |
create_interview |
Schedule an interview |
generate_meeting_link |
Generate Zoom/Meet links |
API Documentation
Full API documentation available at: https://hiresquireai.com/docs/api
License
MIT License - see LICENSE file for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hiresquire-1.2.2.tar.gz.
File metadata
- Download URL: hiresquire-1.2.2.tar.gz
- Upload date:
- Size: 14.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b4b5ec39d68cf53385698ee40b08b46bd75b1013ec23b978ed9ea406991e7485
|
|
| MD5 |
36a6af6bacad75da2aaf864c223980c6
|
|
| BLAKE2b-256 |
f370923212f55ce863881c8abfae28eb280a0474412c32bbd7294cbe05d3f482
|
File details
Details for the file hiresquire-1.2.2-py3-none-any.whl.
File metadata
- Download URL: hiresquire-1.2.2-py3-none-any.whl
- Upload date:
- Size: 13.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
169a79c6be362fc20560415ce1a58652857e93161dd436c5e0dcf6f0ee7f876e
|
|
| MD5 |
785b70653cc26b6516bcb88bd17706b1
|
|
| BLAKE2b-256 |
bbf4b4b8fd444130345a9e781600ed07be32ed33e3de5fd3bd97108bb84e5e4d
|