Python SDK
Python SDK Reference
Complete reference documentation for the Python SDK
Shared Types
Agents
Types:
Methods:
-
client.agents.create(**params) -> ResourceCreated
-
client.agents.update(agent_id, **params) -> ResourceUpdated
-
client.agents.list(**params) -> SyncOffsetPagination[Agent]
-
client.agents.delete(agent_id) -> ResourceDeleted
-
client.agents.create_or_update(agent_id, **params) -> ResourceCreated
-
client.agents.get(agent_id) -> Agent
-
client.agents.reset(agent_id, **params) -> ResourceUpdated
Tools
Types:
Methods:
-
client.agents.tools.create(agent_id, **params) -> ResourceCreated
-
client.agents.tools.update(tool_id, *, agent_id, **params) -> ResourceUpdated
-
client.agents.tools.list(agent_id, **params) -> SyncOffsetPagination[ToolListResponse]
-
client.agents.tools.delete(tool_id, *, agent_id) -> ResourceDeleted
-
client.agents.tools.reset(tool_id, *, agent_id, **params) -> ResourceUpdated
Docs
Types:
Methods:
-
client.agents.docs.create(agent_id, **params) -> ResourceCreated
-
client.agents.docs.list(agent_id, **params) -> SyncOffsetPagination[Doc]
-
client.agents.docs.delete(doc_id, *, agent_id) -> ResourceDeleted
-
client.agents.docs.search(agent_id, **params) -> DocSearchResponse
Files
Types:
Methods:
-
client.files.create(**params) -> ResourceCreated
-
client.files.delete(file_id) -> ResourceDeleted
-
client.files.get(file_id) -> File
Sessions
Types:
Methods:
-
client.sessions.create(**params) -> ResourceCreated
-
client.sessions.update(session_id, **params) -> ResourceUpdated
-
client.sessions.list(**params) -> SyncOffsetPagination[Session]
-
client.sessions.delete(session_id) -> ResourceDeleted
-
client.sessions.chat(session_id, **params) -> SessionChatResponse
-
client.sessions.create_or_update(session_id, **params) -> ResourceUpdated
-
client.sessions.get(session_id) -> Session
-
client.sessions.history(session_id) -> History
-
client.sessions.reset(session_id, **params) -> ResourceUpdated
Users
Types:
Methods:
-
client.users.create(**params) -> ResourceCreated
-
client.users.update(user_id, **params) -> ResourceUpdated
-
client.users.list(**params) -> SyncOffsetPagination[User]
-
client.users.delete(user_id) -> ResourceDeleted
-
client.users.create_or_update(user_id, **params) -> ResourceCreated
-
client.users.get(user_id) -> User
-
client.users.reset(user_id, **params) -> ResourceUpdated
Docs
Types:
Methods:
-
client.users.docs.create(user_id, **params) -> ResourceCreated
-
client.users.docs.list(user_id, **params) -> SyncOffsetPagination[Doc]
-
client.users.docs.delete(doc_id, *, user_id) -> ResourceDeleted
-
client.users.docs.search(user_id, **params) -> DocSearchResponse
Jobs
Types:
Methods:
Docs
Types:
Methods:
-
client.docs.embed(**params) -> EmbedQueryResponse
-
client.docs.get(doc_id) -> Doc
Tasks
Types:
Methods:
-
client.tasks.create(agent_id, **params) -> ResourceCreated
-
client.tasks.list(agent_id, **params) -> SyncOffsetPagination[Task]
-
client.tasks.create_or_update(task_id, *, agent_id, **params) -> ResourceUpdated
-
client.tasks.get(task_id) -> Task
Executions
Types:
Methods:
-
client.executions.create(task_id, **params) -> ResourceCreated
-
client.executions.list(task_id, **params) -> SyncOffsetPagination[Execution]
-
client.executions.change_status(execution_id, **params) -> object
-
client.executions.get(execution_id) -> Execution
Transitions
Types:
Methods: