API Reference

Complete documentation for all Ferni Developer Platform v2 endpoints.

Base URLhttps://api.ferni.ai/api/v2/developers

Authentication Required

All endpoints require authentication via Authorization: Bearer pk_live_xxx header. Get your API key from the Getting Started guide.

MCP Servers

Register and manage external Model Context Protocol servers.

MethodEndpointDescription
POST/mcp-serversRegister a new MCP server
GET/mcp-serversList all your MCP servers
GET/mcp-servers/:idGet server details
PUT/mcp-servers/:idUpdate server configuration
DELETE/mcp-servers/:idDelete a server
POST/mcp-servers/:id/testTest server connection
GET/mcp-servers/:id/toolsList discovered tools

Custom Tools

Create webhook, MCP, or prompt-based tools for voice agents.

MethodEndpointDescription
POST/toolsCreate a new tool
GET/toolsList all your tools
GET/tools/:idGet tool details
PUT/tools/:idUpdate tool configuration
DELETE/tools/:idDelete a tool
POST/tools/:id/testTest tool execution

Webhooks

Subscribe to real-time events from voice agent sessions.

MethodEndpointDescription
POST/webhooksCreate a webhook subscription
GET/webhooksList all your webhooks
GET/webhooks/:idGet webhook details
PUT/webhooks/:idUpdate webhook configuration
DELETE/webhooks/:idDelete a webhook
POST/webhooks/:id/testSend a test event
GET/webhooks/:id/logsView delivery logs

Workflows

Build multi-step automations with branching and parallel execution.

MethodEndpointDescription
POST/workflowsCreate a new workflow
GET/workflowsList all your workflows
GET/workflows/:idGet workflow details
PUT/workflows/:idUpdate workflow definition
DELETE/workflows/:idDelete a workflow
POST/workflows/:id/executeExecute workflow
POST/workflows/:id/testTest workflow (dry run)
GET/workflows/:id/executionsList execution history

Activities

Track custom metrics and query historical activity data.

MethodEndpointDescription
POST/activitiesLog a new activity
GET/activitiesQuery activities
GET/activities/statsGet aggregate statistics
GET/activities/:idGet activity details
PUT/activities/:idUpdate activity
DELETE/activities/:idDelete activity

OAuth

Integrate external services using your own OAuth applications.

MethodEndpointDescription
POST/oauth/providersRegister OAuth provider
GET/oauth/providersList providers
GET/oauth/providers/:idGet provider details
PUT/oauth/providers/:idUpdate provider
DELETE/oauth/providers/:idDelete provider
POST/oauth/authorizeStart OAuth flow
GET/oauth/callbackOAuth callback
GET/oauth/tokensList tokens
DELETE/oauth/tokens/:idRevoke token