Skip to content

feat: add tzafon models #553

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.

Sign up for GitHub

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

Open
eddieogola wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: add tzafon models #553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0e4b63d
feat: add tzafon models
eddieogola Mar 1, 2026
4bb376d
feat: Add Tzafon model provider card to the model index documentation.
eddieogola Mar 1, 2026
a54c444
Merge branch 'main' into tzafon-models
eddieogola Mar 31, 2026
773392e
Format JSON for better readability
eddieogola Mar 31, 2026
4611eb7
Fix formatting in docs.json for contextual options
eddieogola Mar 31, 2026
c716258
Fix formatting issues in docs.json
eddieogola Mar 31, 2026
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
101 changes: 36 additions & 65 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1813,6 +1813,20 @@
]
}
]
},
{
"group": "Tzafon",
"pages": [
"models/providers/gateways/tzafon/overview",
{
"group": "Usage",
"pages": [
"models/providers/gateways/tzafon/usage/basic",
"models/providers/gateways/tzafon/usage/basic-stream",
"models/providers/gateways/tzafon/usage/tool-use"
]
}
]
}
]
},
Expand Down Expand Up @@ -4161,8 +4175,7 @@
"group": "Agno v2 Migration",
"pages": [
"other/v2-migration",
"other/v2-changelog"
]
"other/v2-changelog"]
},
"other/database-migrations",
"other/workflows-migration"
Expand Down Expand Up @@ -4209,10 +4222,7 @@
},
{
"group": "MCP",
"pages": [
"agent-os/mcp/mcp",
"agent-os/mcp/tools"
]
"pages": ["agent-os/mcp/mcp", "agent-os/mcp/tools"]
},
{
"group": "Middleware",
Expand Down Expand Up @@ -4524,21 +4534,15 @@
},
{
"group": "Dash",
"pages": [
"deploy/templates/dash/overview"
]
"pages": ["deploy/templates/dash/overview"]
},
{
"group": "Scout",
"pages": [
"deploy/templates/scout/overview"
]
"pages": ["deploy/templates/scout/overview"]
},
{
"group": "Gcode",
"pages": [
"deploy/templates/gcode/overview"
]
"pages": ["deploy/templates/gcode/overview"]
}
]
},
Expand All @@ -4562,9 +4566,7 @@
},
{
"group": "Teams",
"pages": [
"deploy/apps/teams/content-team"
]
"pages": ["deploy/apps/teams/content-team"]
},
{
"group": "Workflows",
Expand All @@ -4582,39 +4584,27 @@
"pages": [
{
"group": "Slack",
"pages": [
"deploy/interfaces/slack/overview"
]
"pages": ["deploy/interfaces/slack/overview"]
},
{
"group": "Discord",
"pages": [
"deploy/interfaces/discord/overview"
]
"pages": ["deploy/interfaces/discord/overview"]
},
{
"group": "WhatsApp",
"pages": [
"deploy/interfaces/whatsapp/overview"
]
"pages": ["deploy/interfaces/whatsapp/overview"]
},
{
"group": "MCP",
"pages": [
"deploy/interfaces/mcp/overview"
]
"pages": ["deploy/interfaces/mcp/overview"]
},
{
"group": "AG-UI",
"pages": [
"deploy/interfaces/ag-ui/overview"
]
"pages": ["deploy/interfaces/ag-ui/overview"]
},
{
"group": "Telegram",
"pages": [
"deploy/interfaces/telegram/overview"
]
"pages": ["deploy/interfaces/telegram/overview"]
}
]
}
Expand Down Expand Up @@ -7172,10 +7162,7 @@
},
{
"group": "Team",
"pages": [
"reference/teams/team",
"reference/teams/remote-team"
]
"pages": ["reference/teams/team", "reference/teams/remote-team"]
},
{
"group": "Workflows",
Expand Down Expand Up @@ -7228,15 +7215,11 @@
},
{
"group": "Memory",
"pages": [
"reference/memory/memory"
]
"pages": ["reference/memory/memory"]
},
{
"group": "Context Compression",
"pages": [
"reference/compression/compression-manager"
]
"pages": ["reference/compression/compression-manager"]
},
{
"group": "Database",
Expand All @@ -7258,10 +7241,7 @@
},
{
"group": "Tracing",
"pages": [
"reference/tracing/trace",
"reference/tracing/span"
]
"pages": ["reference/tracing/trace", "reference/tracing/span"]
},
{
"group": "Hooks",
Expand Down Expand Up @@ -7302,6 +7282,7 @@
"reference/models/perplexity",
"reference/models/requesty",
"reference/models/together",
"reference/models/tzafon",
"reference/models/xai",
"reference/models/vercel",
"reference/models/bedrock",
Expand Down Expand Up @@ -7371,9 +7352,7 @@
},
{
"group": "Rerankers",
"pages": [
"reference/knowledge/reranker/cohere"
]
"pages": ["reference/knowledge/reranker/cohere"]
},
{
"group": "Chunking",
Expand Down Expand Up @@ -7405,15 +7384,11 @@
"reference-api/overview",
{
"group": "Home",
"pages": [
"reference-api/schema/home/api-information"
]
"pages": ["reference-api/schema/home/api-information"]
},
{
"group": "Health",
"pages": [
"reference-api/schema/health/health-check"
]
"pages": ["reference-api/schema/health/health-check"]
},
{
"group": "Core",
Expand Down Expand Up @@ -7457,9 +7432,7 @@
},
{
"group": "Slack",
"pages": [
"reference-api/schema/slack/slack-events"
]
"pages": ["reference-api/schema/slack/slack-events"]
},
{
"group": "Whatsapp",
Expand Down Expand Up @@ -7590,9 +7563,7 @@
},
{
"group": "Registry",
"pages": [
"reference-api/schema/registry/list-registry"
]
"pages": ["reference-api/schema/registry/list-registry"]
},
{
"group": "Schedules",
Expand Down
61 changes: 61 additions & 0 deletions models/providers/gateways/tzafon/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Tzafon
sidebarTitle: Overview
description: Use Tzafon models with Agno agents.
---

Tzafon provides OpenAI-compatible API endpoints for its language models.
See their documentation [here](https://docs.tzafon.ai/core-concepts/chat-completions).

Available models include `tzafon.sm-1` and `tzafon.northstar-cua-fast`.

## Authentication

Set your `TZAFON_API_KEY` environment variable. Get your key from the [Tzafon developer dashboard](https://tzafon.ai/developer).

<CodeGroup>

```bash Mac
export TZAFON_API_KEY=***
```

```bash Windows
setx TZAFON_API_KEY ***
```

</CodeGroup>

## Example

Use `Tzafon` with your `Agent`:

<CodeGroup>

```python agent.py
from agno.agent import Agent
from agno.models.tzafon import Tzafon

agent = Agent(
model=Tzafon(id="tzafon.sm-1"),
markdown=True
)

# Print the response in the terminal
agent.print_response("Share a 2 sentence horror story.")
```

</CodeGroup>

<Note> View more examples [here](/models/providers/gateways/tzafon/usage/basic-stream). </Note>

## Params

| Parameter | Type | Default | Description |
| ------------ | ------------------ | --------------------------------------------- | --------------------------------------------------------------------- |
| `id` | `str` | `"tzafon.sm-1"` | The id of the Tzafon model to use |
| `name` | `str` | `"Tzafon"` | The name of the model |
| `provider` | `str` | `"Tzafon"` | The provider of the model |
| `api_key` | `Optional[str]` | `None` | The API key for Tzafon (defaults to TZAFON_API_KEY env var) |
| `base_url` | `str` | `"https://api.tzafon.ai/v1"` | The base URL for the Tzafon API |

`Tzafon` also supports the params of [OpenAI](/reference/models/openai).
23 changes: 23 additions & 0 deletions models/providers/gateways/tzafon/usage/basic-stream.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Basic Streaming Agent
sidebarTitle: Basic Stream
description: Create a basic streaming Agno agent using Tzafon.
---

```python cookbook/90_models/tzafon/basic_stream.py
from typing import Iterator
from agno.agent import Agent, RunOutputEvent
from agno.models.tzafon import Tzafon

agent = Agent(
model=Tzafon(id="tzafon.sm-1"), markdown=True
)

# Get the response in a variable
# run_response: Iterator[RunOutputEvent] = agent.run("Share a 2 sentence horror story", stream=True)
# for chunk in run_response:
# print(chunk.content)

# Print the response in the terminal
agent.print_response("Share a 2 sentence horror story", stream=True)
```
21 changes: 21 additions & 0 deletions models/providers/gateways/tzafon/usage/basic.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Basic Agent
sidebarTitle: Basic
description: Create a basic Agno agent using Tzafon.
---

```python cookbook/90_models/tzafon/basic.py
from agno.agent import Agent, RunOutput
from agno.models.tzafon import Tzafon

agent = Agent(
model=Tzafon(id="tzafon.sm-1"), markdown=True
)

# Get the response in a variable
# run: RunOutput = agent.run("Share a 2 sentence horror story")
# print(run.content)

# Print the response in the terminal
agent.print_response("Share a 2 sentence horror story")
```
20 changes: 20 additions & 0 deletions models/providers/gateways/tzafon/usage/tool-use.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Agent with Tools
sidebarTitle: Tool Use
description: Use Tzafon with tool-equipped Agno agents.
---

```python cookbook/90_models/tzafon/tool_use.py
"""Run `uv pip install ddgs` to install dependencies."""

from agno.agent import Agent
from agno.models.tzafon import Tzafon
from agno.tools.websearch import WebSearchTools

agent = Agent(
model=Tzafon(id="tzafon.sm-1"),
tools=[WebSearchTools()],
markdown=True,
)
agent.print_response("Whats happening in France?")
```
8 changes: 8 additions & 0 deletions models/providers/model-index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,14 @@ Agno supports the following model providers organized by category:
>
SiliconFlow model provider.
</Card>
<Card
title="Tzafon"
icon="robot"
iconType="duotone"
href="/models/providers/gateways/tzafon/overview"
>
Tzafon AI models integration.
</Card>
<Card
title="Together"
icon="users"
Expand Down
21 changes: 21 additions & 0 deletions reference/models/tzafon.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Tzafon
sidebarTitle: Tzafon
---

The Tzafon model provides access to Tzafon's language models.

## Parameters

| Parameter | Type | Default | Description |
| ------------ | ------------------ | --------------------------------------------- | --------------------------------------------------------------------- |
| `id` | `str` | `"tzafon.sm-1"` | The id of the Tzafon model to use |
| `name` | `str` | `"Tzafon"` | The name of the model |
| `provider` | `str` | `"Tzafon"` | The provider of the model |
| `api_key` | `Optional[str]` | `None` | The API key for Tzafon (defaults to TZAFON_API_KEY env var) |
| `base_url` | `str` | `"https://api.tzafon.ai/v1"` | The base URL for the Tzafon API |
| `retries` | `int` | `0` | Number of retries to attempt before raising a ModelProviderError |
| `delay_between_retries` | `int` | `1` | Delay between retries, in seconds |
| `exponential_backoff` | `bool` | `False` | If True, the delay between retries is doubled each time |

Tzafon extends the OpenAI-compatible interface and supports most parameters from OpenAI.