{ "name": "Deepgram Voice Agent API", "slug": "deepgram-voice-agent", "website_url": "https://deepgram.com/product/voice-agent-api", "vendor_description": "\"A single, unified conversational AI API for building enterprise-ready, cost-effective voice AI agents.\"", "categories": [ "voice-agents" ], "summary": "Deepgram Voice Agent API is a single WebSocket-based interface for building real-time voice AI agents, covering inbound and outbound telephony, function calling, interruption handling, and multi-agent orchestration, with SDKs for Python, Node.js, Go, and C#/.NET. Pricing is usage-based at $0.075 per minute with a one-time $200 trial credit and self-serve signup, scaling to enterprise plans with 100 or more concurrent connections. The platform holds SOC 2 Type 2, HIPAA, GDPR, and PCI DSS certifications and reached general availability in June 2025, with customers including NASA, IBM, Five9, and Aircall. Telephony requires Twilio or Amazon Connect for PSTN access, and the Growth plan carries a $4,000 per year minimum commitment.", "capabilities": { "supported_actions": [ "realtime_conversation", "speech_to_speech", "inbound_telephony", "outbound_telephony", "function_calling", "interruption_handling", "byo_llm", "byo_voice", "multi_agent_orchestration", "call_recording", "web_widget", "tool_calling", "message_injection", "dynamic_settings_update", "turn_taking_prediction", "barge_in_detection" ], "supported_regions": [ "United States", "European Union", "Australia" ], "supported_languages": [ "English", "Spanish", "French", "German", "Hindi", "Russian", "Portuguese", "Japanese", "Italian", "Dutch" ], "input_types": [ "audio stream", "WebSocket", "PSTN phone call (via Twilio)", "web widget" ], "output_types": [ "audio stream", "call transcript", "function call events", "WebSocket events", "structured call summary" ], "webhooks_supported": false, "sandbox_available": false, "sdk_languages": [ "Python", "Node.js", "Go", "C#/.NET" ], "mcp_server_available": true }, "integration": { "api_style": "websocket", "base_url": "wss://agent.deepgram.com/v1/agent/converse", "api_version": "v1", "versioning_scheme": "url", "stability": "ga", "deprecation_policy_url": null, "auth_methods": [ "api_key" ], "auth_docs_url": "https://developers.deepgram.com/reference/authentication", "idempotency_supported": null, "error_format": "vendor-specific", "webhook_signing": null, "webhook_events_url": null, "rate_limit_requests": 45, "rate_limit_window": "concurrent calls", "sdk_packages": [ { "package": "deepgram-sdk", "language": "Python", "official": true, "repo_url": "https://github.com/deepgram/deepgram-python-sdk" }, { "package": "@deepgram/sdk", "language": "Node.js", "official": true, "repo_url": "https://github.com/deepgram/deepgram-js-sdk" }, { "package": "github.com/deepgram/deepgram-go-sdk/v3", "language": "Go", "official": true, "repo_url": "https://github.com/deepgram/deepgram-go-sdk" }, { "package": "Deepgram", "language": "C#/.NET", "official": true, "repo_url": "https://github.com/deepgram/deepgram-dotnet-sdk" } ], "mcp_url": "https://developers.deepgram.com/_mcp/server", "quickstart_url": "https://developers.deepgram.com/docs/voice-agent" }, "pricing": { "pricing_model": "usage_based", "has_published_pricing": true, "starting_price_usd": "0.0750", "price_basis": "minute", "free_tier_available": false, "free_tier_limit": "$200 free credit", "free_tier_details": null, "minimum_commitment": null, "self_serve_signup": true, "requires_sales_call": false, "requires_verification": false, "enterprise_plan_available": true, "price_points": [ { "plan": "Pay As You Go", "item": "Voice agent orchestration (Standard — Deepgram STT + LLM + TTS)", "amount_usd": "0.0750", "amount_percent": null, "per": "minute", "currency": "USD", "source_url": "https://deepgram.com/pricing" }, { "plan": "Pay As You Go", "item": "Voice agent orchestration (Standard BYO TTS — Deepgram STT + LLM, bring-your-own TTS)", "amount_usd": "0.0650", "amount_percent": null, "per": "minute", "currency": "USD", "source_url": "https://deepgram.com/pricing" }, { "plan": "Pay As You Go", "item": "Voice agent orchestration (Custom BYO LLM — Deepgram STT + TTS, bring-your-own LLM)", "amount_usd": "0.0590", "amount_percent": null, "per": "minute", "currency": "USD", "source_url": "https://deepgram.com/pricing" }, { "plan": "Pay As You Go", "item": "Voice agent orchestration (Custom BYO LLM + TTS — Deepgram STT only, bring-your-own LLM and TTS)", "amount_usd": "0.0500", "amount_percent": null, "per": "minute", "currency": "USD", "source_url": "https://deepgram.com/pricing" }, { "plan": "Pay As You Go", "item": "Voice agent orchestration (Advanced — Deepgram STT + LLM + TTS, advanced tier)", "amount_usd": "0.1630", "amount_percent": null, "per": "minute", "currency": "USD", "source_url": "https://deepgram.com/pricing" }, { "plan": "Pay As You Go", "item": "Voice agent orchestration (Advanced BYO TTS — Deepgram STT + LLM advanced, bring-your-own TTS)", "amount_usd": "0.1220", "amount_percent": null, "per": "minute", "currency": "USD", "source_url": "https://deepgram.com/pricing" }, { "plan": "Growth", "item": "Voice agent orchestration (Standard — Deepgram STT + LLM + TTS)", "amount_usd": "0.0680", "amount_percent": null, "per": "minute", "currency": "USD", "source_url": "https://deepgram.com/pricing" }, { "plan": "Growth", "item": "Voice agent orchestration (Standard BYO TTS — Deepgram STT + LLM, bring-your-own TTS)", "amount_usd": "0.0510", "amount_percent": null, "per": "minute", "currency": "USD", "source_url": "https://deepgram.com/pricing" }, { "plan": "Growth", "item": "Voice agent orchestration (Custom BYO LLM + TTS — Deepgram STT only, bring-your-own LLM and TTS)", "amount_usd": "0.0410", "amount_percent": null, "per": "minute", "currency": "USD", "source_url": "https://deepgram.com/pricing" }, { "plan": "Growth", "item": "Voice agent orchestration (Advanced — Deepgram STT + LLM + TTS, advanced tier)", "amount_usd": "0.1460", "amount_percent": null, "per": "minute", "currency": "USD", "source_url": "https://deepgram.com/pricing" }, { "plan": "Growth", "item": "Voice agent orchestration (Advanced BYO TTS — Deepgram STT + LLM advanced, bring-your-own TTS)", "amount_usd": "0.1100", "amount_percent": null, "per": "minute", "currency": "USD", "source_url": "https://deepgram.com/pricing" } ] }, "compliance": { "soc2": "type_2", "hipaa": true, "gdpr": true, "iso_27001": false, "pci_dss": true, "sla_published": true, "sla_url": null, "data_retention_policy_url": "https://deepgram.com/privacy", "documented_rate_limits": "Voice Agent API: Pay As You Go - up to 45 concurrent connections (North America, Europe, Australia); Growth - up to 60 concurrent connections (North America), up to 45 (Europe/Australia); Enterprise - starting at 100 concurrent connections (all regions). Rate limits apply per project.", "known_restrictions": [ "Telephony (PSTN/inbound/outbound) requires integration with Twilio or Amazon Connect - not natively included", "BYO-LLM requires custom endpoint configuration for providers other than OpenAI and Anthropic (e.g. Google, Groq, AWS Bedrock)", "$200 free credit is a one-time trial credit, not a recurring free tier", "Flux STT model (optimized for voice agents) supports only 10 languages in multilingual mode (not all 45+ Nova-3 languages)", "System prompt limit of 25,000 characters for managed LLMs", "Growth plan requires $4,000+/year annual prepaid commitment", "SLA (99.9% uptime) is only published for dedicated/enterprise deployments, not standard Pay As You Go" ] }, "developer": { "docs_url": "https://developers.deepgram.com/home", "api_reference_url": null, "openapi_spec_url": null, "postman_collection_url": null, "changelog_url": "https://deepgram.com/changelog", "status_page_url": "https://status.deepgram.com", "llms_txt_url": "https://deepgram.com/llms.txt", "markdown_docs_url": null, "rendering": "static" }, "adoption": { "launched_at": "2015-01-01", "ga_date": "2025-06-16", "github_stars": null, "github_stars_at": null, "notable_customers": [ "Aircall", "Jack in the Box", "OpenPhone", "NASA", "Five9", "IBM", "Telnyx" ] }, "scores": { "agent_friendliness": 55, "pricing_transparency": 85, "setup_speed": 60, "docs_quality": 35, "procurement_friction": 85, "trust_readiness": 85, "best_for": [ "Regulated or enterprise workloads - compliance attestations and an enterprise plan", "AI agents and automation - an agent-ready surface (MCP / llms.txt)", "Teams needing broad API coverage out of the box" ], "avoid_if": [ "You want to try it free before paying" ] }, "sources": [ { "field": "categories", "url": "https://deepgram.com/product/voice-agent-api", "excerpt": "A single, unified conversational AI API for building enterprise-ready, cost-effective voice AI agents.", "confidence": "high" }, { "field": "categories", "url": "https://deepgram.com/product/speech-to-text", "excerpt": "Convert speech to text with unmatched accuracy, ultra-low latency, and enterprise scalability.", "confidence": "high" }, { "field": "pricing_model", "url": "https://deepgram.com/pricing", "excerpt": "Voice Agent API ranges from $0.050–$0.163/minute depending on tier and features (websocket connection time basis).", "confidence": "high" }, { "field": "free_tier_available", "url": "https://deepgram.com/pricing", "excerpt": "New users receive $200 free credit upon signup with no credit card required for the Pay As You Go plan.", "confidence": "high" }, { "field": "self_serve_signup", "url": "https://deepgram.com/pricing", "excerpt": "$200 Free Credit — no credit card required — then pay-as-you-go", "confidence": "high" }, { "field": "hipaa", "url": "https://developers.deepgram.com/trust-security/security-policy", "excerpt": "We maintain HIPAA Compliance and are PCI Compliant; thus, we adhere to the requirements throughout the year", "confidence": "high" }, { "field": "gdpr", "url": "https://developers.deepgram.com/trust-security/data-privacy-compliance", "excerpt": "Deepgram is GDPR ready.", "confidence": "high" }, { "field": "pci_dss", "url": "https://developers.deepgram.com/trust-security/security-policy", "excerpt": "We maintain HIPAA Compliance and are PCI Compliant; thus, we adhere to the requirements throughout the year", "confidence": "high" }, { "field": "sla_published", "url": "https://deepgram.com/dedicated", "excerpt": "99.9% uptime, backed by enterprise-grade SLAs", "confidence": "medium" }, { "field": "supported_languages", "url": "https://developers.deepgram.com/docs/models-languages-overview", "excerpt": "flux-general-multi supports English, Spanish, French, German, Hindi, Russian, Portuguese, Japanese, Italian, and Dutch", "confidence": "high" }, { "field": "supported_actions", "url": "https://developers.deepgram.com/docs/voice-agent-feature-overview", "excerpt": "Function Call Request and Function Call Response capabilities", "confidence": "high" }, { "field": "byo_voice", "url": "https://developers.deepgram.com/docs/voice-agent-tts-models", "excerpt": "The platform supports bring-your-own-voice integrations: OpenAI, ElevenLabs, Cartesia (Third-party), AWS Polly", "confidence": "high" }, { "field": "sdk_languages", "url": "https://developers.deepgram.com/home", "excerpt": "Python SDK, JavaScript SDK, Go SDK, .NET SDK — four primary SDK implementations listed", "confidence": "high" }, { "field": "supported_regions", "url": "https://developers.deepgram.com/trust-security/data-privacy-compliance", "excerpt": "GDPR ready with EU-specific endpoint at api.eu.deepgram.com … AU-specific endpoint at api.au.deepgram.com running on AWS Sydney infrastructure", "confidence": "high" }, { "field": "webhooks_supported", "url": "https://developers.deepgram.com/reference/voice-agent/voice-agent", "excerpt": "The Voice Agent API enables you to build real-time, interactive voice agents powered by Deepgram's speech-to-text, LLM integration, and text-to-speech, all over a single WebSocket connection.", "confidence": "medium" }, { "field": "auth_methods", "url": "https://developers.deepgram.com/reference/auth/tokens/grant", "excerpt": "The /v1/auth/grant endpoint generates temporary JWTs with a 30-second (by default) TTL ... usage::write permission for core voice APIs", "confidence": "high" }, { "field": "api_style", "url": "https://developers.deepgram.com/reference/voice-agent/voice-agent", "excerpt": "The Voice Agent API enables you to build real-time, interactive voice agents powered by Deepgram's speech-to-text, LLM integration, and text-to-speech, all over a single WebSocket connection.", "confidence": "high" }, { "field": "api_version", "url": "https://developers.deepgram.com/reference/voice-agent/voice-agent", "excerpt": "API Version: v1 (subpackage_agent/v1.agent.v1) ... AsyncAPI 2.6.0 specification", "confidence": "high" }, { "field": "stability", "url": "https://www.businesswire.com/news/home/20250616867923/en/Deepgram-Launches-Voice-Agent-API-Worlds-Only-Enterprise-Ready-Real-Time-and-Cost-Effective-Conversational-AI-API", "excerpt": "Deepgram Launches Voice Agent API: World's Only Enterprise-Ready, Real-Time, and Cost-Effective Conversational AI API — announced as General Availability on June 16, 2025", "confidence": "high" }, { "field": "vendor_description", "url": "https://deepgram.com/product/voice-agent-api", "excerpt": "A single, unified conversational AI API for building enterprise-ready, cost-effective voice AI agents.", "confidence": "high" }, { "field": "categories", "url": "https://deepgram.com/product/text-to-speech", "excerpt": "Enterprise Text-to-Speech API for Real-Time Voice AI — $0.030 per 1,000 characters", "confidence": "high" }, { "field": "primary_use_cases", "url": "https://deepgram.com/product/voice-agent-api", "excerpt": "One API that combines speech-to-text, LLM orchestration, and text-to-speech in real time", "confidence": "high" }, { "field": "has_published_pricing", "url": "https://deepgram.com/pricing", "excerpt": "Standard: $0.075/min … Custom - BYO LLM + TTS: $0.050/min … Advanced: $0.163/min", "confidence": "high" }, { "field": "sandbox_available", "url": "https://deepgram.com/product/voice-agent-api", "excerpt": "Free trial option: \"Try it Free\" links to the playground — this is a live environment trial, not a dedicated sandbox or test-mode environment.", "confidence": "high" }, { "field": "soc2", "url": "https://developers.deepgram.com/trust-security/data-privacy-compliance", "excerpt": "Deepgram has achieved SOC 2 Type 1 and Type 2 certification.", "confidence": "high" }, { "field": "hipaa", "url": "https://developers.deepgram.com/trust-security/data-privacy-compliance", "excerpt": "Deepgram is considered a Business Associate as defined by the US HIPAA legislation.", "confidence": "high" }, { "field": "iso_27001", "url": "https://developers.deepgram.com/trust-security/data-privacy-compliance", "excerpt": "Deepgram has achieved SOC 2 Type 1 and Type 2 certification. [ISO 27001 is not mentioned on this page or the security policy page.]", "confidence": "high" }, { "field": "pci_dss", "url": "https://developers.deepgram.com/trust-security/data-privacy-compliance", "excerpt": "We are PCI compliant, and perform a yearly review of our standing within the framework.", "confidence": "high" }, { "field": "documented_rate_limits", "url": "https://developers.deepgram.com/reference/api-rate-limits", "excerpt": "Pay as You Go: Up to 45 concurrent connections (North America, Europe, Australia); Growth: North America Up to 60 concurrent connections, Europe/Australia Up to 45; Enterprise: Starting at 100 concurrent connections", "confidence": "high" }, { "field": "supported_actions", "url": "https://deepgram.com/product/voice-agent-api", "excerpt": "Built-in barge-in detection, turn-taking prediction, function calling, and mid-session control for smooth interactions without pauses or interruptions.", "confidence": "high" }, { "field": "byo_llm", "url": "https://deepgram.com/product/voice-agent-api", "excerpt": "Easily integrate your own LLM or TTS provider while retaining Deepgram's orchestration, streaming pipeline, and real-time responsiveness.", "confidence": "high" }, { "field": "mcp_server_available", "url": "https://developers.deepgram.com/developer-tools/cli/mcp-server", "excerpt": "The dg CLI includes a built-in MCP server that gives AI coding tools direct access to Deepgram APIs.", "confidence": "high" }, { "field": "enterprise_plan_available", "url": "https://deepgram.com/pricing", "excerpt": "Enterprise: Custom pricing for large-volume deployments", "confidence": "high" }, { "field": "minimum_commitment", "url": "https://deepgram.com/pricing", "excerpt": "Growth: Up to 20% savings with annual pre-paid credits (minimum $4K/year)", "confidence": "high" }, { "field": "auth_methods", "url": "https://developers.deepgram.com/reference/authentication", "excerpt": "The primary authentication method uses an API Key included in request headers: Authorization: Token . All API requests must be made over HTTPS.", "confidence": "high" }, { "field": "auth_docs_url", "url": "https://developers.deepgram.com/reference/authentication", "excerpt": "Authentication | Deepgram's Docs — API Key authentication via Authorization: Token ", "confidence": "high" }, { "field": "base_url", "url": "https://developers.deepgram.com/reference/voice-agent/voice-agent", "excerpt": "Base URL: wss://agent.deepgram.com/ — WebSocket Endpoint: /v1/agent/converse", "confidence": "high" }, { "field": "versioning_scheme", "url": "https://developers.deepgram.com/reference/voice-agent/voice-agent", "excerpt": "WebSocket Endpoint: /v1/agent/converse — version is embedded in the URL path", "confidence": "high" }, { "field": "stability", "url": "https://deepgram.com/learn/deepgram-launches-voice-agent-api", "excerpt": "General Availability (GA) Date: June 16, 2025", "confidence": "high" }, { "field": "sdk_packages", "url": "https://github.com/deepgram/deepgram-js-sdk", "excerpt": "Official JavaScript SDK for Deepgram. npm package: @deepgram/sdk. Full support for building interactive voice agents.", "confidence": "high" }, { "field": "sdk_packages", "url": "https://github.com/deepgram/deepgram-dotnet-sdk", "excerpt": "Official .NET SDK for Deepgram. NuGet package: Deepgram. dotnet add package Deepgram", "confidence": "high" }, { "field": "sdk_packages", "url": "https://github.com/deepgram/deepgram-python-sdk", "excerpt": "Official Python SDK for Deepgram. Package: deepgram-sdk (PyPI). Voice Agent support via client.agent.v1.connect() method.", "confidence": "high" }, { "field": "sdk_packages", "url": "https://github.com/deepgram/deepgram-go-sdk", "excerpt": "Official Go SDK for Deepgram. Module: github.com/deepgram/deepgram-go-sdk/v3. Includes Voice Agent functionality through WebSocket connections.", "confidence": "high" }, { "field": "mcp_url", "url": "https://developers.deepgram.com/developer-tools/cli/mcp-server", "excerpt": "Server Endpoint: https://developers.deepgram.com/_mcp/server ... The dg CLI includes a built-in MCP (Model Context Protocol) server that gives AI coding tools direct access to Deepgram APIs.", "confidence": "high" }, { "field": "error_format", "url": "https://developers.deepgram.com/reference/voice-agent/voice-agent", "excerpt": "Messages include type: \"Error\" with description and code fields. Example: {\"type\": \"Error\", \"description\": \"Details about what went wrong\", \"code\": \"Error code identifier\"}", "confidence": "high" }, { "field": "rate_limit_requests", "url": "https://deepgram.com/learn/tripling-default-concurrency-to-power-the-voice-ai-economy", "excerpt": "Deepgram increased default concurrency limits by up to 3X for Voice Agent for Pay as you Go, Growth, and Enterprise plans. You can now run 45+ concurrent agents with headroom for traffic spikes.", "confidence": "high" }, { "field": "requires_verification", "url": "https://deepgram.com/pricing", "excerpt": "$200 Free Credit — no credit card required — then pay-as-you-go", "confidence": "high" }, { "field": "price_basis", "url": "https://deepgram.com/pricing", "excerpt": "Voice Agent API Pricing — Standard: $0.075/min → $0.068/min (Growth)", "confidence": "high" }, { "field": "launched_at", "url": "https://www.ycombinator.com/companies/deepgram", "excerpt": "Deepgram was founded on August 18, 2015 ... went through Y Combinator in the winter 2016 batch", "confidence": "high" }, { "field": "notable_customers", "url": "https://deepgram.com/learn/deepgram-launches-voice-agent-api", "excerpt": "Notable Customers: Aircall, Jack in the Box, StreamIt, and OpenPhone are building voice agents with Deepgram.", "confidence": "high" }, { "field": "data_retention_policy_url", "url": "https://deepgram.com/privacy", "excerpt": "Any Customer Data that we have access to shall be retained, stored, and deleted according to our agreement with our business customer. We will retain your personal information for the length of time needed to fulfill our business purposes unless otherwise required or permitted by law.", "confidence": "medium" }, { "field": "quickstart_url", "url": "https://developers.deepgram.com/docs/voice-agent", "excerpt": "Getting Started | Deepgram's Docs — Build a Voice Agent: step-by-step guide to creating your first voice agent with Python, JavaScript, C#, or Go", "confidence": "high" }, { "field": "rate_limit_requests", "url": "https://developers.deepgram.com/reference/api-rate-limits", "excerpt": "Voice Agent API — Pay As You Go: Up to 45 concurrent connections across all regions; Growth: North America gets 60; Enterprise: Starting at 100 concurrent connections", "confidence": "high" }, { "field": "rate_limit_window", "url": "https://developers.deepgram.com/reference/api-rate-limits", "excerpt": "Concurrency rate limits define the maximum number of API requests you can make in a given time frame ... limits are scoped to a project with one customer mapping to one project.", "confidence": "high" }, { "field": "starting_price_usd", "url": "https://deepgram.com/pricing", "excerpt": "Voice Agent API Pricing — Standard: $0.075/min (Pay As You Go); Standard BYO TTS: $0.065/min; Advanced: $0.163/min", "confidence": "high" }, { "field": "free_tier_limit", "url": "https://deepgram.com/pricing", "excerpt": "$200 Free Credit — no credit card required", "confidence": "high" }, { "field": "ga_date", "url": "https://www.businesswire.com/news/home/20250616867923/en/Deepgram-Launches-Voice-Agent-API-Worlds-Only-Enterprise-Ready-Real-Time-and-Cost-Effective-Conversational-AI-API", "excerpt": "Deepgram Launches Voice Agent API: World's Only Enterprise-Ready, Real-Time, and Cost-Effective Conversational AI API — June 16, 2025", "confidence": "high" }, { "field": "notable_customers", "url": "https://deepgram.com/customers", "excerpt": "NASA uses Deepgram to power the next generation of space tech ... Five9 revolutionizing contact center AI ... IBM showcased in customer roster", "confidence": "high" } ], "fields_not_found": [ "iso_27001 (trust page does not mention ISO 27001 certification)", "webhooks_supported (no explicit webhook/event-callback docs found; events are delivered over WebSocket)", "Growth plan Custom BYO LLM per-minute price (not published on pricing page)", "deprecation_policy_url", "sla_url", "idempotency_supported", "webhook_signing", "webhook_events_url" ], "source_confidence": "high", "last_verified_at": "2026-06-21T00:00:00.000Z", "contribute": { "note": "This data is crowd-editable. Suggest corrections or leave a review via these endpoints - no auth required, requests are rate-limited, and every submission is reviewed before it goes live. For a field edit, {field} is any key in this response and a citation is required.", "endpoints": [ { "action": "review", "label": "Leave a review or comment", "method": "POST", "url": "https://apio.sh/api/feedback/deepgram-voice-agent", "example_body": { "kind": "review", "rating": 5, "body": "Your experience with this API…" } }, { "action": "field_edit", "label": "Suggest a correction to a field (cite a source)", "method": "POST", "url": "https://apio.sh/api/suggest/deepgram-voice-agent/{field}", "example_body": { "value": "corrected value", "citations": [ { "url": "https://source.example/page", "excerpt": "supporting quote" } ], "note": "what changed and why" } }, { "action": "new_api", "label": "Suggest a new API to add (only name is required - send as much as you can cite)", "method": "POST", "url": "https://apio.sh/api/suggest/api", "example_body": { "value": { "name": "Acme Email API", "website_url": "https://acme.example", "vendor_name": "Acme", "categories": [ "email" ], "pricing_model": "usage_based", "has_published_pricing": true, "free_tier_available": true, "price_points": [ { "plan": "Pay as you go", "item": "1,000 emails", "amount_usd": 1, "per": "1,000 emails", "source_url": "https://acme.example/pricing" } ], "soc2": "type_2", "docs_url": "https://docs.acme.example" }, "citations": [ { "url": "https://acme.example/pricing", "excerpt": "$1 per 1,000 emails" } ] }, "value_schema": [ { "field": "name", "type": "string", "label": "Product name (the only required field)" }, { "field": "website_url", "type": "string", "label": "Marketing website URL" }, { "field": "vendor_name", "type": "string", "label": "Company/vendor name behind the product" }, { "field": "vendor_description", "type": "string", "label": "One-line description, quoted from the vendor" }, { "field": "categories", "type": "string[]", "label": "Category/leaf slugs it belongs to, e.g. [\"email\",\"sms\"]" }, { "field": "primary_use_cases", "type": "string[]", "label": "What it's used for" }, { "field": "supported_actions", "type": "string[]", "label": "Concrete API actions/capabilities" }, { "field": "supported_regions", "type": "string[]", "label": "Countries/regions/data-residency" }, { "field": "supported_languages", "type": "string[]", "label": "Human/spoken languages supported" }, { "field": "input_types", "type": "string[]", "label": "Accepted input types/formats" }, { "field": "output_types", "type": "string[]", "label": "Produced output types/formats" }, { "field": "webhooks_supported", "type": "bool", "label": "Supports webhooks?" }, { "field": "sandbox_available", "type": "bool", "label": "Dedicated sandbox/test mode?" }, { "field": "sdk_languages", "type": "string[]", "label": "Languages with an official SDK" }, { "field": "mcp_server_available", "type": "bool", "label": "Official MCP server?" }, { "field": "pricing_model", "type": "enum", "label": "Pricing model", "values": [ "usage_based", "subscription", "seat_based", "hybrid", "contact_sales" ] }, { "field": "has_published_pricing", "type": "bool", "label": "Concrete prices published publicly?" }, { "field": "free_tier_available", "type": "bool", "label": "Recurring/perpetual free tier (not a trial)?" }, { "field": "free_tier_details", "type": "string", "label": "What the free tier includes" }, { "field": "minimum_commitment", "type": "string", "label": "Any stated minimum spend/commitment" }, { "field": "self_serve_signup", "type": "bool", "label": "Get an API key without talking to sales?" }, { "field": "requires_sales_call", "type": "bool", "label": "Does going live require sales?" }, { "field": "enterprise_plan_available", "type": "bool", "label": "Named enterprise tier?" }, { "field": "starting_price_usd", "type": "number", "label": "Lowest published paid entry price (USD number)" }, { "field": "price_basis", "type": "string", "label": "Unit the starting price is per, e.g. '1,000 emails'" }, { "field": "free_tier_limit", "type": "string", "label": "Free-tier ceiling in literal terms" }, { "field": "price_points", "type": "object[]", "label": "Structured prices: [{plan,item,amount_usd,amount_percent,per,source_url}]" }, { "field": "soc2", "type": "enum", "label": "SOC 2 status", "values": [ "type_2", "type_1", "in_progress", "none", "unknown" ] }, { "field": "hipaa", "type": "bool", "label": "HIPAA (e.g. BAA available)?" }, { "field": "gdpr", "type": "bool", "label": "GDPR compliance stated?" }, { "field": "iso_27001", "type": "bool", "label": "ISO 27001 certified?" }, { "field": "pci_dss", "type": "bool", "label": "PCI DSS compliant?" }, { "field": "sla_published", "type": "bool", "label": "Published SLA / uptime commitment?" }, { "field": "documented_rate_limits", "type": "string", "label": "Documented rate limits, quoted" }, { "field": "known_restrictions", "type": "string[]", "label": "Notable documented restrictions/limits" }, { "field": "auth_methods", "type": "string[]", "label": "Auth methods", "values": [ "api_key", "oauth2", "jwt", "basic", "hmac_signature", "mtls", "session" ] }, { "field": "api_style", "type": "enum", "label": "Primary API style", "values": [ "rest", "graphql", "grpc", "soap", "websocket" ] }, { "field": "base_url", "type": "string", "label": "API root/base URL" }, { "field": "api_version", "type": "string", "label": "Current API version string" }, { "field": "quickstart_url", "type": "string", "label": "Quickstart / hello-world URL" }, { "field": "docs_url", "type": "string", "label": "Developer docs URL" }, { "field": "api_reference_url", "type": "string", "label": "API reference URL" }, { "field": "openapi_spec_url", "type": "string", "label": "OpenAPI spec URL" }, { "field": "changelog_url", "type": "string", "label": "Changelog URL" }, { "field": "status_page_url", "type": "string", "label": "Status page URL" }, { "field": "notable_customers", "type": "string[]", "label": "Named public customers" }, { "field": "launched_at", "type": "string", "label": "Launch date (ISO date or year)" } ] }, { "action": "token", "label": "Optional - raise your rate limit", "method": "GET", "url": "https://apio.sh/api/feedback/token" } ] } }