Docs API Reference Enterprise Changelog Blogs

Docs API Reference Enterprise Changelog Blogs

Get Auth Config GET Preview Invitation GET Accept Invitation By Token POST Signup POST Login POST Me GET Logout POST Refresh Session POST Switch Organization POST Set Password POST Generate Api Key POST Validate Api Key POST

Generate Agent Description POST Generate Test Prompt POST Generate Scenarios From Prompt POST Generate Test Setup POST List Agents GET Create Agent POST Check Phone Assignment GET Get Agent GET Delete Agent DELETE Update Agent PUT Sync Agent Provider Prompt POST Get Agent Delete Impact GET

List Personas GET Create Persona POST Get Voice Options GET Get Agent Prompt Sources GET Generate Persona Prompt POST List Custom Voices GET Create Custom Voice POST Delete Custom Voice DELETE Update Custom Voice PUT List Platform Ambient Presets GET Preview Ambient Preset GET List Ambient Library GET Upload Ambient Library Asset POST Update Ambient Library Asset PATCH Delete Ambient Library Asset DELETE Preview Ambient Library Asset GET Get Ambient Library Preview Url GET Get Persona GET Delete Persona DELETE Update Persona PUT Clone Persona POST Upload Persona Ambient Audio POST Delete Persona Ambient Audio DELETE Seed Demo Data POST

List Scenarios GET Create Scenario POST Get Scenario GET Delete Scenario DELETE Update Scenario PUT

List Integrations GET Create Integration POST Set Default Integration POST Get Integration GET Delete Integration DELETE Update Integration PUT Get Integration Api Key GET Preview Integration Agent Prompt POST

List Voicebundles GET Create Voicebundle POST Get Voicebundle GET Delete Voicebundle DELETE Update Voicebundle PUT

List Aiproviders GET Create Aiprovider POST Get Aiprovider GET Delete Aiprovider DELETE Update Aiprovider PUT Set Default Aiprovider POST Test Aiprovider POST

Format Custom Prompt POST List Evaluators GET Create Evaluator POST Create Evaluators Bulk POST Get Evaluator GET Delete Evaluator DELETE Update Evaluator PUT Run Evaluators POST

List Suites GET Create Suite POST Get Suite GET Delete Suite DELETE Update Suite PUT Add Scenarios POST Remove Scenario DELETE Add Personas POST Replace Personas PUT Remove Persona DELETE Activate Suite POST Run Suite POST Choose Next Combination POST Run Next Combination POST

List Metrics GET Create Metric POST Create Metric Draft POST Create Metric Draft With Children POST Promote Metric Draft POST Create Metric With Children POST Add Metric Child POST Promote Discovered Child POST Promote Discovered Metric POST Get Metric GET Delete Metric DELETE Update Metric PUT Seed Default Metrics POST Generate Metric POST Parse Bulk Metric POST

Get Evaluator Result Metric Cluster Failure Policies GET Save Evaluator Result Metric Cluster Failure Policies PUT List Evaluator Result Metric Cluster Eligible Rows GET List Evaluator Result Metric Cluster Scopes GET Get Evaluator Result Metric Clusters GET Generate Evaluator Result Metric Clusters POST Delete Evaluator Result Metric Clusters DELETE Cancel Evaluator Result Metric Clusters POST Get Evaluator Results Overview GET Get Evaluator Results Aggregate GET List Evaluator Results GET Create Evaluator Result Manual POST Delete Evaluator Results Bulk DELETE Get Evaluator Result GET Delete Evaluator Result DELETE Stream Evaluator Result Live Events GET Get Evaluator Result Metrics GET Stream Evaluator Result Audio GET Re Evaluate Result POST

Ingest Retell Webhook POST Ingest Call Via Webhook Url POST List Calls GET Get Call GET Delete Call DELETE Stream Call Live Events GET Stream Observability Call Audio GET Evaluate Call POST

Preview Call Import File POST List Call Imports GET Create Call Import POST Update Call Import Mapping PATCH Start Call Import POST Upload Call Import Csv POST Upload Call Import Audio POST Append Call Import Audio POST Get Call Import Dispatch Diagnostics GET List Call Import Datasets GET Get Call Import Diarisation Prompt Default GET Get Call Import Detail GET Update Call Import PATCH Delete Call Import DELETE List Call Import Row Ids GET Delete Call Import Row DELETE Retry Failed Call Import Rows POST Bulk Delete Call Import Rows POST Transcribe Call Import POST Transcribe Call Import Row POST Cancel Call Import Row Diarisation POST Cancel Call Import Diarisation POST Toggle Call Import Row Speaker Swap POST Get Call Import Insights GET List Call Import Schemas GET Create Call Import Schema POST Get Call Import Schema GET Update Call Import Schema PATCH Delete Call Import Schema DELETE List Call Import Tags GET Create Call Import Tag POST Update Call Import Tag PATCH Delete Call Import Tag DELETE

List Workspaces GET Create Workspace POST Update Workspace PATCH Delete Workspace DELETE

Api reference

Authentication Guide

EfficientAI accepts either bearer tokens or organization API keys on most authenticated endpoints.

Header options

Authorization: Bearer <token>
X-API-Key: <api-key>
Optional workspace scoping: X-Workspace-Id: <workspace-uuid>

Bearer token flow

Create a session with POST /api/v1/auth/login.
Use the returned access token in Authorization for subsequent requests.
Refresh with POST /api/v1/auth/refresh when required.

API key flow

Authenticate once with bearer credentials.
Generate a key using POST /api/v1/auth/generate-key.
Send that key in X-API-Key for service-to-service usage.

Public endpoints

These routes are intentionally unauthenticated:

GET /api/v1/auth/config
POST /api/v1/auth/login
POST /api/v1/auth/signup
POST /api/v1/auth/refresh
GET /api/v1/auth/invitations/preview/{token}

All other pages in this API Reference assume authenticated access unless explicitly marked otherwise.

Community & contact

Found a bug or have a feature request? Open a GitHub issue.
Join our Discord for faster replies!

On this page

Authentication Guide Header options Bearer token flow API key flow Public endpoints

Contributors

aadhar-EAI
Tejas Narayan