Skip to main content

persona-sdk-python

Async Python SDK for the Persona AI platform.

Installation

pip install persona-sdk-python

Or with uv:

uv add persona-sdk-python

Requirements: Python 3.10+

Quick start

import asyncio
from persona_sdk import PersonaSdk


async def main():
    sdk = PersonaSdk(
        base_url="https://persona.applica.guru/api",
        auth="prs_your_project_api_key",
    )

    # List agents in your project -> Paginated[AgentConfiguration]
    page = await sdk.agents.list()
    for agent in page.items:
        print(agent.id, agent.name, agent.model.model_name)

    await sdk.close()


asyncio.run(main())

Authentication

The SDK supports two authentication methods via the auth parameter.

API key (default)

A plain string is wrapped automatically in ApiKeyAuthenticationProvider and sent as the x-persona-apikey header. Accepts:

  • Master key (full admin access)
  • Project API key (prs_...)
  • Agent API key (prs_ag_...)
from persona_sdk import PersonaSdk

sdk = PersonaSdk(
    base_url="https://persona.applica.guru/api",
    auth="prs_your_project_api_key",
)

IAM Bearer token

For applications that authenticate users via IAM, pass a BearerTokenAuthenticationProvider with a valid JWT:

from persona_sdk import PersonaSdk, BearerTokenAuthenticationProvider

sdk = PersonaSdk(
    base_url="https://persona.applica.guru/api",
    auth=BearerTokenAuthenticationProvider(iam_jwt_token),
)

The token is sent as the Authorization: Bearer <token> header. The server validates it via the IAM service and resolves the user's project automatically.

Custom provider

Implement your own provider by subclassing AuthenticationProvider:

from persona_sdk import AuthenticationProvider

class MyProvider(AuthenticationProvider):
    def headers(self) -> dict[str, str]:
        return {"x-custom-header": "value"}

    def credentials(self) -> str:
        return "my-credentials"

Available APIs

The PersonaSdk instance exposes one client per resource:

Attribute Description
sdk.agents Agent management (CRUD, voices, AI instructions, architect)
sdk.projects Project management and subscriptions
sdk.sessions Sessions, messages, usage
sdk.knowledge_bases Knowledge bases, documents, chunk search
sdk.workflows Workflows, executions, queues
sdk.triggers Triggers and trigger executions
sdk.missions Missions (generate, execute, stop, continue)
sdk.features Feature templates and MCP tools
sdk.credentials OAuth credentials and authorization
sdk.service_prices Service pricing

Each API method is fully async. Always close the SDK when done to release the underlying HTTP connection pool:

sdk = PersonaSdk(
    base_url="https://persona.applica.guru/api",
    auth="prs_your_api_key",
)
try:
    agents = await sdk.agents.list()
finally:
    await sdk.close()

CRUD example

Every API method is typed via the pydantic models re-exported from persona-models (e.g. AgentConfiguration, Project, Mission, ...). Write methods accept either a model instance or a plain dict; read methods always return the parsed model (or Paginated[...] for list endpoints).

from persona_sdk import AgentConfiguration, ModelConfiguration

# Create an agent from a typed model
agent = await sdk.agents.create(
    AgentConfiguration(
        name="my-agent",
        model=ModelConfiguration(model_name="gpt-4o"),
    )
)

# Read -> AgentConfiguration
fetched = await sdk.agents.get(agent.id)

# Update (mutate the model and send it back)
fetched.name = "renamed-agent"
await sdk.agents.update(agent.id, fetched)

# Delete
await sdk.agents.delete(agent.id)

A plain dict is still accepted for backwards compatibility:

agent = await sdk.agents.create({"name": "my-agent", "model": {"modelName": "gpt-4o"}})

AI System Instructions Generation

Generate system instructions for an agent using the project's AI architect:

# Generate from a description
instructions = await sdk.agents.generate_system_instructions(
    "Create a customer support agent that handles billing inquiries"
)

# Multi-turn refinement with session ID
instructions = await sdk.agents.generate_system_instructions(
    "Add a rule to always ask for the order number first",
    session_id="my-session-id",
)

# Get the project's architect agent configuration -> AgentConfiguration
architect = await sdk.agents.get_architect()

Pagination

List endpoints return a Paginated[<Model>] with typed .items, .total, .page and .size:

page = await sdk.agents.list(keyword="bot", page=1, size=20)
# page.items  -> list[AgentConfiguration]
# page.total  -> 42
# page.page   -> 1
# page.size   -> 20

Workflows

If your workflows service runs on a different host, pass workflows_url:

sdk = PersonaSdk(
    base_url="https://persona.applica.guru/api",
    auth="prs_...",
    workflows_url="https://persona.applica.guru/workflows",
)

# Execute a workflow
result = await sdk.workflows.execute(
    workflow_id="wf-123",
    data={"input": "value"},
)

Runners

For higher-level abstractions, the SDK provides runners:

from persona_sdk import PersonaClient
from persona_sdk.runners import AgentRunner, invoke_tool, retrieve_resource

client = PersonaClient(
    base_url="https://persona.applica.guru/api",
    auth="prs_...",
)

# Run an agent in an existing session
runner = AgentRunner(client=client, agent_id="agent-1", session_code="sess-1")
response = await runner.run("Hello, agent!")

# Invoke an MCP tool directly
result = await invoke_tool(
    client=client,
    mcp_server_name="my-mcp",
    transport=...,
    tool_name="search",
    args={"query": "hello"},
)

Proxy support

sdk = PersonaSdk(
    base_url="https://persona.applica.guru/api",
    auth="prs_...",
    proxy="http://proxy.local:8080",
)

License

Proprietary — © Applica Software Guru

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

persona_sdk_python-0.2.18.tar.gz (26.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

persona_sdk_python-0.2.18-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file persona_sdk_python-0.2.18.tar.gz.

File metadata

  • Download URL: persona_sdk_python-0.2.18.tar.gz
  • Upload date:
  • Size: 26.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for persona_sdk_python-0.2.18.tar.gz
Algorithm Hash digest
SHA256 7b77fb163555179c18a0da96f650df70ad39847c9d4a9ca5437fa23da51edcc5
MD5 a5e835714f90a777c1b0e598c379c111
BLAKE2b-256 2db1f2e9ba222e8529c54a3fa3f8c51ff1996c3de7531bde101dd782c294dae9

See more details on using hashes here.

File details

Details for the file persona_sdk_python-0.2.18-py3-none-any.whl.

File metadata

File hashes

Hashes for persona_sdk_python-0.2.18-py3-none-any.whl
Algorithm Hash digest
SHA256 ebdfabd832908a30197e16c85b93040bcc92c48c8b6375f4d815d34f0f0a0a70
MD5 6b00d141a2ad13c3398c8134e027b431
BLAKE2b-256 924e5d48075ed7feff9ef645c11a29d87dd9e33c91804898e2bb728d22bd23e1

See more details on using hashes here.

Release history Release notifications | RSS feed

0.2.21

2 files

0.2.20

2 files

0.2.19

2 files

This release

0.2.18 This release

2 files

0.2.17

2 files

0.2.16

2 files

0.2.15

2 files

0.2.14

2 files

0.2.13

2 files

0.2.12

2 files

0.2.11

2 files

0.2.10

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page