api.md

Agent

Types:

from warp_platform_sdk.types import (
    AgentConfigSnapshot,
    AgentSkill,
    AwsInferenceProviderConfig,
    AwsProviderConfig,
    Environment,
    EnvironmentConfig,
    Error,
    ErrorCode,
    GcpProviderConfig,
    Harness,
    HarnessAuthSecrets,
    InferenceProvidersConfig,
    McpServerConfig,
    MemoryStoreRef,
    Scope,
    SecretRef,
    SessionSharingConfig,
    UserProfile,
    AgentListResponse,
    AgentGetArtifactResponse,
    AgentGetRunByExternalReferenceResponse,
    AgentListEnvironmentsResponse,
    AgentListModelsResponse,
    AgentRunResponse,
)

Methods:

• client.agent.list(**params) -> AgentListResponse
• client.agent.download_artifact(artifact_uid) -> BinaryAPIResponse
• client.agent.get_artifact(artifact_uid) -> AgentGetArtifactResponse
• client.agent.get_run_by_external_reference(**params) -> AgentGetRunByExternalReferenceResponse
• client.agent.list_environments(**params) -> AgentListEnvironmentsResponse
• client.agent.list_models() -> AgentListModelsResponse
• client.agent.run(**params) -> AgentRunResponse

Runs

Types:

from warp_platform_sdk.types.agent import (
    ArtifactItem,
    ConversationStep,
    RunItem,
    RunSourceType,
    RunState,
    RunCancelResponse,
    RunGetConversationResponse,
    RunGetHarnessUsageResponse,
    RunGetTimelineResponse,
    RunListHandoffAttachmentsResponse,
    RunSubmitFollowupResponse,
)

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.get_conversation(run_id) -> RunGetConversationResponse
• client.agent.runs.get_harness_usage(run_id) -> RunGetHarnessUsageResponse
• client.agent.runs.get_timeline(run_id) -> RunGetTimelineResponse
• client.agent.runs.get_transcript(run_id) -> BinaryAPIResponse
• client.agent.runs.interrupt(run_id) -> object
• client.agent.runs.list_handoff_attachments(run_id) -> RunListHandoffAttachmentsResponse
• client.agent.runs.submit_followup(run_id, **params) -> RunSubmitFollowupResponse

Schedules

Types:

from warp_platform_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 warp_platform_sdk.types.agent import (
    AgentResponse,
    AutoMemoryResponse,
    CreateAgentRequest,
    ListAgentIdentitiesResponse,
    MemoryResponse,
    MemoryStoreAttachmentResponse,
    UpdateAgentRequest,
)

Methods:

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

Sessions

Types:

from warp_platform_sdk.types.agent import SessionCheckRedirectResponse

Methods:

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

Conversations

Types:

from warp_platform_sdk.types.agent import (
    ConversationRetrieveResponse,
    ConversationCheckRedirectResponse,
    ConversationInterruptResponse,
    ConversationSubmitFollowupResponse,
)

Methods:

• client.agent.conversations.retrieve(conversation_id) -> ConversationRetrieveResponse
• client.agent.conversations.check_redirect(conversation_id) -> ConversationCheckRedirectResponse
• client.agent.conversations.download_screenshot(screenshot_uid, *, conversation_id) -> BinaryAPIResponse
• client.agent.conversations.get_transcript(conversation_id) -> BinaryAPIResponse
• client.agent.conversations.interrupt(conversation_id) -> ConversationInterruptResponse
• client.agent.conversations.submit_followup(conversation_id, **params) -> ConversationSubmitFollowupResponse

Networking

Types:

from warp_platform_sdk.types import NetworkingGetEgressRangesResponse

Methods:

• client.networking.get_egress_ranges() -> NetworkingGetEgressRangesResponse

Factories

Types:

from warp_platform_sdk.types import Factory

Methods:

• client.factories.list(**params) -> SyncFactoriesCursorPage[Factory]
• client.factories.get(uid) -> Factory

Runs

Types:

from warp_platform_sdk.types.factories import RunCreateResponse

Methods:

• client.factories.runs.create(uid, **params) -> RunCreateResponse

Tasks

Types:

from warp_platform_sdk.types.factories import Task

Methods:

• client.factories.tasks.create(uid, **params) -> Task
• client.factories.tasks.update(task_uid, *, uid, **params) -> Task
• client.factories.tasks.list(uid, **params) -> SyncFactoryTasksCursorPage[Task]
• client.factories.tasks.delete(task_uid, *, uid) -> None
• client.factories.tasks.cancel(task_uid, *, uid) -> Task
• client.factories.tasks.get(task_uid, *, uid) -> Task
• client.factories.tasks.get_by_conversation(uid, **params) -> Task
• client.factories.tasks.get_by_run(uid, **params) -> Task

Files

Types:

from warp_platform_sdk.types.factories import FileValidateResponse

Methods:

• client.factories.files.validate(**params) -> FileValidateResponse

Schemas

Types:

from warp_platform_sdk.types.factories.files import (
    SchemaRetrieveResponse,
    SchemaListResponse,
    SchemaGetDocumentResponse,
)

Methods:

• client.factories.files.schemas.retrieve(schema_version) -> SchemaRetrieveResponse
• client.factories.files.schemas.list() -> SchemaListResponse
• client.factories.files.schemas.get_document(document, *, schema_version) -> SchemaGetDocumentResponse