diff --git a/.gitignore b/.gitignore index 397dfa1..fe38d49 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -**/.preview/** \ No newline at end of file +**/.definition +**/.preview/** diff --git a/fern/apis/api/generators.yml b/fern/apis/api/generators.yml index 4ddedba..d3dd2b4 100644 --- a/fern/apis/api/generators.yml +++ b/fern/apis/api/generators.yml @@ -11,6 +11,7 @@ groups: generators: - name: fernapi/fern-python-sdk version: 4.3.8 + disable-examples: true api: settings: unions: v1 @@ -25,7 +26,8 @@ groups: ts-sdk: generators: - name: fernapi/fern-typescript-node-sdk - version: 0.40.5 + version: 0.42.7 + disable-examples: true api: settings: unions: v1 diff --git a/fern/apis/api/openapi-overrides.yml b/fern/apis/api/openapi-overrides.yml index 96606c7..0053cf2 100644 --- a/fern/apis/api/openapi-overrides.yml +++ b/fern/apis/api/openapi-overrides.yml @@ -183,6 +183,8 @@ paths: x-fern-sdk-group-name: - analytics x-fern-sdk-method-name: get + get: + x-fern-ignore: true /logs: get: x-fern-pagination: true @@ -191,6 +193,56 @@ paths: x-fern-sdk-method-name: get components: schemas: + FallbackAzureVoice: + properties: + voiceId: + x-fern-type-name: FallbackAzureVoiceId + oneOf: + - x-fern-type-name: FallbackAzureVoiceIdEnum + FallbackDeepgramVoice: + properties: + voiceId: + x-fern-type-name: FallbackDeepgramVoiceId + oneOf: + - x-fern-type-name: FallbackDeepgramVoiceIdEnum + FallbackElevenLabsVoice: + properties: + voiceId: + x-fern-type-name: FallbackElevenLabsVoiceId + oneOf: + - x-fern-type-name: FallbackElevenLabsVoiceIdEnum + provider: + x-fern-type: literal<"11labs"> + FallbackOpenAIVoice: + properties: + voiceId: + x-fern-type-name: FallbackOpenAIVoiceId + oneOf: + - x-fern-type-name: FallbackOpenAIVoiceIdEnum + FallbackRimeAIVoice: + properties: + voiceId: + x-fern-type-name: FallbackRimeAIVoiceId + oneOf: + - x-fern-type-name: FallbackRimeAIVoiceIdEnum + FallbackPlayHTVoice: + properties: + voiceId: + x-fern-type-name: FallbackPlayHTVoiceId + oneOf: + - x-fern-type-name: FallbackPlayHTVoiceIdEnum + FallbackLMNTVoice: + properties: + voiceId: + x-fern-type-name: FallbackLMNTVoiceId + oneOf: + - x-fern-type-name: FallbackLMNTVoiceIdEnum + FallbackNeetsVoice: + properties: + voiceId: + x-fern-type-name: FallbackNeetsVoiceId + oneOf: + - x-fern-type-name: FallbackNeetsVoiceIdEnum AzureVoice: properties: voiceId: diff --git a/changelog/2024-12-05.mdx b/fern/changelog/2024-12-05.mdx similarity index 55% rename from changelog/2024-12-05.mdx rename to fern/changelog/2024-12-05.mdx index a102567..ab73b8a 100644 --- a/changelog/2024-12-05.mdx +++ b/fern/changelog/2024-12-05.mdx @@ -1,4 +1,6 @@ -1. **OAuth2 Support for Custom LLM Credentials and Webhooks**: You can now secure access to your [custom LLMs](https://docs.vapi.ai/customization/custom-llm/using-your-server#step-2-configuring-vapi-with-custom-llm) and [server urls (aka webhooks)](https://docs.vapi.ai/server-url) using OAuth2 (RFC 6749). Create a webhook credential with `CreateWebhookCredentialDTO` and specify the following information. +1. **OAuth2 Support for Custom LLM Credentials and Webhooks**: You can now authorize access to your [custom LLMs](https://docs.vapi.ai/customization/custom-llm/using-your-server#step-2-configuring-vapi-with-custom-llm) and [server urls (aka webhooks)](https://docs.vapi.ai/server-url) using OAuth2 (RFC 6749). + +For example, create a webhook credential with `CreateWebhookCredentialDTO` with the following payload: ```json { @@ -13,4 +15,10 @@ } ``` +This returns a [`WebhookCredential`](https://api.vapi.ai/api) object as follows: + + + + + 3. **Removal of Canonical Knowledge Base**: The ability to create, update, and use canoncial knowledge bases in your assistant has been removed from the API(as custom knowledge bases and the Trieve integration supports as superset of this functionality). Please update your implementations as endpoints and models referencing canoncial knowledge base schemas are no longer available. \ No newline at end of file diff --git a/fern/changelog/2024-12-06.mdx b/fern/changelog/2024-12-06.mdx new file mode 100644 index 0000000..d9d6b49 --- /dev/null +++ b/fern/changelog/2024-12-06.mdx @@ -0,0 +1,24 @@ +1. **OAuth 2 Authentication for Custom LLM Models and Webhooks**: In addition to (AuthZ)[https://www.okta.com/identity-101/authentication-vs-authorization/], you can now now authenticate users accessing your [custom LLMs](https://docs.vapi.ai/customization/custom-llm/using-your-server#step-2-configuring-vapi-with-custom-llm) and [server urls (aka webhooks)](https://docs.vapi.ai/server-url) using OAuth2 (RFC 6749). Use the `authenticationSession` dictionary which contains an `accessToken` and `expiresAt` datetime to authenticate further requests to your custom LLM or server URL. + +For example, create a webhook credential with `CreateCustomLLMCredentialDTO` with the following payload: +```json +{ + "provider": "custom-llm", + "apiKey": "your-api-key-max-10000-characters", + "authenticationPlan": { + "type": "oauth2", + "url": "https://your-url.com/your/path/token", + "clientId": "your-client-id", + "clientSecret": "your-client-secret" + }, + "name": "your-credential-name-between-1-and-40-characters" +} +``` + +This returns a [`CustomLLMCredential`](https://api.vapi.ai/api) object as follows: + + + + + +This can be used to authenticate successive requests to your custom LLM or server URL. diff --git a/fern/customization/custom-voices/tavus.mdx b/fern/customization/custom-voices/tavus.mdx index 6bb6c0f..18446af 100644 --- a/fern/customization/custom-voices/tavus.mdx +++ b/fern/customization/custom-voices/tavus.mdx @@ -7,7 +7,7 @@ slug: customization/custom-voices/tavus This guide outlines the procedure for integrating your custom replica with Tavus through the VAPI platform. -An API subscription is required for this process to work. +An API subscription is required for this process to work. This process is only required if you would like to use your **custom Tavus replicas**. This process is not required to use stock replicas on the Vapi platform. To integrate your custom replica with [Tavus](https://platform.tavus.io/) using the VAPI platform, follow these steps. diff --git a/fern/fern.config.json b/fern/fern.config.json index 5313b76..e3c5af7 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "vapi", - "version": "0.45.1" + "version": "0.45.3" } \ No newline at end of file diff --git a/fern/static/images/changelog/custom-llm-credential.png b/fern/static/images/changelog/custom-llm-credential.png new file mode 100644 index 0000000..48076e1 Binary files /dev/null and b/fern/static/images/changelog/custom-llm-credential.png differ diff --git a/fern/static/images/changelog/webhook-credential.png b/fern/static/images/changelog/webhook-credential.png new file mode 100644 index 0000000..47f2159 Binary files /dev/null and b/fern/static/images/changelog/webhook-credential.png differ