336 lines (256 loc) · 20.8 KB

Shared

Types:

Agents

Types:

Methods:

client.agents.create({ ...params }) -> Agent
client.agents.update(agentId, { ...params }) -> Agent
client.agents.list({ ...params }) -> AgentsOffsetPagination
client.agents.delete(agentId) -> AgentDeleteResponse
client.agents.createOrUpdate(agentId, { ...params }) -> Agent
client.agents.get(agentId) -> Agent
client.agents.listModels({ ...params }) -> AgentListModelsResponse
client.agents.reset(agentId, { ...params }) -> Agent

Tools

Types:

Methods:

client.agents.tools.create(agentId, { ...params }) -> ToolCreateResponse
client.agents.tools.update(agentId, toolId, { ...params }) -> ToolUpdateResponse
client.agents.tools.list(agentId, { ...params }) -> ToolListResponsesOffsetPagination
client.agents.tools.delete(agentId, toolId) -> ToolDeleteResponse
client.agents.tools.reset(agentId, toolId, { ...params }) -> ToolResetResponse

Docs

Types:

Methods:

client.agents.docs.create(agentId, { ...params }) -> Doc
client.agents.docs.list(agentId, { ...params }) -> DocsOffsetPagination
client.agents.docs.delete(agentId, docId) -> DocDeleteResponse
client.agents.docs.bulkDelete(agentId, { ...params }) -> DocBulkDeleteResponse
client.agents.docs.search(agentId, { ...params }) -> DocSearchResponse

Files

Types:

Methods:

client.files.create({ ...params }) -> File
client.files.list() -> FileListResponse
client.files.delete(fileId) -> FileDeleteResponse
client.files.get(fileId) -> File

Sessions

Types:

Methods:

client.sessions.create({ ...params }) -> Session
client.sessions.update(sessionId, { ...params }) -> Session
client.sessions.list({ ...params }) -> SessionsOffsetPagination
client.sessions.delete(sessionId) -> SessionDeleteResponse
client.sessions.chat(sessionId, { ...params }) -> SessionChatResponse
client.sessions.createOrUpdate(sessionId, { ...params }) -> Session
client.sessions.get(sessionId) -> Session
client.sessions.history(sessionId) -> History
client.sessions.render(sessionId, { ...params }) -> SessionRenderResponse
client.sessions.reset(sessionId, { ...params }) -> Session

Users

Types:

User
UserDeleteResponse

Methods:

client.users.create({ ...params }) -> User
client.users.update(userId, { ...params }) -> User
client.users.list({ ...params }) -> UsersOffsetPagination
client.users.delete(userId) -> UserDeleteResponse
client.users.createOrUpdate(userId, { ...params }) -> User
client.users.get(userId) -> User
client.users.reset(userId, { ...params }) -> User

Docs

Types:

Methods:

client.users.docs.create(userId, { ...params }) -> Doc
client.users.docs.list(userId, { ...params }) -> DocsOffsetPagination
client.users.docs.delete(userId, docId) -> DocDeleteResponse
client.users.docs.bulkDelete(userId, { ...params }) -> DocBulkDeleteResponse
client.users.docs.search(userId, { ...params }) -> DocSearchResponse

Jobs

Types:

JobStatus

Methods:

client.jobs.get(jobId) -> JobStatus

Docs

Types:

Methods:

client.docs.embed({ ...params }) -> EmbedQueryResponse
client.docs.get(docId, { ...params }) -> Doc

Tasks

Types:

Methods:

client.tasks.create(agentId, { ...params }) -> Task
client.tasks.list(agentId, { ...params }) -> TasksOffsetPagination
client.tasks.createOrUpdate(agentId, taskId, { ...params }) -> Task
client.tasks.get(taskId) -> Task

Executions

Types:

Methods:

client.executions.create(taskId, { ...params }) -> Execution
client.executions.list(taskId, { ...params }) -> ExecutionsOffsetPagination
client.executions.changeStatus(executionId, { ...params }) -> unknown
client.executions.get(executionId) -> Execution

Transitions

Types:

TransitionStreamResponse

Methods:

client.executions.transitions.retrieve(executionId, transitionId) -> Transition
client.executions.transitions.list(executionId, { ...params }) -> TransitionsOffsetPagination
client.executions.transitions.stream(executionId, { ...params }) -> unknown

Status

Methods:

client.executions.status.get(executionId) -> Execution
client.executions.status.stream(executionId) -> void

Secrets

Types:

Methods:

client.secrets.create({ ...params }) -> Secret
client.secrets.update(secretId, { ...params }) -> Secret
client.secrets.list({ ...params }) -> SecretListResponse
client.secrets.delete(secretId) -> SecretDeleteResponse

Projects

Types:

Methods:

client.projects.create({ ...params }) -> ProjectCreateResponse
client.projects.list({ ...params }) -> ProjectListResponsesOffsetPagination

Healthz

Types:

HealthzCheckResponse

Methods:

client.healthz.check() -> unknown