api.md

Agent

Types:

from oz_agent_sdk.types import (
    AgentSkill,
    AmbientAgentConfig,
    AwsProviderConfig,
    CloudEnvironment,
    CloudEnvironmentConfig,
    Error,
    ErrorCode,
    GcpProviderConfig,
    McpServerConfig,
    Scope,
    UserProfile,
    AgentListResponse,
    AgentGetArtifactResponse,
    AgentListEnvironmentsResponse,
    AgentRunResponse,
)

Methods:

• client.agent.list(**params) -> AgentListResponse
• client.agent.get_artifact(artifact_uid) -> AgentGetArtifactResponse
• client.agent.list_environments(**params) -> AgentListEnvironmentsResponse
• client.agent.run(**params) -> AgentRunResponse

Runs

Types:

from oz_agent_sdk.types.agent import (
    ArtifactItem,
    RunItem,
    RunSourceType,
    RunState,
    RunCancelResponse,
    RunListHandoffAttachmentsResponse,
)

Methods:

• client.agent.runs.retrieve(run_id) -> RunItem
• client.agent.runs.list(**params) -> SyncRunsCursorPage[RunItem]
• client.agent.runs.cancel(run_id) -> str
• client.agent.runs.list_handoff_attachments(run_id) -> RunListHandoffAttachmentsResponse
• client.agent.runs.submit_followup(run_id, **params) -> object

Schedules

Types:

from oz_agent_sdk.types.agent import (
    ScheduledAgentHistoryItem,
    ScheduledAgentItem,
    ScheduleListResponse,
    ScheduleDeleteResponse,
)

Methods:

• client.agent.schedules.create(**params) -> ScheduledAgentItem
• client.agent.schedules.retrieve(schedule_id) -> ScheduledAgentItem
• client.agent.schedules.update(schedule_id, **params) -> ScheduledAgentItem
• client.agent.schedules.list() -> ScheduleListResponse
• client.agent.schedules.delete(schedule_id) -> ScheduleDeleteResponse
• client.agent.schedules.pause(schedule_id) -> ScheduledAgentItem
• client.agent.schedules.resume(schedule_id) -> ScheduledAgentItem

Agent

Types:

from oz_agent_sdk.types.agent import (
    AgentResponse,
    CreateAgentRequest,
    ListAgentIdentitiesResponse,
    UpdateAgentRequest,
)

Methods:

• client.agent.agent.create(**params) -> AgentResponse
• client.agent.agent.update(uid, **params) -> AgentResponse
• client.agent.agent.list() -> ListAgentIdentitiesResponse
• client.agent.agent.delete(uid) -> None

Sessions

Types:

from oz_agent_sdk.types.agent import SessionCheckRedirectResponse

Methods:

• client.agent.sessions.check_redirect(session_uuid) -> SessionCheckRedirectResponse

Conversations

Types:

from oz_agent_sdk.types.agent import ConversationCheckRedirectResponse

Methods:

• client.agent.conversations.check_redirect(conversation_id) -> ConversationCheckRedirectResponse