Enterprise · API Reference

Intelligence API

Programmatic access to career health reports, company signals, team analytics, and job fit analysis. Built for enterprise talent teams that want to integrate Intraview intelligence into their existing workflows.

Authentication

All Intelligence API endpoints require authentication via a Bearer token. Enterprise and Team accounts can generate API keys from Settings → Integrations. Include the key in every request:

Headers

Authorization: Bearer iv_live_your_api_key_here
Content-Type: application/json

API keys are scoped to your team. Each key has read-only access to your team's data by default. Contact us for write-scoped keys or webhook integrations.

Rate Limits

Enterprise

1,000 requests/min

Team

100 requests/min

Pro

20 requests/min

Rate-limited responses return 429 with a Retry-After header in seconds.

Endpoints

GET/api/agent/career-health

Returns the current-period career health report for the authenticated user. Aggregates inbound volume, fit distribution, top engaging companies, topic frequency, outcome conversion, and market demand signals.

Auth: Bearer token

Plan: Pro, Team, Enterprise

Response

{
  "period": "2026-Q1",
  "generated_at": "2026-03-13T12:00:00Z",
  "inbound_volume": {
    "total": 47,
    "trend_vs_prior": 18.5
  },
  "fit_distribution": {
    "strong_fit": 22,
    "maybe": 15,
    "misfit": 10
  },
  "top_companies": [
    { "name": "Stripe", "count": 5, "fit_rate": 0.8 },
    { "name": "Notion", "count": 3, "fit_rate": 0.67 }
  ],
  "top_topics": [
    { "topic": "compensation", "count": 18 },
    { "topic": "remote_policy", "count": 12 }
  ],
  "outcome_summary": {
    "total_tracked": 30,
    "interview_rate": 0.43,
    "offer_rate": 0.13,
    "verified_count": 8,
    "unverified_count": 22,
    "verification_rate": 0.27,
    "verified_interview_rate": 0.63
  },
  "market_demand_signal": "increasing"
}

Reports are generated on demand and cached per period.
trend_vs_prior is a percentage change vs the previous period (null if no prior data).
market_demand_signal is one of: increasing, stable, decreasing, insufficient_data.

POST/api/agent/career-health

Force-regenerate a career health report. Optionally specify a period to generate a historical report.

Auth: Bearer token

Plan: Pro, Team, Enterprise

Request

{
  "period": "2025-Q4"
}

Response

// Same shape as GET /api/agent/career-health
// with the specified period's data

The period field is optional. Omit it to regenerate the current period.
Period format: YYYY-QN (e.g. 2026-Q1).

GET/api/agent/company-signals?company={name}

Returns anonymized aggregate intelligence signals for a specific company. Shows how the company engages across the platform — fit rates, outcome conversion, common topics, and recruiter interaction volume.

Auth: Bearer token

Plan: Pro, Team, Enterprise

Request

curl "https://app.intraview.io/api/agent/company-signals?company=Stripe" \
  -H "Authorization: Bearer iv_live_xxx"

Response

{
  "signals": {
    "company_name_normalized": "stripe",
    "total_interactions": 142,
    "strong_fit_rate": 0.62,
    "maybe_rate": 0.24,
    "misfit_rate": 0.14,
    "outcome_interview_rate": 0.48,
    "outcome_offer_rate": 0.15,
    "top_topics": ["compensation", "remote_policy", "team_size"],
    "sample_size": 38
  }
}

Company names are normalized (case-insensitive, suffixes like Inc/LLC stripped).
Signals require a minimum of 10 candidates interacting with the company before data is returned (privacy threshold).
All data is anonymized — no candidate PII is included.

POST/api/agent/job-summary

Analyzes a job description against the authenticated candidate's IV profile. Returns fit classification, matched areas, gaps, talking points, and a one-line pitch.

Auth: Bearer token

Plan: Pro, Team, Enterprise

Request

{
  "job_description": "We're looking for a Senior Product Manager to lead our Growth team. You'll own the full funnel from acquisition through activation..."
}

Response

{
  "overall_fit": "strong_fit",
  "matched_areas": [
    "Growth funnel ownership — 3 CARL stories demonstrate activation optimization",
    "Cross-functional leadership — proof story shows PM-eng-design collaboration"
  ],
  "gaps": [
    "No enterprise sales motion experience mentioned"
  ],
  "talking_points": [
    "Your activation funnel case study is directly relevant",
    "Highlight your data-driven experimentation framework"
  ],
  "one_line_pitch": "Growth-focused PM with proven activation optimization and cross-functional leadership."
}

Max job description length: 10,000 characters.
overall_fit is one of: strong_fit, maybe, misfit.
Powered by Claude — results are generated per request, not cached.

GET/api/team/agent/analytics

Coming soon. Will return a team-level analytics snapshot — inbound volume, response rates, fit distribution, top companies, outcome funnel, and agent utilization metrics across all team members.

Auth: Bearer token

Plan: Enterprise only (coming soon)

Response

{
  "team_id": "team_abc123",
  "period": "2026-Q1",
  "generated_at": "2026-03-13T12:00:00Z",
  "member_count": 12,
  "total_inbound": 384,
  "total_auto_replied": 241,
  "total_drafted": 98,
  "total_declined": 45,
  "fit_distribution": {
    "strong_fit": 188,
    "maybe": 112,
    "misfit": 84
  },
  "top_companies": [
    { "name": "Google", "count": 28, "avg_fit_rate": 0.71 }
  ],
  "outcome_funnel": {
    "total_tracked": 210,
    "screening_count": 95,
    "interview_count": 68,
    "offer_count": 22,
    "accept_count": 14
  },
  "agent_utilization": {
    "auto_reply_rate": 0.63,
    "draft_rate": 0.25,
    "decline_rate": 0.12
  }
}

Enterprise-only endpoint. Team and Pro accounts receive a 403.
Snapshots are generated monthly and cached.
Use this to track hiring pipeline health across your talent acquisition team.

PATCH/api/agent/messages/{id}/outcome

Record the outcome of a recruiter conversation thread. Feeds career health reports and coaching insights. Supports the full lifecycle from initial response through offer resolution.

Auth: Bearer token

Plan: Pro, Team, Enterprise

Request

{
  "outcome": "screening_scheduled",
  "notes": "Phone screen with hiring manager next Tuesday"
}

Response

{
  "id": "msg_abc123",
  "outcome": "screening_scheduled",
  "outcome_recorded_at": "2026-03-13T14:30:00Z"
}

Valid outcomes: no_response, ghosted, screening_scheduled, interviewed, offered, accepted, declined_by_candidate, declined_by_company, withdrew.
Only the thread owner can update outcomes.
Outcome data improves career health report accuracy over time.

Error Codes

400

Bad RequestMissing or invalid parameters.

401

UnauthorizedMissing or invalid API key.

403

ForbiddenYour plan does not include this endpoint.

429

Too Many RequestsRate limit exceeded. Check Retry-After header.

500

Server ErrorSomething went wrong on our end.

503

Service UnavailableBackend service is temporarily unavailable.

Get API access for your team

Enterprise plans include full API access, ATS integrations (beta), and dedicated support. SSO/SAML is coming soon. Tell us about your team and we'll set you up.

Contact Sales →