Voker Python SDK

Installation

pip install voker

uv add voker

poetry add voker

Make sure to set the environment variable VOKER_API_KEY.

Quick start

If you’re using one of our supported SDKs, you can simply swap out the class you instantiate:

from openai import OpenAI  
from voker.ai.provider_openai import OpenAI  

client = OpenAI()

client.chat.completions.create(
    voker_agent="customer-support-agent",  # required
    voker_session="user-session-1",  # required
    model="gpt-4.1-mini",
    messages=[
        {
            "role": "user",
            "content": "Hello, world!",
        }
    ],
)

See provider specific setup instructions: OpenAI, Anthropic, and Gemini.

Python SDK Reference

VokerClient

The Voker Client provides a way to create and update Agents, Agent Versions, People and Events programmatically. Requests are made in a separate thread as the main process as to not add latency to your application. This is used by the SDKs but can also be used directly if you want more control over when requests are sent.

Properties

Name	Type	Description
`agent_versions`	`VokerClient_AgentVersions`	Access agent versions related endpoints.
`agents`	`VokerClient_Agents`	Access agents related endpoints.
`events`	`VokerClient_Events`	Access events related endpoints.
`people`	`VokerClient_People`	Access people related endpoints.

Methods

Name	Description
`close`	Close the client. This will stop the background worker and flush any remaining events to the Voker API.
`start`	Start the client. This will start the background worker that sends events to the Voker API.

Sub Clients

VokerClient_AgentVersions

Access agent versions related endpoints. Method create Create an agent version. See Creating an Agent Version for more information. Parameters:

Name	Type	Description
`agent_name`	`str`	The name of the existing agent that this version belongs to.
`agent_version_name`	`str`	Unique identifier for the agent version within its agent.
`description`	`Optional[str]`

VokerClient_Agents

Access agents related endpoints. Method create Create an agent. See Creating an Agent for more information. Parameters:

Name	Type	Description
`agent_name`	`str`	Unique identifier for the agent.
`description`	`Optional[str]`

VokerClient_Events

Access events related endpoints. Method create Create a new event. Parameters:

Name	Type	Description
`agent`	`Optional[str]`	The name of the agent associated with the event. If this agent does not exist, it will be created.
`agent_version`	`Optional[str]`	The name of the agent version associated with the event. If this agent version does not exist, it will be created. If an agent version is not supplied, a default version will be used.
`event_name`	`str`
`person`	`Optional[str]`	The unique identifier of the person associated with the event. If the person does not exist, it will be created.
`properties`	`EventProperties`
`session`	`str`	The unique identifier of the session associated with the event.

VokerClient_People

Access people related endpoints. Method create Create a person. See Creating a Person for more information. Parameters:

Name	Type	Description
`person_id`	`str`	Unique identifier for the person.
`properties`	`dict[str, Any]`

Method update Update a person. Parameters:

Name	Type	Description
`person_id`	`str`
`properties`	`dict`

ApiClient

The API Client provides a way to make requests to the Voker API directly. This is used under the hood by the Voker Client, but can also be used directly if you want more control over how requests are made. Fetching Agents, Agent Versions, and People is a common use case for using the API Client directly.

Properties

Name	Type	Description
`agent_versions`	`ApiClient_AgentVersions`	Access agent versions related endpoints.
`agents`	`ApiClient_Agents`	Access agents related endpoints.
`events`	`ApiClient_Events`	Access events related endpoints.
`fingerprints`	`ApiClient_Fingerprints`	Access fingerprints related endpoints.
`people`	`ApiClient_People`	Access people related endpoints.

Sub Clients

ApiClient_AgentVersions

Access agent versions related endpoints. Method create Create an agent version. See Creating an Agent Version for more information. Parameters:

Name	Type	Description
`agent_name`	`str`	The name of the existing agent that this version belongs to.
`agent_version_name`	`str`	Unique identifier for the agent version within its agent.
`description`	`Optional[str]`

Returns:

Type	Description
`AgentVersion`

Method get Get an agent version. Parameters:

Name	Type	Description
`agent_name`	`str`
`agent_version_name`	`str`

Returns:

Type	Description
`AgentVersion`

ApiClient_Agents

Access agents related endpoints. Method create Create an agent. See Creating an Agent for more information. Parameters:

Name	Type	Description
`agent_name`	`str`	Unique identifier for the agent.
`description`	`Optional[str]`

Returns:

Type	Description
`Agent`

Method get Get an agent. Parameters:

Name	Type	Description
`agent_name`	`str`

Returns:

Type	Description
`Agent`

ApiClient_Events

Access events related endpoints. Method create Create a new event. Parameters:

Name	Type	Description
`agent`	`Optional[str]`	The name of the agent associated with the event. If this agent does not exist, it will be created.
`agent_version`	`Optional[str]`	The name of the agent version associated with the event. If this agent version does not exist, it will be created. If an agent version is not supplied, a default version will be used.
`event_name`	`str`
`fingerprint_id`	`str`	The fingerprint of the client that generated the event.
`person`	`Optional[str]`	The unique identifier of the person associated with the event. If the person does not exist, it will be created.
`properties`	`EventProperties`
`session`	`str`	The unique identifier of the session associated with the event.

ApiClient_Fingerprints

Access fingerprints related endpoints. Method create Create a fingerprint. See Fingerprints for more information. Returns:

Type	Description
`Fingerprint`

ApiClient_People

Access people related endpoints. Method get Retrieve a person. Parameters:

Name	Type	Description
`person_id`	`str`

Returns:

Type	Description
`Person`

Method create Create a person. See Creating a Person for more information. Parameters:

Name	Type	Description
`person_id`	`str`	Unique identifier for the person.
`properties`	`dict[str, Any]`

Returns:

Type	Description
`Person`

Method update Update a person. Parameters:

Name	Type	Description
`person_id`	`str`
`properties`	`dict`

Returns:

Type	Description
`Person`

Types

Agent

Represents an agent. See Agents for more information.

Fields

Name	Type	Description
`agent_name`	`str`	Unique identifier for the agent.
`description`	`str \| None`
`agent_number`	`int`	Unique number assigned to the agent.
`created_at`	`datetime`
`deprecated_at`	`datetime \| None`

AgentVersion

Represents an agent version. See Agent Versions for more information.

Fields

Name	Type	Description
`agent_version_name`	`str`	Unique identifier for the agent version within its agent.
`description`	`str \| None`
`agent_version_number`	`int`	Unique number assigned to the agent version within its agent.
`created_at`	`datetime`
`deprecated_at`	`datetime \| None`

Fingerprint

Represents a fingerprint. See Fingerprints for more information.

Fields

Name	Type	Description
`fingerprint_id`	`str`

Person

Represents a person. See People for more information.

Fields

Name	Type	Description
`person_id`	`str`
`properties`	`dict[str, Any] \| None`
`created_at`	`datetime`

Get Started

Concepts

API Reference

Integrations

Platform

Resources

Voker Python SDK

Installation

Quick start

Python SDK Reference

VokerClient

Properties

Methods

Sub Clients

VokerClient_AgentVersions

VokerClient_Agents

VokerClient_Events

VokerClient_People

ApiClient

Properties

Sub Clients

ApiClient_AgentVersions

ApiClient_Agents

ApiClient_Events

ApiClient_Fingerprints

ApiClient_People

Types

Agent

Fields

AgentVersion

Fields

Fingerprint

Fields

Person

Fields

​Installation

​Quick start

​Python SDK Reference

​VokerClient

​Properties

​Methods

​Sub Clients

VokerClient_AgentVersions

VokerClient_Agents

VokerClient_Events

VokerClient_People

​ApiClient

​Properties

​Sub Clients

ApiClient_AgentVersions

ApiClient_Agents

ApiClient_Events

ApiClient_Fingerprints

ApiClient_People

​Types

​Agent

Fields

​AgentVersion

Fields

​Fingerprint

Fields

​Person

Fields

Installation

Quick start

Python SDK Reference

VokerClient

Properties

Methods

Sub Clients

ApiClient

Properties

Sub Clients

Types

Agent

AgentVersion

Fingerprint

Person