Documentation
Examples
API Reference
Neuratel SDK
Neuratel MCP
Neuratel CLI
Status

Neuratel API

Neuratel API

Build AI-powered voice agents with a simple API.

Authentication

All API requests require authentication via Bearer token:

Code
Authorization: Bearer nk_live_your_api_key

Get your API key from the Neuratel Dashboard.

Rate Limits

Rate limiting is disabled by default. If enabled for abuse protection or enterprise governance, responses include:

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset
Retry-After (on 429 responses)

Tags

Create, configure, and manage AI voice agents. Agents handle voice conversations with customizable LLM, TTS, and STT settings.

Phone number management. Provision, configure, and assign phone numbers to agents for inbound/outbound calling.

Model Context Protocol server registrations + workspace credential vault. Connect external tool servers and reuse stored auth across them.

Voice library management. Browse and configure TTS voices from Cartesia and other providers.

Call analytics and metrics. Track performance, latency, success rates, and conversation insights.

System notifications. Receive alerts about call events, system status, and important updates.

System status and health. Monitor service health, uptime, and scheduled maintenance.

Event delivery and webhook subscriptions for real-time integrations.

Organization management, memberships, and invites.

Usage, billing summaries, and cost reporting.

Knowledge base documents, retrieval, and indexing.

User authentication and session management.

API key management for programmatic access.

Outbound calling campaigns — create, start, pause, and stop.

Schemas

APIKeyCreate APIKeyListMetadata APIKeyListResponse APIKeyResponse APIKeyRotateResponse APIKeyWithSecret AccountListResponse AccountResponse ActiveCallInfo ActiveCallParticipant ActiveCallsResponse AddToDncConfig AdminAdjustCreditsRequest AdminAdjustCreditsResponse AdminBillingOverridesRequest AdminBillingOverridesResponse AdminDNCAddRequest AdminPilotActionResponse AdminPilotConvertRequest AdminPilotConvertResponse AgentAssignRequest AgentCallRequest AgentCallResponse AgentCreate AgentKnowledgeBaseAssignment AgentKnowledgeBaseListResponse AgentListResponse AgentMetricsSummary AgentPerformance AgentRequiredVariablesResponse AgentResponse AgentRestoreResponse AgentUpdate AgentVersionEntry AgentVersionListResponse AgentVersionResponse AllOrgsUsageResponse AmbientAudioConfig AnalysisPlan AnalyticsConfig AnalyticsDashboardResponse AnnouncementRequest AuthConnectionCreate AuthConnectionListResponse AuthConnectionResponse AuthConnectionUpdate AuthContextResponse AutoReloadSettingsRequest AutoReloadSettingsResponse BackchannelConfig BackgroundAudioConfig BadRequestError BalanceCheckResponse BalanceHistoryResponse BalanceResponse BalanceTransactionResponse BatchCallRequest BatchCallResponse BillingListMetadata BillingPortalRequest BillingPortalResponse BillingSettingsResponse BuiltinAudioClip BulkPasteContactRow BulkPasteContactsRequest BulkPasteContactsResponse CallDurationConfig CallListContactCreate CallListContactResponse CallListContactUpdate CallListCreate CallListResponse CallListUpdate CallListsListResponse CallOutcomeBreakdown CallPermissionStatusResponse CallResponse CallSchedule CallStatusResponse CallVolumeDataPoint CampaignAttemptListResponse CampaignAttemptResponse CampaignConfig CampaignCoverageResponse CampaignListResponse CampaignPerformance CampaignRetryRequest CampaignRetryResponse CampaignTestWebhookResponse CartesiaEmotion CartesiaModel CartesiaSpeed CartesiaVoiceConfig ChatChannelMetrics ChatDashboardResponse ChatDeliveryBreakdown ChatKPIs ChatVolumePoint CollectDtmfConfig CombinedCost CombinedDashboardResponse ComponentAdminOut ComponentCreate ComponentOut ComponentStatusUpdate ComponentUpdate ConcurrencyResponse ContactImportCommitRequest ContactImportCommitResponse ContactImportInvalidRow ContactImportPreviewResponse ContactImportProgressError ContactImportProgressResponse ContributionDataPoint ConversationDynamicVariablesUpdateRequest ConversationLastMessage ConversationListResponse ConversationResponse ConversationSendRequest ConversationTurnSummary CreateWorkflowRequest DNCCheckResponse DNCEntryAddRequest DNCEntryListResponse DNCEntryResponse DNCSettingsRequest DNCSettingsResponse DashboardKPIs DayOfWeekDistribution DeepgramLanguage DeepgramNovaModel DeepgramTranscriberConfig DialFailureDetail DialRequest DialResponse EdgeCondition EmailSubscribeRequest ExchangeRateResponse FirstMessageConfig GraphData-Input GraphData-Output GroqModel GroqModelConfig HTTPValidationError HangupResponse HangupToolConfig HealthCheckResult HourlyDistribution ImportAccountRequest IncidentCreate IncidentOut IncidentUpdateCreate IncidentUpdateOut InitiateCallRequest InterruptionConfig InvitationResponse InvitationsListResponse InviteMemberRequest InvoiceListResponse InvoiceResponse KPIMetric KeyType KnowledgeBaseCreateFromText KnowledgeBaseCreateFromURL KnowledgeBaseListResponse KnowledgeBaseListResult KnowledgeBaseResponse KnowledgeBaseStatus KnowledgeBaseType KnowledgeBaseUpdate LatencyMetrics MaintenanceCreate MaintenanceOut MaintenanceUpdate ManualImportRequest MarkReadResponse McpExecuteRequest McpExecuteResult McpProbeResult McpServerCreate McpServerListResponse McpServerRef McpServerResponse McpServerUpdate McpTool McpValidateRequest MemberResponse MembersListResponse MessageListResponse MessageResponse NodePosition NodeType NotFoundError NotificationListResponse NotificationOut NumberAssignResponse NumberCapRow NumberCapsResponse NumberUnassignResponse OnboardingStatusResponse OpenAIModel OpenAIModelConfig OrgUsageItem OrganizationCreate OrganizationCredentialsUpdate OrganizationResponse OrganizationUpdate OutboundCampaignCreate OutboundCampaignResponse OutboundCampaignUpdate PaginationMetadata ParticipantInfo PaymentMethodListResponse PaymentMethodResponse Permission PhantomModelConfig PhantomTranscriberConfig PhantomVoiceConfig PhoneNumberCreate PhoneNumberListResponse PhoneNumberResponse PhoneNumberUpdate PipelineTurnDetection PipelineTurnDetectionMode PlaceOutboundCallConfig PlatformRevenueResponse PostCallConfig ProfileUpdate PublicIncidentReport PublishRequest RAGQueryRequest RAGQueryResponse RAGResult RagConfig RecordingConfig RecordingResponse RegisterAndAcceptRequest RoleType SaveGraphRequest SendAudioMessageConfig SendDtmfConfig SendMessageResponse SendTemplateMessageRequest SendTextRequest SendWhatsAppMessageConfig SentimentTimeline SentimentTurn SetupIntentResponse SlackSubscribeRequest SonioxModel SonioxTranscriberConfig SortOrder StatusOverview StripeCustomerRequest StripeCustomerResponse SuccessEvaluationRubric SupervisorJoinResponse SupervisorPermissions TTSTextTransform TemplateComponentResponse TemplateListResponse TemplateParam TemplateResponse ThinkingAudioConfig TimeRange TimeoutConfig TokenHealthResponse ToolChoice ToolsConfig TopUpIntentResponse TopUpRequest TransferConfig TransferDestination TransferMode TransferOnFail UnreadCountResponse UpdateAccountRequest UpdateMemberPermissionsRequest UpdateRoleRequest UpdateWorkflowRequest UsageMetrics UsageSummaryResponse ValidationError VariableCoverageStat VoiceFilterOptions VoiceListResponse VoiceLocalizeRequest VoiceResponse VoiceSessionListResponse VoiceSessionResponse VoiceSessionUpdate VoiceSyncResponse VoicemailAction VoicemailToolConfig WebhookConfig WebhookCreate WebhookCreateResponse WebhookDeliveryLogResponse WebhookDeliveryLogsResponse WebhookEvent WebhookEventTypeEnum WebhookListResponse WebhookResponse WebhookRotateSecretResponse WebhookTestRequest WebhookTestResponse WebhookUpdate WorkflowDetailResponse WorkflowEdge WorkflowListResponse WorkflowNode WorkflowResponse WorkflowRevisionResponse WorkflowRevisionStatus WorkingHoursConfig KnowledgeBaseFileUpload

ContactNeuratel Support[email protected]https://neuratel.ai/contact

Servers

https://api.neuratel.ai

Production