API Reference

Public OTOBO Python SDK exports and client methods.

OTOBO API reference

Install: pip install otobo

Package exports

Python
from otobo import (
Article,
BasicAuth,
ClientConfig,
IdName,
OperationUrlMap,
OTOBOClient,
OTOBOError,
Ticket,
TicketBase,
TicketCreate,
TicketOperation,
TicketSearch,
TicketUpdate,
WebserviceBuilder,
generate_random_password,
setup_otobo_system,
)

OTOBOClient

Async GenericInterface client (alias of GenericInterfaceClient).

MethodDescription
login(auth: BasicAuth)Attach agent credentials to subsequent requests
logout()Clear credentials
create_ticket(ticket: TicketCreate) -> TicketCreate a ticket
get_ticket(ticket_id) -> TicketFetch one ticket by ID
update_ticket(ticket: TicketUpdate) -> TicketUpdate a ticket
search_tickets(search: TicketSearch) -> list[int]Search; returns ticket IDs
search_and_get(search: TicketSearch) -> list[Ticket]Search then fetch full tickets concurrently
aclose()Close the underlying HTTP client

Use as an async context manager: async with client:.

Domain models

ModelPurpose
ClientConfigbase_url, webservice_name, operation_url_map
BasicAuthuser_login, password (SecretStr)
TicketCreate / TicketUpdate / TicketSearchRequest payloads
TicketFull ticket returned by the API
Article, IdNameArticle body and queue/state/priority references
TicketOperationEnum: CREATE, GET, SEARCH, UPDATE

Errors

OTOBOError is raised when the GenericInterface response contains an Error object (code + message).

Source

Full implementation: github.com/openticketai/otobo-znuny-python-client