Zendesk
Search Zendesk Help Center articles for an Agent with ZendeskTools.
ZendeskTools enable an Agent to access Zendesk API to search for articles.
Prerequisites
The following example requires the requests and openai libraries and auth credentials.
uv pip install -U agno requests openaiexport ZENDESK_USERNAME="you@example.com/token"
export ZENDESK_PASSWORD="your-zendesk-api-token"
export ZENDESK_COMPANY_NAME="your-subdomain"Example
The following agent will search Zendesk for "How do I login?" and print the response.
from agno.agent import Agent
from agno.tools.zendesk import ZendeskTools
agent = Agent(tools=[ZendeskTools()])
agent.print_response("How do I login?", markdown=True)Toolkit Params
| Parameter | Type | Default | Description |
|---|---|---|---|
username | str | - | The username used for authentication or identification purposes. |
password | str | - | HTTP Basic secret; use your API token with an email/token username. |
company_name | str | - | Zendesk subdomain, for example acme from acme.zendesk.com. |
timeout | int | 30 | Timeout for HTTP requests, in seconds. |
enable_search_zendesk | bool | True | Enable the search Zendesk functionality. |
all | bool | False | Enable all functionality. |
Toolkit Functions
| Function | Description |
|---|---|
search_zendesk | This function searches for articles in Zendesk Help Center that match the given search string. |
API-token authentication
Enable API-token access in your Zendesk account, then use the email-plus-/token username and API token shown above. The adapter sends HTTP Basic authentication. See Zendesk authentication for the account configuration.