Developers

API Overview

https://api.alivio.dev/v1

Core Endpoints

POST   /roles                           Create a new role
GET    /roles/{id}                      Get role details
PATCH  /roles/{id}                      Update role
DELETE /roles/{id}                      Deactivate role

GET    /roles/{id}/candidates           Get scored pipeline
GET    /roles/{id}/candidates/{id}      Get candidate profile
POST   /roles/{id}/candidates/{id}/feedback  Submit rating

GET    /agents/status                   All agent statuses
GET    /agents/{agent}/logs             Agent action log

POST   /voice/call/initiate             Trigger qualification call
GET    /voice/call/{id}                 Get call metadata
GET    /voice/call/{id}/transcript      Get transcript
GET    /voice/call/{id}/audio           Get recording URL
POST   /voice/call/{id}/escalate        Escalate to human
GET    /voice/calls?role_id={id}        List calls for role

POST   /outreach/{id}/approve           Approve outreach
POST   /outreach/{id}/edit              Edit outreach

GET    /analytics/pipeline/{role_id}    Pipeline metrics
GET    /analytics/scoring/{role_id}     Scoring data

POST   /webhooks                        Register webhook
GET    /webhooks                        List webhooks
DELETE /webhooks/{id}                   Remove webhook

Webhook Events

role.created
role.updated
candidate.discovered
candidate.scored
voice.call.started
voice.call.completed
voice.candidate.qualified
voice.candidate.disqualified
voice.candidate.needs_review
voice.candidate.escalated
voice.candidate.declined
outreach.sent
outreach.replied
candidate.scheduled
feedback.received
agent.error

Use Cases

1. 1.

   Embed Alivio into an internal hiring portal

2. 2.

   Trigger pipelines from your HRIS

3. 3.

   Feed candidate data into your data warehouse

4. 4.

   Custom outreach and voice approval workflows

5. 5.

   Build custom scoring dashboards

Quickstart

import alivio

client = alivio.Client(api_key="your_api_key")

# Create a role and deploy agents
role = client.roles.create(
    title="Registered Nurse - ICU",
    location="Chicago, IL",
    requirements={
        "licenses": ["RN", "BLS", "ACLS"],
        "experience_years": 3,
        "setting": "acute care"
    },
    agents=["scout", "enrich", "signal", "voice", "engage", "schedule"]
)

# Retrieve scored candidates
candidates = client.candidates.list(
    role_id=role.id,
    min_score=0.75,
    sort="score_desc"
)

for c in candidates:
    print(f"{c.name} — Score: {c.score}")

# Check voice call results
calls = client.voice.list(role_id=role.id)
for call in calls:
    print(f"{call.candidate_name} — {call.qualification_status}")