# Generic avatar (/en/ai/platform/models/avatar/generic)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

> Documentation: Conversational AI.
> Documentation version: Preview.
> This document describes only this version. [Version index](/llms/doc-versions-convoai-guides-v2.txt).


The `generic` avatar vendor lets you integrate a custom avatar provider into the Conversational AI Platform.

## Sample configuration

The following example shows how to configure a generic avatar provider as the agent's avatar when you create or update an agent. For a complete example, see [Create an agent and start a session](/en/ai/platform/get-started/start-stop-agent#create-an-agent).

Generic avatar providers support BYOK only. They aren't available in managed mode. Store your avatar provider's API key in a secret set, and refer to it from the agent. For details, see [Use your own provider keys](/en/ai/platform/build/use-your-own-keys).

**Python SDK**

```python
from agora_agent import Agent, GenericAvatar, secret_ref

# client is your configured Agora client
agent = (
    Agent(client=client)
    .with_stt(...)  # configure your ASR vendor
    .with_llm(...)  # configure your LLM vendor
    .with_tts(...)  # configure your TTS vendor
    .with_avatar(
        GenericAvatar(
            api_key=secret_ref("support_prod", "avatar"),
            api_base_url="<avatar_api_base_url>",
            avatar_id="<avatar_id>",
            agora_uid="<avatar_rtc_uid>",
            agora_token="<avatar_rtc_token>",
        )
    )
)
```

**TypeScript SDK**

```ts
import { Agent, GenericAvatar, secretRef } from 'agora-agents';

// client is your configured Agora client
const agent = new Agent({ client })
  .withStt(/* configure your ASR vendor */)
  .withLlm(/* configure your LLM vendor */)
  .withTts(/* configure your TTS vendor */)
  .withAvatar(
    new GenericAvatar({
      apiKey: secretRef('support_prod', 'avatar'),
      apiBaseUrl: '<avatar_api_base_url>',
      avatarId: '<avatar_id>',
      agoraUid: '<avatar_rtc_uid>',
      agoraToken: '<avatar_rtc_token>',
    }),
  );
```

**Go SDK**

```go
// client is your configured Agora client
agent := agentkit.NewAgent(client).
	WithStt( /* configure your ASR vendor */ ).
	WithLlm( /* configure your LLM vendor */ ).
	WithTts( /* configure your TTS vendor */ ).
	WithAvatar(vendors.NewGenericAvatar(vendors.GenericAvatarOptions{
		APIKey:     agentkit.SecretRef("support_prod", "avatar"),
		APIBaseURL: "<avatar_api_base_url>",
		AvatarID:   "<avatar_id>",
		AgoraUID:   "<avatar_rtc_uid>",
		AgoraToken: "<avatar_rtc_token>",
	}))
```

**REST API**

Add an `avatar` block to the `pipeline`. Set `credential.mode` to `byok` and `credential.fields.api_key` to the reference. In the following example, the key is stored as `avatar` in the `support_prod` set:

```json
"avatar": {
  "enabled": true,
  "credential": {
    "mode": "byok",
    "fields": {
      "api_key": "$secrets.support_prod.avatar"
    }
  },
  "vendor": "generic",
  "params": {
    "api_base_url": "<avatar_api_base_url>",
    "avatar_id": "<avatar_id>",
    "agora_token": "<avatar_rtc_token>",
    "agora_uid": "<avatar_rtc_uid>"
  }
}
```

## Key parameters

The `avatar` block takes the following fields. In the SDKs, `GenericAvatar` sets them from its options, and passes any other parameters from its additional parameters option to `params`.

**avatar required**

**`enabled` (boolean) required**

Set to `true` to show the avatar.

**`vendor` (string) required**

Set to `generic`.

**`credential` (object) required**

Set `mode` to `byok` and `fields.api_key` to a `$secrets.<set>.<key>` reference to the API key for your avatar provider.

**`params` (object) required**

**`api_base_url` (string) required**

The base URL of the avatar provider's API endpoint.

**`avatar_id` (string) required**

The unique identifier for the avatar to use.

**`agora_token` (string) optional**

The RTC token that authorizes the avatar to join the video channel. Generate this token using your Agora project credentials.

**`agora_uid` (string) required**

The unique identifier for the avatar's RTC connection. This must be different from other participants in the channel.

This integration is fully supported for use with the Conversational AI Platform. While it has completed functional validation, it is newer to the platform, and additional provider-specific edge cases may be identified as usage scales across a broader range of applications and workloads.