api.md

Agent

Types:

• 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.downloadArtifact(artifactUid) -> Response
• client.agent.getArtifact(artifactUid) -> AgentGetArtifactResponse
• client.agent.getRunByExternalReference({ ...params }) -> AgentGetRunByExternalReferenceResponse
• client.agent.listEnvironments({ ...params }) -> AgentListEnvironmentsResponse
• client.agent.listModels() -> AgentListModelsResponse
• client.agent.run({ ...params }) -> AgentRunResponse

Runs

Types:

• ArtifactItem
• ConversationStep
• RunItem
• RunSourceType
• RunState
• RunCancelResponse
• RunGetConversationResponse
• RunGetHarnessUsageResponse
• RunGetTimelineResponse
• RunInterruptResponse
• RunListHandoffAttachmentsResponse
• RunSubmitFollowupResponse

Methods:

• client.agent.runs.retrieve(runID) -> RunItem
• client.agent.runs.list({ ...params }) -> RunItemsRunsCursorPage
• client.agent.runs.cancel(runID) -> string
• client.agent.runs.getConversation(runID) -> RunGetConversationResponse
• client.agent.runs.getHarnessUsage(runID) -> RunGetHarnessUsageResponse
• client.agent.runs.getTimeline(runID) -> RunGetTimelineResponse
• client.agent.runs.getTranscript(runID) -> Response
• client.agent.runs.interrupt(runID) -> unknown
• client.agent.runs.listHandoffAttachments(runID) -> RunListHandoffAttachmentsResponse
• client.agent.runs.submitFollowup(runID, { ...params }) -> RunSubmitFollowupResponse

Schedules

Types:

• ScheduledAgentHistoryItem
• ScheduledAgentItem
• ScheduleListResponse
• ScheduleDeleteResponse

Methods:

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

Agent

Types:

• 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) -> void
• client.agent.agent.get(uid) -> AgentResponse

Sessions

Types:

• SessionCheckRedirectResponse

Methods:

• client.agent.sessions.checkRedirect(sessionUuid) -> SessionCheckRedirectResponse

Conversations

Types:

• ConversationRetrieveResponse
• ConversationCheckRedirectResponse
• ConversationInterruptResponse
• ConversationSubmitFollowupResponse

Methods:

• client.agent.conversations.retrieve(conversationID) -> ConversationRetrieveResponse
• client.agent.conversations.checkRedirect(conversationID) -> ConversationCheckRedirectResponse
• client.agent.conversations.downloadScreenshot(screenshotUid, { ...params }) -> Response
• client.agent.conversations.getTranscript(conversationID) -> Response
• client.agent.conversations.interrupt(conversationID) -> ConversationInterruptResponse
• client.agent.conversations.submitFollowup(conversationID, { ...params }) -> ConversationSubmitFollowupResponse

Networking

Types:

• NetworkingGetEgressRangesResponse

Methods:

• client.networking.getEgressRanges({ ...params }) -> NetworkingGetEgressRangesResponse

Factories

Types:

• Factory

Methods:

• client.factories.list({ ...params }) -> FactoriesFactoriesCursorPage
• client.factories.get(uid) -> Factory

Runs

Types:

• RunCreateResponse

Methods:

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

Tasks

Types:

• Task

Methods:

• client.factories.tasks.create(uid, { ...params }) -> Task
• client.factories.tasks.update(taskUid, { ...params }) -> Task
• client.factories.tasks.list(uid, { ...params }) -> TasksFactoryTasksCursorPage
• client.factories.tasks.delete(taskUid, { ...params }) -> void
• client.factories.tasks.cancel(taskUid, { ...params }) -> Task
• client.factories.tasks.get(taskUid, { ...params }) -> Task
• client.factories.tasks.getByConversation(uid, { ...params }) -> Task
• client.factories.tasks.getByRun(uid, { ...params }) -> Task

Files

Types:

• FileValidateResponse

Methods:

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

Schemas

Types:

• SchemaRetrieveResponse
• SchemaListResponse
• SchemaGetDocumentResponse

Methods:

• client.factories.files.schemas.retrieve(schemaVersion, { ...params }) -> SchemaRetrieveResponse
• client.factories.files.schemas.list({ ...params }) -> SchemaListResponse
• client.factories.files.schemas.getDocument(document, { ...params }) -> SchemaGetDocumentResponse