{ "name": "OpenAI Realtime API (gpt-realtime)", "slug": "openai-realtime", "website_url": "https://platform.openai.com/docs/guides/realtime", "vendor_description": "\"The Realtime API enables low-latency, bidirectional audio communication for building voice agents and audio applications.\"", "categories": [ "voice-agents" ], "summary": "OpenAI Realtime API is a WebSocket-based service for low-latency, bidirectional speech-to-speech communication, targeting developers building voice agents, real-time translation, live transcription, and call center automation. Pricing is usage-based starting at $0.0192 per minute of audio input, with self-serve signup and no sales call required. The API supports function calling, voice activity detection, interruption handling, and inbound SIP telephony via a third-party carrier. It holds SOC 2 Type II, HIPAA, GDPR, ISO 27001, and PCI DSS certifications, with SDKs available for Python, Node.js, Go, Java, Ruby, and .NET.", "capabilities": { "supported_actions": [ "realtime_conversation", "speech_to_speech", "inbound_telephony", "sip_trunking", "call_transfer", "function_calling", "tool_calling", "interruption_handling", "voice_activity_detection", "live_transcription", "realtime_translation", "mcp_server_integration", "websocket_streaming", "webrtc_streaming", "call_recording", "webhook_events", "reasoning_effort_control" ], "supported_regions": [ "North Europe", "South Central US", "East US 2", "West US", "EU Data Residency" ], "supported_languages": [ "English", "Mandarin", "Spanish", "French", "German", "Japanese", "Korean", "Portuguese", "Arabic", "Hindi", "Russian", "Italian", "Indonesian", "70+ additional input languages via Whisper-based transcription (gpt-realtime-whisper)", "70+ input languages for translation via gpt-realtime-translate (output to 13 languages listed above)" ], "input_types": [ "audio stream (WebRTC)", "audio stream (WebSocket)", "SIP phone call", "text" ], "output_types": [ "audio stream", "text transcript", "tool call results", "webhook events", "session events" ], "webhooks_supported": true, "sandbox_available": false, "sdk_languages": [ "Python", "Node.js", ".NET", "Java", "Go", "Ruby", "Python (Agents SDK)", "Node.js (Agents SDK)" ], "mcp_server_available": true }, "integration": { "api_style": "websocket", "base_url": "wss://api.openai.com/v1/realtime", "api_version": "gpt-realtime-2025-08-28", "versioning_scheme": "url", "stability": "ga", "deprecation_policy_url": "https://developers.openai.com/api/docs/deprecations", "auth_methods": [ "api_key" ], "auth_docs_url": "https://developers.openai.com/api/reference/overview", "idempotency_supported": false, "error_format": "vendor-specific", "webhook_signing": null, "webhook_events_url": null, "rate_limit_requests": null, "rate_limit_window": null, "sdk_packages": [ { "package": "openai", "language": "Python", "official": true, "repo_url": "https://github.com/openai/openai-python" }, { "package": "openai", "language": "Node.js", "official": true, "repo_url": "https://github.com/openai/openai-node" }, { "package": "OpenAI", "language": ".NET", "official": true, "repo_url": "https://github.com/openai/openai-dotnet" }, { "package": "openai-java", "language": "Java", "official": true, "repo_url": "https://github.com/openai/openai-java" }, { "package": "openai-go", "language": "Go", "official": true, "repo_url": "https://github.com/openai/openai-go" }, { "package": "openai", "language": "Ruby", "official": true, "repo_url": "https://github.com/openai/openai-ruby" }, { "package": "openai-agents", "language": "Python (Agents SDK)", "official": true, "repo_url": "https://github.com/openai/openai-agents-python" }, { "package": "openai-agents-js", "language": "Node.js (Agents SDK)", "official": true, "repo_url": "https://github.com/openai/openai-agents-js" } ], "mcp_url": "https://developers.openai.com/mcp", "quickstart_url": "https://developers.openai.com/api/docs/guides/voice-agents" }, "pricing": { "pricing_model": "usage_based", "has_published_pricing": true, "starting_price_usd": "0.0192", "price_basis": "minute (audio input)", "free_tier_available": false, "free_tier_limit": null, "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": "gpt-realtime-2", "item": "Audio input tokens", "amount_usd": "32.0000", "amount_percent": null, "per": "1M tokens", "currency": "USD", "source_url": "https://developers.openai.com/api/docs/pricing" }, { "plan": "gpt-realtime-2", "item": "Audio input tokens (cached)", "amount_usd": "0.4000", "amount_percent": null, "per": "1M tokens", "currency": "USD", "source_url": "https://developers.openai.com/api/docs/pricing" }, { "plan": "gpt-realtime-2", "item": "Audio output tokens", "amount_usd": "64.0000", "amount_percent": null, "per": "1M tokens", "currency": "USD", "source_url": "https://developers.openai.com/api/docs/pricing" }, { "plan": "gpt-realtime-2", "item": "Text input tokens", "amount_usd": "4.0000", "amount_percent": null, "per": "1M tokens", "currency": "USD", "source_url": "https://developers.openai.com/api/docs/models/gpt-realtime-2" }, { "plan": "gpt-realtime-2", "item": "Text input tokens (cached)", "amount_usd": "0.4000", "amount_percent": null, "per": "1M tokens", "currency": "USD", "source_url": "https://developers.openai.com/api/docs/models/gpt-realtime-2" }, { "plan": "gpt-realtime-2", "item": "Text output tokens", "amount_usd": "24.0000", "amount_percent": null, "per": "1M tokens", "currency": "USD", "source_url": "https://developers.openai.com/api/docs/models/gpt-realtime-2" }, { "plan": "gpt-realtime-2", "item": "Image input tokens", "amount_usd": "5.0000", "amount_percent": null, "per": "1M tokens", "currency": "USD", "source_url": "https://developers.openai.com/api/docs/models/gpt-realtime-2" }, { "plan": "gpt-realtime-2", "item": "Image input tokens (cached)", "amount_usd": "0.5000", "amount_percent": null, "per": "1M tokens", "currency": "USD", "source_url": "https://developers.openai.com/api/docs/models/gpt-realtime-2" }, { "plan": "gpt-realtime-mini", "item": "Text input tokens", "amount_usd": "0.6000", "amount_percent": null, "per": "1M tokens", "currency": "USD", "source_url": "https://developers.openai.com/api/docs/models/gpt-realtime-mini" }, { "plan": "gpt-realtime-mini", "item": "Text input tokens (cached)", "amount_usd": "0.0600", "amount_percent": null, "per": "1M tokens", "currency": "USD", "source_url": "https://developers.openai.com/api/docs/models/gpt-realtime-mini" }, { "plan": "gpt-realtime-mini", "item": "Text output tokens", "amount_usd": "2.4000", "amount_percent": null, "per": "1M tokens", "currency": "USD", "source_url": "https://developers.openai.com/api/docs/models/gpt-realtime-mini" }, { "plan": "gpt-realtime-translate", "item": "Audio translation output", "amount_usd": "0.0340", "amount_percent": null, "per": "minute", "currency": "USD", "source_url": "https://developers.openai.com/api/docs/pricing" }, { "plan": "gpt-realtime-whisper", "item": "Audio transcription output", "amount_usd": "0.0170", "amount_percent": null, "per": "minute", "currency": "USD", "source_url": "https://developers.openai.com/api/docs/pricing" } ] }, "compliance": { "soc2": "type_2", "hipaa": true, "gdpr": true, "iso_27001": true, "pci_dss": true, "sla_published": true, "sla_url": "https://openai.com/api-scale-tier/", "data_retention_policy_url": "https://developers.openai.com/api/docs/guides/your-data", "documented_rate_limits": "gpt-realtime-2: Tier 1–5 scaling from 200–20,000 RPM and 40,000–15,000,000 TPM; audio billed at 1 token per 100ms input, 1 token per 50ms output. gpt-realtime-translate: 50–850 audio-minutes per minute depending on tier.", "known_restrictions": [ "SIP support is inbound calls only (no outbound SIP calling)", "SIP requires a third-party SIP trunking provider (e.g. Twilio) - telephony is BYO carrier, not included", "gpt-realtime-translate and gpt-realtime-whisper support only translation/transcription session types, not full voice-agent conversations", "No BYO-LLM or BYO-voice support - only OpenAI models available", "No sandbox/test environment - live API keys required from the start", "SLA (99.9% uptime) is only available to Scale Tier / enterprise customers, not standard pay-as-you-go users", "Beta interface deprecated September 15, 2025; GA interface requires updated headers and event shapes" ] }, "developer": { "docs_url": "https://developers.openai.com/api/docs", "api_reference_url": "https://platform.openai.com/api/reference/overview", "openapi_spec_url": null, "postman_collection_url": null, "changelog_url": null, "status_page_url": null, "llms_txt_url": null, "markdown_docs_url": "https://platform.openai.com/docs/guides/realtime.md", "rendering": "static" }, "adoption": { "launched_at": "2024-10-01", "ga_date": "2025-08-28", "github_stars": null, "github_stars_at": null, "notable_customers": [ "Perplexity", "Healthify", "Speak", "Zillow", "Genspark" ] }, "scores": { "agent_friendliness": 50, "pricing_transparency": 85, "setup_speed": 60, "docs_quality": 50, "procurement_friction": 85, "trust_readiness": 100, "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://developers.openai.com/api/docs/guides/realtime", "excerpt": "The Realtime API enables low-latency, bidirectional audio communication for building voice agents and audio applications.", "confidence": "high" }, { "field": "supported_actions", "url": "https://developers.openai.com/api/docs/guides/realtime", "excerpt": "SIP: Use for telephony voice agents. WebRTC: Use for browser and mobile clients that capture or play audio directly. WebSocket: Use when your server already receives raw audio from a media pipeline.", "confidence": "high" }, { "field": "supported_languages", "url": "https://developers.openai.com/api/docs/models/gpt-realtime-translate", "excerpt": "a streaming speech-to-speech translation model for live multilingual audio experiences", "confidence": "medium" }, { "field": "pricing_model", "url": "https://developers.openai.com/api/docs/pricing", "excerpt": "gpt-realtime-2 Audio Input: $32.00 per 1M tokens; Audio Output: $64.00 per 1M tokens; gpt-realtime-translate: $0.034 / minute; gpt-realtime-whisper: $0.017 / minute", "confidence": "high" }, { "field": "has_published_pricing", "url": "https://developers.openai.com/api/docs/pricing", "excerpt": "gpt-realtime-2 Audio Input: $32.00 per 1M tokens; Audio Output: $64.00 per 1M tokens; Cached Audio Input: $0.40 per 1M tokens", "confidence": "high" }, { "field": "hipaa", "url": "https://help.openai.com/en/articles/8660679-how-can-i-get-a-business-associate-agreement-baa-with-openai", "excerpt": "OpenAI is able to sign Business Associate Agreements (BAA) in support of customers' compliance with the Health Insurance Portability and Accountability Act (HIPAA).", "confidence": "high" }, { "field": "iso_27001", "url": "https://trust.openai.com/", "excerpt": "ISO/IEC 27001:2022: Certified for API, ChatGPT Enterprise, and ChatGPT Edu; ISO/IEC 27017:2015, ISO/IEC 27018:2019, ISO/IEC 27701:2019", "confidence": "high" }, { "field": "sla_published", "url": "https://openai.com/api-scale-tier/", "excerpt": "OpenAI's Scale Tier traffic offers a 99.9% uptime SLA and prioritized compute. Priority processing SLAs are treated the same as Scale Tier SLAs, with service credits offered should they fail to meet those SLAs for customers on enterprise agreements.", "confidence": "medium" }, { "field": "documented_rate_limits", "url": "https://developers.openai.com/api/docs/models/gpt-realtime-translate", "excerpt": "Rate Limits vary by tier, ranging from 50 to 850 minutes of audio per minute depending on your usage tier.", "confidence": "high" }, { "field": "known_restrictions", "url": "https://openai.com/api-scale-tier/", "excerpt": "OpenAI's Scale Tier traffic offers a 99.9% uptime SLA and prioritized compute for customers on enterprise agreements.", "confidence": "high" }, { "field": "mcp_server_available", "url": "https://developers.openai.com/api/docs/guides/realtime", "excerpt": "Realtime with tools guide covers Connect function tools, MCP servers, and connectors to a Realtime session.", "confidence": "high" }, { "field": "supported_regions", "url": "https://developers.openai.com/api/docs/guides/realtime-sip", "excerpt": "For allowlisting OpenAI SIP traffic, dedicated IP ranges are provided for: northeurope: 13.79.45.80/28, southcentralus: 23.98.140.64/28, eastus2: 40.67.149.176/28, westus: 40.83.204.240/28", "confidence": "high" }, { "field": "input_types", "url": "https://developers.openai.com/api/docs/guides/realtime", "excerpt": "WebRTC: Use for browser and mobile clients that capture or play audio directly. WebSocket: Use when your server already receives raw audio from a media pipeline. SIP: Use for telephony voice agents.", "confidence": "high" }, { "field": "api_style", "url": "https://developers.openai.com/api/docs/guides/realtime", "excerpt": "Connection Methods: WebRTC for browser/mobile clients; WebSocket for server-side audio pipelines; SIP for telephony integration", "confidence": "high" }, { "field": "auth_methods", "url": "https://developers.openai.com/api/docs/guides/realtime-websocket", "excerpt": "Standard Bearer token in Authorization header: \"Authorization: Bearer \" + OPENAI_API_KEY", "confidence": "high" }, { "field": "auth_docs_url", "url": "https://developers.openai.com/api/reference/overview", "excerpt": "Authentication Methods: API Keys, Workload Identity Federation: Short-lived access tokens for production deployments", "confidence": "high" }, { "field": "stability", "url": "https://developers.openai.com/api/docs/guides/realtime", "excerpt": "Stability: GA (General Availability) - beta interface deprecated. Remove the OpenAI-Beta: realtime=v1 header for the current GA interface.", "confidence": "high" }, { "field": "deprecation_policy_url", "url": "https://developers.openai.com/api/docs/deprecations", "excerpt": "At least 6 months for generally available models; at least 3 months for specialized variants. The Realtime API Beta was deprecated on September 15, 2025, and shut down on May 12, 2026.", "confidence": "high" }, { "field": "mcp_url", "url": "https://developers.openai.com/api/docs/guides/realtime-mcp", "excerpt": "Official OpenAI MCP Server: https://developers.openai.com/mcp — exposes tools like search_openai_docs and fetch_openai_doc", "confidence": "medium" }, { "field": "idempotency_supported", "url": "https://developers.openai.com/api/reference/overview", "excerpt": "X-Client-Request-Id headers (user-supplied, max 512 ASCII characters) for request tracking... enables correlation during failures... differs from traditional idempotency keys", "confidence": "medium" }, { "field": "data_retention_policy_url", "url": "https://developers.openai.com/api/docs/guides/your-data", "excerpt": "abuse monitoring logs are generated for all API feature usage and retained for up to 30 days unless longer retention is legally required. Audio outputs: Retained for 1 hour to support multi-turn functionality.", "confidence": "high" }, { "field": "starting_price_usd", "url": "https://developers.openai.com/api/docs/guides/realtime-costs", "excerpt": "Audio tokens in user messages are 1 token per 100 ms of audio, while audio tokens in assistant messages are 1 token per 50ms.", "confidence": "high" }, { "field": "launched_at", "url": "https://openai.com/index/introducing-the-realtime-api/", "excerpt": "OpenAI announced the API in public beta on October 1, 2024 at its annual developer conference in San Francisco", "confidence": "high" }, { "field": "ga_date", "url": "https://community.openai.com/t/introducing-gpt-realtime-and-realtime-api-updates-for-production-voice-agents/1355039", "excerpt": "Introducing gpt-realtime and Realtime API updates for production voice agents — announced August 28, 2025", "confidence": "high" }, { "field": "vendor_description", "url": "https://developers.openai.com/api/docs/guides/realtime", "excerpt": "The Realtime API enables low-latency, bidirectional audio communication for building voice agents and audio applications.", "confidence": "high" }, { "field": "categories", "url": "https://developers.openai.com/api/docs/models", "excerpt": "GPT-Realtime-Whisper: Streaming speech-to-text model for realtime transcription; GPT-Realtime-Translate: Streaming speech-to-speech translation model", "confidence": "high" }, { "field": "supported_actions", "url": "https://developers.openai.com/api/docs/guides/realtime-sip", "excerpt": "The Realtime API supports inbound phone calls through SIP (Session Initiation Protocol). A SIP trunking provider converts telephone calls to IP traffic, which OpenAI routes to the Realtime API via a webhook system.", "confidence": "high" }, { "field": "supported_languages", "url": "https://community.openai.com/t/new-realtime-voice-models-in-the-api/1380471", "excerpt": "GPT-Realtime-Translate translates speech from 70+ input languages into 13 output languages while keeping pace with the speaker.", "confidence": "medium" }, { "field": "pricing_model", "url": "https://developers.openai.com/api/docs/models/gpt-realtime-2", "excerpt": "Audio Input: $32.00; Cached input: $0.40; Audio Output: $64.00; Text Input: $4.00; Text Output: $24.00 per 1M tokens", "confidence": "high" }, { "field": "soc2", "url": "https://trust.openai.com/", "excerpt": "SOC 2 Type 2: Our products are covered in our SOC 2 Type 2 report and have been evaluated by an independent third-party auditor.", "confidence": "high" }, { "field": "gdpr", "url": "https://trust.openai.com/", "excerpt": "GDPR: Listed as certified", "confidence": "high" }, { "field": "pci_dss", "url": "https://trust.openai.com/", "excerpt": "PCI DSS v4.0.1: Covers payment processing components", "confidence": "high" }, { "field": "documented_rate_limits", "url": "https://developers.openai.com/api/docs/models/gpt-realtime-2", "excerpt": "Tier 1: 200 RPM / 40,000 TPM; Tier 2: 400 RPM / 200,000 TPM; Tier 3: 5,000 RPM / 800,000 TPM; Tier 4: 10,000 RPM / 4,000,000 TPM; Tier 5: 20,000 RPM / 15,000,000 TPM", "confidence": "high" }, { "field": "known_restrictions", "url": "https://developers.openai.com/api/docs/guides/realtime-sip", "excerpt": "Currently supported: Inbound calls only. A SIP trunking provider converts telephone calls to IP traffic.", "confidence": "high" }, { "field": "sdk_languages", "url": "https://developers.openai.com/api/docs/libraries", "excerpt": "OpenAI provides official SDKs for JavaScript/TypeScript, Python, .NET/C# (developed in collaboration with Microsoft), Java (beta), Go (beta), and Ruby.", "confidence": "high" }, { "field": "webhooks_supported", "url": "https://developers.openai.com/api/docs/guides/realtime-sip", "excerpt": "Receive realtime.call.incoming webhook events; Accept or reject calls using dedicated API endpoints", "confidence": "high" }, { "field": "enterprise_plan_available", "url": "https://openai.com/api-scale-tier/", "excerpt": "OpenAI's Scale Tier traffic offers a 99.9% uptime SLA and prioritized compute for customers on enterprise agreements.", "confidence": "high" }, { "field": "api_style", "url": "https://developers.openai.com/api/docs/guides/realtime-websocket", "excerpt": "wss://api.openai.com/v1/realtime?model=gpt-realtime-2", "confidence": "high" }, { "field": "base_url", "url": "https://developers.openai.com/api/docs/guides/realtime-websocket", "excerpt": "wss://api.openai.com/v1/realtime?model=gpt-realtime-2", "confidence": "high" }, { "field": "auth_methods", "url": "https://developers.openai.com/api/reference/overview", "excerpt": "API Keys: Standard bearer token authentication via Authorization: Bearer OPENAI_API_KEY", "confidence": "high" }, { "field": "api_version", "url": "https://developers.openai.com/api/docs/models/gpt-realtime", "excerpt": "\"gpt-realtime-2025-08-28\" represents the current snapshot", "confidence": "high" }, { "field": "stability", "url": "https://chatlyai.app/news/openai-realtime-api-ga-gpt-aug-2025", "excerpt": "General availability of the Realtime API was announced on August 28, 2025 alongside the release of a purpose-built model called gpt-realtime.", "confidence": "high" }, { "field": "sdk_packages", "url": "https://developers.openai.com/api/docs/libraries", "excerpt": "JavaScript: openai (npm) openai-node (yes, vendor-maintained); Python: openai (pip) openai-python (yes); .NET: OpenAI (NuGet) openai-.net (yes); Java: openai-java (Maven); Go: openai-go; Ruby: openai (gem)", "confidence": "high" }, { "field": "quickstart_url", "url": "https://developers.openai.com/api/docs/guides/realtime", "excerpt": "Start with the Voice agents guide for building low-latency speech-to-speech assistants in browsers.", "confidence": "high" }, { "field": "sla_url", "url": "https://openai.com/api-scale-tier/", "excerpt": "OpenAI's Scale Tier offers a 99.9% uptime SLA and prioritized compute.", "confidence": "medium" }, { "field": "starting_price_usd", "url": "https://developers.openai.com/api/docs/pricing", "excerpt": "gpt-realtime-2: Audio Input: $32.00 per 1M tokens. Audio tokens in user messages are 1 token per 100 ms of audio (600 tokens/min = $0.0192/min)", "confidence": "high" }, { "field": "price_basis", "url": "https://developers.openai.com/api/docs/pricing", "excerpt": "gpt-realtime-2 Audio Input: $32.00 per 1M tokens; gpt-realtime-translate: $0.034 per minute; gpt-realtime-whisper: $0.017 per minute", "confidence": "high" }, { "field": "ga_date", "url": "https://chatlyai.app/news/openai-realtime-api-ga-gpt-aug-2025", "excerpt": "OpenAI Realtime API Hits General Availability with GPT-Realtime Voice Model — August 28, 2025", "confidence": "high" }, { "field": "notable_customers", "url": "https://developers.openai.com/blog/realtime-perplexity-computer", "excerpt": "How Perplexity Brought Voice Search to Millions Using the Realtime API", "confidence": "high" }, { "field": "versioning_scheme", "url": "https://developers.openai.com/api/docs/guides/realtime-websocket", "excerpt": "wss://api.openai.com/v1/realtime?model=gpt-realtime-2 — version embedded in the URL path (/v1/)", "confidence": "high" }, { "field": "notable_customers", "url": "https://community.openai.com/t/introducing-gpt-realtime-and-realtime-api-updates-for-production-voice-agents/1355039", "excerpt": "Zillow is using GPT-Realtime-2 for production voice... Healthify uses the Realtime API to enable natural conversations with its AI coach Ria... Speak uses Realtime API to power its role-play feature... Genspark stress-tested gpt-realtime-mini on bilingual translation", "confidence": "high" }, { "field": "error_format", "url": "https://developers.openai.com/api/docs/guides/realtime-websocket", "excerpt": "Error format: reference the full API reference /api/docs/api-reference/realtime_server_events/error. JSON-serialized text strings for all events.", "confidence": "medium" } ], "fields_not_found": [ "exact maximum concurrent sessions limit", "minimum_commitment for Scale Tier", "gpt-realtime-mini audio token pricing not listed on main pricing page", "complete enumeration of all 70+ supported transcription language codes on official docs page", "webhook_events_url", "webhook_signing", "rate_limit_requests", "rate_limit_window", "free_tier_limit" ], "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/openai-realtime", "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/openai-realtime/{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" } ] } }