# InstaView API

## Docs

- [Create Agent](https://docs.instaview.sk/api-reference/agents/create-agent.md): Creates a new agent scoped to the API key's company.
- [Delete Agent](https://docs.instaview.sk/api-reference/agents/delete-agent.md): Soft-deletes an agent that belongs to the API key's company.
- [Get Agent](https://docs.instaview.sk/api-reference/agents/get-agent.md): Returns a single agent, ensuring it belongs to the API key's company.
- [List Agents](https://docs.instaview.sk/api-reference/agents/list-agents.md): Lists agents for the API key's company with pagination.
- [Update Agent](https://docs.instaview.sk/api-reference/agents/update-agent.md): Updates an existing agent scoped to the API key's company.
- [Get Usage Statistics](https://docs.instaview.sk/api-reference/billing/get-usage.md): For direct client keys, returns usage for the associated company. For ATS keys, returns aggregated usage across ATS-managed companies. Test interviews (created with isTest=true) are excluded from billing and usage summaries.
- [Create Candidate](https://docs.instaview.sk/api-reference/candidates/create-candidate.md): Creates a new candidate (optionally associated with one or more jobs) in the API key's company.
- [Delete Candidate](https://docs.instaview.sk/api-reference/candidates/delete-candidate.md): Soft-deletes a candidate that belongs to the API key's company. Candidates can be deleted regardless of job association status.
- [Get Candidate](https://docs.instaview.sk/api-reference/candidates/get-candidate.md): Returns a single candidate, ensuring the candidate (and any job associations) belong to the API key's company.
- [List Candidates](https://docs.instaview.sk/api-reference/candidates/list-candidates.md): Lists candidates that belong to the API key's company. Includes candidates with job associations and candidates in the candidate pool (no job assignments).
- [Update Candidate](https://docs.instaview.sk/api-reference/candidates/update-candidate.md): Updates a candidate that belongs to the API key's company. Only basic profile/contact/status fields are supported.
- [Create Company](https://docs.instaview.sk/api-reference/companies/create-company.md): Creates a new company using an ATS API key. Direct client keys cannot create companies via this endpoint.
- [Delete Company](https://docs.instaview.sk/api-reference/companies/delete-company.md): Permanently deletes a company. This action is irreversible. ATS keys can delete companies they created; direct client keys can delete their own company.
- [Get Company](https://docs.instaview.sk/api-reference/companies/get-company.md): Returns a single company. Direct client keys can only access their own company; ATS keys can only access companies they created.
- [List Companies](https://docs.instaview.sk/api-reference/companies/list-companies.md): For direct client API keys, returns the single associated company. For ATS keys, returns companies created by this API key.
- [Update Company](https://docs.instaview.sk/api-reference/companies/update-company.md): Updates company details. ATS keys can update companies they created; direct client keys can update their own company.
- [Create Interview](https://docs.instaview.sk/api-reference/interviews/create-interview.md): Creates an interview for a candidate using an existing or inline candidate/agent/job, scoped to the API key's company. Respects company billing limits and subscription plans. Set isTest=true to create a test interview that immediately completes without consuming billing minutes.
- [Delete Call Attempt](https://docs.instaview.sk/api-reference/interviews/delete-call-attempt.md): Cancels and deletes a specific call attempt. Blocked for ONLINE interviews.
- [Delete Interview](https://docs.instaview.sk/api-reference/interviews/delete-interview.md): Permanently deletes an interview and all associated data (transcripts, recordings, and analyses). This action is irreversible. Scheduled interviews are automatically removed from the processing queue. For in-progress interviews, the active call continues until completion, but all post-call processin…
- [Get Interview](https://docs.instaview.sk/api-reference/interviews/get-interview.md): Returns a single interview, ensuring it belongs to the API key's company.
- [Get Interview Analysis PDF](https://docs.instaview.sk/api-reference/interviews/get-interview-analysis-pdf.md): Returns the Base64-encoded PDF report of the candidate analysis for a specific interview. The interview must have a completed analysis for the PDF to be available.
- [Invoke New Call Attempt](https://docs.instaview.sk/api-reference/interviews/invoke-call-attempt.md): Creates a new call attempt for an interview. Optionally schedules it for a future time. Individual call attempt management is strictly forbidden for ONLINE interviews.
- [List Interviews](https://docs.instaview.sk/api-reference/interviews/list-interviews.md): Lists interviews for a given candidate within the API key's company. For MVP, candidateId is required.
- [Reschedule Call Attempt](https://docs.instaview.sk/api-reference/interviews/reschedule-call-attempt.md): Reschedules an existing call attempt to a future time. Only call attempts in SCHEDULED status can be rescheduled. Blocked for ONLINE interviews.
- [API Reference](https://docs.instaview.sk/api-reference/introduction.md): Complete API reference for the InstaView API
- [Create Job](https://docs.instaview.sk/api-reference/jobs/create-job.md): Creates a new job scoped to the API key's company.
- [Create Job from URL](https://docs.instaview.sk/api-reference/jobs/create-job-from-url.md): Scrapes the provided job posting URL and extracts structured data. By default, creates a job entity from the extracted data. Set createJob to false to only extract data without persisting a job.
- [Delete Job](https://docs.instaview.sk/api-reference/jobs/delete-job.md): Soft-deletes a job that belongs to the API key's company.
- [Get Job](https://docs.instaview.sk/api-reference/jobs/get-job.md): Returns a single job, ensuring it belongs to the API key's company.
- [List Jobs](https://docs.instaview.sk/api-reference/jobs/list-jobs.md): Lists jobs for the API key's company with pagination.
- [Update Job](https://docs.instaview.sk/api-reference/jobs/update-job.md): Updates an existing job scoped to the API key's company.
- [Generate Audio](https://docs.instaview.sk/api-reference/voice/generate-audio.md): Converts text to speech using AI-powered voices. Returns an audio stream in MP3 format.
- [Create Webhook](https://docs.instaview.sk/api-reference/webhooks/create-webhook.md)
- [Delete Webhook](https://docs.instaview.sk/api-reference/webhooks/delete-webhook.md)
- [Get Webhook](https://docs.instaview.sk/api-reference/webhooks/get-webhook.md)
- [List Webhooks](https://docs.instaview.sk/api-reference/webhooks/list-webhooks.md)
- [Reset Circuit Breaker](https://docs.instaview.sk/api-reference/webhooks/reset-circuit.md)
- [Test Webhook](https://docs.instaview.sk/api-reference/webhooks/test-webhook.md)
- [Update Webhook](https://docs.instaview.sk/api-reference/webhooks/update-webhook.md)
- [Authentication](https://docs.instaview.sk/authentication.md): Learn how to authenticate with the InstaView API using API keys
- [November 2025](https://docs.instaview.sk/changelog/2025-11.md): Changelog entries for November 2025
- [December 2025](https://docs.instaview.sk/changelog/2025-12.md): Changelog entries for December 2025
- [January 2026](https://docs.instaview.sk/changelog/2026-01.md): Changelog entries for January 2026
- [February 2026](https://docs.instaview.sk/changelog/2026-02.md): Changelog entries for February 2026
- [March 2026](https://docs.instaview.sk/changelog/2026-03.md): Changelog entries for March 2026
- [Changelog](https://docs.instaview.sk/changelog/introduction.md): Track all changes, updates, and improvements to the InstaView API
- [API Keys](https://docs.instaview.sk/guides/api-keys.md): Complete guide to managing InstaView API keys
- [ATS Integration](https://docs.instaview.sk/guides/ats-integration.md): Build multi-tenant ATS integrations with InstaView
- [Best Practices](https://docs.instaview.sk/guides/best-practices.md): Production-ready patterns for InstaView API integration
- [Error Handling](https://docs.instaview.sk/guides/error-handling.md): Learn how to handle errors and exceptions in the InstaView API
- [Pagination](https://docs.instaview.sk/guides/pagination.md): Learn how to efficiently paginate through large result sets
- [Rate Limiting](https://docs.instaview.sk/guides/rate-limiting.md): Rate limiting for the InstaView API
- [Agents](https://docs.instaview.sk/guides/resources/agents.md): Configure AI interview agents for conducting candidate assessments
- [Billing & Usage](https://docs.instaview.sk/guides/resources/billing.md): Monitor usage and track interview minutes or credits
- [Candidates](https://docs.instaview.sk/guides/resources/candidates.md): Manage candidate profiles and applications with the Candidates API
- [Companies](https://docs.instaview.sk/guides/resources/companies.md): Manage company profiles and settings
- [Interviews](https://docs.instaview.sk/guides/resources/interviews.md): Schedule and manage AI-powered interviews with the Interviews API
- [Jobs](https://docs.instaview.sk/guides/resources/jobs.md): Manage job postings and position requirements with the Jobs API
- [Webhooks](https://docs.instaview.sk/guides/resources/webhooks.md): Configure and manage webhook endpoints for real-time event notifications
- [Scopes and Permissions](https://docs.instaview.sk/guides/scopes-and-permissions.md): Understanding scope-based access control in the InstaView API
- [Webhooks](https://docs.instaview.sk/guides/webhooks.md): Real-time notifications for events in your InstaView account
- [Welcome to InstaView API](https://docs.instaview.sk/introduction.md): Build powerful AI-powered interview solutions with InstaView's comprehensive API
- [Quickstart](https://docs.instaview.sk/quickstart.md): Make your first API call to InstaView in under 5 minutes

## OpenAPI Specs

- [openapi](https://docs.instaview.sk/api-reference/openapi.json)