Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(retell-ai): added retell ai support #3365

Merged
merged 7 commits into from
Feb 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions docs-v2/integrations/all/retell-ai.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: Retell AI
sidebarTitle: Retell AI
provider: retell-ai
---

import Overview from "/snippets/overview.mdx";
import PreBuiltTooling from "/snippets/generated/retell-ai/PreBuiltTooling.mdx";
import PreBuiltUseCases from "/snippets/generated/retell-ai/PreBuiltUseCases.mdx"

<Overview />
<PreBuiltTooling />
<PreBuiltUseCases />

## Access requirements
| Pre-Requisites | Status | Comment|
| - | - | - |
| Paid dev account | ✅ | Required for API access |
| Paid test account | ✅ | Available for testing purposes |
| Partnership | ❌ | Not required |
| App review | ❌ | Not required |
| Security audit | ❌ | Not required |

## Setup guide

1. **Create an account**: Sign up for a Retell AI account at [Retell AI](https://www.retellai.com/).
2. **Generate an API key**: Navigate to your workspace settings and generate an API key. This key will be used for authentication.
3. **Configure your integration**: Use the API key in your requests by including it in the `Authorization` header as a Bearer token.
4. **Test your integration**: Use the `/v1/agent` endpoint to verify your setup.

<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>

<Note>Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/retell-ai.mdx)</Note>

## Useful links

- [Retell AI API Documentation](https://docs.retellai.com/api-references)
- [Authentication Guide](https://docs.retellai.com/accounts/api-keys-overview)
- [API Playground](https://docs.retellai.com/test/llm_playground)

<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/retell-ai.mdx)</Note>

## API gotchas

- **API Key Security**: Never expose your API key in client-side code or public repositories. Always use environment variables or secure storage.
- **Rate Limits**: Be mindful of API rate limits. Check the [API documentation](https://docs.retellai.com/deploy/concurrency#understand-concurrency-and-limits) for details.
- **Webhook Security**: Use the designated webhook API key for signing and verifying webhook requests to ensure they are legitimate.

<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/retell-ai.mdx)</Note>

<Card title="Connect to Retell Ai" icon="link" href="/integrations/all/retell-ai/connect" horizontal>
Guide to connect to Retell Ai using Nango Connect.
</Card>
40 changes: 40 additions & 0 deletions docs-v2/integrations/all/retell-ai/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Retell AI - How do I link my account?
sidebarTitle: Retell AI
---

# Overview

To authenticate with Retell AI, you need one piece of information:
1. **API Key** - Your Retell AI API Key

This guide will walk you through finding or creating your API key within Retell AI.

### Prerequisites:

- You must have a Retell AI account. If you don’t have one, sign up at [Retell AI](https://www.retellai.com/).

---

#### Step 1: Finding Your Retell AI API Key

1. **Log in to Retell AI**: Go to the [Retell AI Dashboard](https://dashboard.retellai.com/) and log in with your credentials.

2. **Navigate to API Keys**: In the dashboard, scroll through the menu and select **API Keys** .

<img src="/integrations/all/retell-ai/retell-1.png" alt="Retell AI API Keys Menu" />

3. **Getting your API Key**: Your key should already be generated by the system.

4. **Securely Copy Your API Key**: Clicking the view iconbutton and securely copy it.

---

#### Step 2: Connect Your Retell AI Account

To authenticate using your API key, navigate to the Retell AI authentication form in Nango. Enter your credentials as follows:
- **API Key**: Paste the API key you copied in Step 1.

Click **Connect** to complete the authentication.

---
Binary file added docs-v2/integrations/all/retell-ai/retell-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs-v2/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,7 @@
"integrations/all/recharge",
"integrations/all/refiner",
"integrations/all/replicate",
"integrations/all/retell-ai",
"integrations/all/ring-central",
"integrations/all/sage",
"integrations/all/salesforce",
Expand Down
40 changes: 40 additions & 0 deletions docs-v2/snippets/generated/retell-ai/PreBuiltTooling.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## Pre-built tooling
<AccordionGroup>
<Accordion title="✅ Authorization">
| Tools | Status |
| - | - |
| Pre-built authorization (API Key) | ✅ |
| Pre-built authorization UI | ✅ |
| Custom authorization UI | ✅ |
| End-user authorization guide | ✅ |
| Expired credentials detection | ✅ |
</Accordion>
<Accordion title="✅ Read & write data">
| Tools | Status |
| - | - |
| Pre-built integrations | 🚫 (time to contribute: &lt;48h) |
| API unification | ✅ |
| 2-way sync | ✅ |
| Webhooks from Nango on data modifications | ✅ |
| Real-time webhooks from 3rd-party API | 🚫 (time to contribute: &lt;48h) |
| Proxy requests | ✅ |
</Accordion>
<Accordion title="✅ Observability & data quality">
| Tools | Status |
| - | - |
| HTTP request logging | ✅ |
| End-to-type type safety | ✅ |
| Data runtime validation | ✅ |
| OpenTelemetry export | ✅ |
| Slack alerts on errors | ✅ |
| Integration status API | ✅ |
</Accordion>
<Accordion title="✅ Customization">
| Tools | Status |
| - | - |
| Create or customize use-cases | ✅ |
| Pre-configured pagination | 🚫 (time to contribute: &lt;48h) |
| Pre-configured rate-limit handling | 🚫 (time to contribute: &lt;48h) |
| Per-customer configurations | ✅ |
</Accordion>
</AccordionGroup>
5 changes: 5 additions & 0 deletions docs-v2/snippets/generated/retell-ai/PreBuiltUseCases.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Pre-built integrations

_No pre-built integration yet (time to contribute: &lt;48h)_

<Tip>Not seeing the integration you need? [Build your own](https://docs.nango.dev/guides/custom-integrations/overview) independently.</Tip>
21 changes: 21 additions & 0 deletions packages/providers/providers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6009,6 +6009,27 @@ replicate:
title: API Key
description: The API key for your Replicate account

retell-ai:
display_name: Retell AI
categories:
- dev-tools
- productivity
auth_mode: API_KEY
proxy:
base_url: https://api.retellai.com
headers:
authorization: Bearer ${apiKey}
content-type: application/json
docs: https://docs.nango.dev/integrations/all/retell-ai
docs_connect: https://docs.nango.dev/integrations/all/retell-ai/connect
credentials:
apiKey:
type: string
title: API Key
description: The API key for Retell AI
example: key-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
doc_section: '#step-1-finding-your-retell-ai-api-key'

ring-central:
display_name: RingCentral
categories:
Expand Down
7 changes: 7 additions & 0 deletions packages/webapp/public/images/template-logos/retell-ai.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading