Voice AI Public APIs in Sparkforge: Overview

Sparkforge Voice AI Public APIs let you programmatically manage agents and actions, retrieve call logs and transcripts, and stream real-time webhooks into your workflows. This makes Voice AI an extensible capability you can build into your own applications, not just an in-app product.

What the Voice AI Public APIs do

Direct API access lets you go beyond in-app controls:

• Manage agents and actions: Create, update, and organize agents and their behaviors via API.
• Retrieve call data: Access logs and transcripts for reporting, compliance, or analytics.
• Use webhooks: Receive real-time call outcomes, transcripts, and summaries in your own systems.

Key benefits

• Data access: Pull call outcomes, transcripts, and metrics for tracking and reporting.
• Workflow integration: Automate setup and tailor Voice AI to fit your applications.
• Extensibility: Public APIs make Voice AI buildable, not just usable.

Access requirements, environments, and auth details may evolve. Always check the official API docs for the latest details.

Call Log APIs

Call Log APIs return calls handled by Voice AI for analytics, quality reviews, and compliance.

• List Call Logs: Returns Voice AI agent call logs scoped to a location. Supports filtering by agent, contact, call type, action types, and date range (in the provided IANA timezone). Sorting and 1-based pagination supported.
• Get Call Log: Returns a single call log by call ID, including transcripts when available.

Agents APIs

Agents APIs let you create, list, read, update, and delete Voice AI agents to roll out consistent configurations across locations and environments.

• Create Agent: Create a new Voice AI agent with configuration and settings.
• Patch Agent: Partially update an existing agent.
• List Agents: Retrieve a paginated list of agents for a location.
• Get Agent: Retrieve detailed configuration for a specific agent.
• Delete Agent: Delete an agent and all its configurations.

Actions APIs

Actions define what an agent can do during a call: invoke webhooks, retrieve data, or post results. Use the Actions APIs to keep behaviors in sync with your systems.

• Create Agent Action: Create a new action for a Voice AI agent.
• Update Agent Action: Update an existing action's behavior and configuration.
• Get Agent Action: Retrieve a specific action by ID, including actionParameters.
• Delete Agent Action: Permanently remove an action and its configuration.