REretellai

POST /create-app

Changed on

Create an App: the connection to one external system (a CRM, calendar, support desk, and so on), holding its credentials and settings. Providers with caller-managed credentials accept auth_config. Providers using OAuth must omit auth_config and be authorized through connect-app. Providers supporting both methods, such as Cal.com, also accept caller-managed API keys. Credentials are stored encrypted and never returned. Up to 20 apps per provider by default, unless a custom limit is configured for the organization.

Request

  • Base URL
    https://api.retellai.com
  • Auth
    HTTP bearer

Request body

type'crm' | 'calendar' | 'knowledge_base' | 'support' | 'communication' required

App integration category.

providerstring required

Provider name. Must be valid for the App's type; the supported providers per type are listed by list-app-templates.

namestring

Display name.

tenant_urlstring

Per-tenant API base URL.

tenant_idstring

Sub-account id, for providers that scope requests by a sub-account id on a shared host.

Response

App created.

app_idstring required
org_idstring required
type'crm' | 'calendar' | 'knowledge_base' | 'support' | 'communication' required

App integration category.

providerstring required

Provider name. Must be valid for the App's type; the supported providers per type are listed by list-app-templates.

connection_status'not_connected' | 'connected' | 'error'

Connection health of the App, server-managed. not_connected after create or a credential / tenant URL change; connected once verified via OAuth connect, an auth test, or a successful live tool call; error when the provider rejects the credentials (on connect, an auth test, or a live tool call).

namestring
tenant_urlstring

Per-tenant API base URL. Set by providers with per-org hosts; omitted by providers on a single global host. For OneDrive for Business, this is the tenant's -my.sharepoint.com origin used by File Picker v8; personal OneDrive omits it.

tenant_type'business' | 'personal'

Microsoft OneDrive account type discovered during OAuth.

tenant_idstring

Sub-account id, for providers that scope requests by a sub-account id on a shared host. Omitted by every other provider.

created_timestampnumber required
user_modified_timestampnumber required

Changes