api.md

Shared Types

from agentex.types import DeleteResponse

Agents

Types:

from agentex.types import (
    AcpType,
    Agent,
    AgentRpcRequest,
    AgentRpcResponse,
    AgentRpcResult,
    DataDelta,
    ReasoningContentDelta,
    ReasoningSummaryDelta,
    TaskMessageContent,
    TaskMessageDelta,
    TaskMessageUpdate,
    TextDelta,
    ToolRequestDelta,
    ToolResponseDelta,
    AgentListResponse,
)

Methods:

• client.agents.retrieve(agent_id) -> Agent
• client.agents.list(**params) -> AgentListResponse
• client.agents.delete(agent_id) -> DeleteResponse
• client.agents.delete_by_name(agent_name) -> DeleteResponse
• client.agents.retrieve_by_name(agent_name) -> Agent
• client.agents.rpc(agent_id, **params) -> AgentRpcResponse
• client.agents.rpc_by_name(agent_name, **params) -> AgentRpcResponse

Deployments

Types:

from agentex.types.agents import (
    DeploymentCreateResponse,
    DeploymentRetrieveResponse,
    DeploymentListResponse,
    DeploymentPromoteResponse,
)

Methods:

• client.agents.deployments.create(agent_id, **params) -> DeploymentCreateResponse
• client.agents.deployments.retrieve(deployment_id, *, agent_id) -> DeploymentRetrieveResponse
• client.agents.deployments.list(agent_id, **params) -> DeploymentListResponse
• client.agents.deployments.delete(deployment_id, *, agent_id) -> DeleteResponse
• client.agents.deployments.preview_rpc(deployment_id, *, agent_id, **params) -> AgentRpcResponse
• client.agents.deployments.promote(deployment_id, *, agent_id) -> DeploymentPromoteResponse

Schedules

Types:

from agentex.types.agents import (
    ScheduleCreateResponse,
    ScheduleRetrieveResponse,
    ScheduleListResponse,
    SchedulePauseResponse,
    ScheduleTriggerResponse,
    ScheduleUnpauseResponse,
)

Methods:

• client.agents.schedules.create(agent_id, **params) -> ScheduleCreateResponse
• client.agents.schedules.retrieve(schedule_name, *, agent_id) -> ScheduleRetrieveResponse
• client.agents.schedules.list(agent_id, **params) -> ScheduleListResponse
• client.agents.schedules.delete(schedule_name, *, agent_id) -> DeleteResponse
• client.agents.schedules.pause(schedule_name, *, agent_id, **params) -> SchedulePauseResponse
• client.agents.schedules.trigger(schedule_name, *, agent_id) -> ScheduleTriggerResponse
• client.agents.schedules.unpause(schedule_name, *, agent_id, **params) -> ScheduleUnpauseResponse

Tasks

Types:

from agentex.types import (
    Task,
    TaskRetrieveResponse,
    TaskListResponse,
    TaskQueryWorkflowResponse,
    TaskRetrieveByNameResponse,
)

Methods:

• client.tasks.retrieve(task_id, **params) -> TaskRetrieveResponse
• client.tasks.list(**params) -> TaskListResponse
• client.tasks.delete(task_id) -> DeleteResponse
• client.tasks.cancel(task_id, **params) -> Task
• client.tasks.complete(task_id, **params) -> Task
• client.tasks.delete_by_name(task_name) -> DeleteResponse
• client.tasks.fail(task_id, **params) -> Task
• client.tasks.query_workflow(query_name, *, task_id) -> TaskQueryWorkflowResponse
• client.tasks.retrieve_by_name(task_name, **params) -> TaskRetrieveByNameResponse
• client.tasks.stream_events(task_id) -> object
• client.tasks.stream_events_by_name(task_name) -> object
• client.tasks.terminate(task_id, **params) -> Task
• client.tasks.timeout(task_id, **params) -> Task
• client.tasks.update_by_id(task_id, **params) -> Task
• client.tasks.update_by_name(task_name, **params) -> Task

Messages

Types:

from agentex.types import (
    DataContent,
    MessageAuthor,
    MessageStyle,
    ReasoningContent,
    TaskMessage,
    TextContent,
    TextFormat,
    ToolRequestContent,
    ToolResponseContent,
    MessageListResponse,
    MessageListPaginatedResponse,
)

Methods:

• client.messages.create(**params) -> TaskMessage
• client.messages.retrieve(message_id) -> TaskMessage
• client.messages.update(message_id, **params) -> TaskMessage
• client.messages.list(**params) -> MessageListResponse
• client.messages.list_paginated(**params) -> MessageListPaginatedResponse

Batch

Types:

from agentex.types.messages import BatchCreateResponse, BatchUpdateResponse

Methods:

• client.messages.batch.create(**params) -> BatchCreateResponse
• client.messages.batch.update(**params) -> BatchUpdateResponse

Spans

Types:

from agentex.types import Span, SpanListResponse

Methods:

• client.spans.create(**params) -> Span
• client.spans.retrieve(span_id) -> Span
• client.spans.update(span_id, **params) -> Span
• client.spans.list(**params) -> SpanListResponse

States

Types:

from agentex.types import State, StateListResponse

Methods:

• client.states.create(**params) -> State
• client.states.retrieve(state_id) -> State
• client.states.update(state_id, **params) -> State
• client.states.list(**params) -> StateListResponse
• client.states.delete(state_id) -> State

Events

Types:

from agentex.types import Event, EventListResponse

Methods:

• client.events.retrieve(event_id) -> Event
• client.events.list(**params) -> EventListResponse

Tracker

Types:

from agentex.types import AgentTaskTracker, TrackerListResponse

Methods:

• client.tracker.retrieve(tracker_id) -> AgentTaskTracker
• client.tracker.update(tracker_id, **params) -> AgentTaskTracker
• client.tracker.list(**params) -> TrackerListResponse

DeploymentHistory

Types:

from agentex.types import DeploymentHistory, DeploymentHistoryListResponse

Methods:

• client.deployment_history.retrieve(deployment_id) -> DeploymentHistory
• client.deployment_history.list(**params) -> DeploymentHistoryListResponse

Checkpoints

Types:

from agentex.types import CheckpointListResponse, CheckpointGetTupleResponse, CheckpointPutResponse

Methods:

• client.checkpoints.list(**params) -> CheckpointListResponse
• client.checkpoints.delete_thread(**params) -> None
• client.checkpoints.get_tuple(**params) -> Optional[CheckpointGetTupleResponse]
• client.checkpoints.put(**params) -> CheckpointPutResponse
• client.checkpoints.put_writes(**params) -> None