api.md

Shared

Types:

• ResourceCreated
• ResourceDeleted
• ResourceUpdated

Agents

Types:

• Agent

Methods:

• client.agents.create({ ...params }) -> ResourceCreated
• client.agents.update(agentId, { ...params }) -> ResourceUpdated
• client.agents.list({ ...params }) -> AgentsOffsetPagination
• client.agents.delete(agentId) -> ResourceDeleted
• client.agents.createOrUpdate(agentId, { ...params }) -> ResourceCreated
• client.agents.get(agentId) -> Agent
• client.agents.patch(agentId, { ...params }) -> ResourceUpdated

Tools

Types:

• ToolListResponse

Methods:

• client.agents.tools.create(agentId, { ...params }) -> ResourceCreated
• client.agents.tools.update(agentId, toolId, { ...params }) -> ResourceUpdated
• client.agents.tools.list(agentId, { ...params }) -> ToolListResponsesOffsetPagination
• client.agents.tools.delete(agentId, toolId) -> ResourceDeleted
• client.agents.tools.patch(agentId, toolId, { ...params }) -> ResourceUpdated

Docs

Types:

• DocSearchResponse

Methods:

• client.agents.docs.create(agentId, { ...params }) -> ResourceCreated
• client.agents.docs.list(agentId, { ...params }) -> DocsOffsetPagination
• client.agents.docs.delete(agentId, docId) -> ResourceDeleted
• client.agents.docs.search(agentId, { ...params }) -> DocSearchResponse

Sessions

Types:

• ChatInput
• ChatResponse
• ChatSettings
• Entry
• History
• Message
• Session
• SessionChatResponse

Methods:

• client.sessions.create({ ...params }) -> ResourceCreated
• client.sessions.update(sessionId, { ...params }) -> ResourceUpdated
• client.sessions.list({ ...params }) -> SessionsOffsetPagination
• client.sessions.delete(sessionId) -> ResourceDeleted
• client.sessions.chat(sessionId, { ...params }) -> SessionChatResponse
• client.sessions.createOrUpdate(sessionId, { ...params }) -> ResourceUpdated
• client.sessions.get(sessionId) -> Session
• client.sessions.history(sessionId) -> History
• client.sessions.patch(sessionId, { ...params }) -> ResourceUpdated

Users

Types:

• User

Methods:

• client.users.create({ ...params }) -> ResourceCreated
• client.users.update(userId, { ...params }) -> ResourceUpdated
• client.users.list({ ...params }) -> UsersOffsetPagination
• client.users.delete(userId) -> ResourceDeleted
• client.users.createOrUpdate(userId, { ...params }) -> ResourceCreated
• client.users.get(userId) -> User
• client.users.patch(userId, { ...params }) -> ResourceUpdated

Docs

Types:

• DocSearchResponse

Methods:

• client.users.docs.create(userId, { ...params }) -> ResourceCreated
• client.users.docs.list(userId, { ...params }) -> DocsOffsetPagination
• client.users.docs.delete(userId, docId) -> ResourceDeleted
• client.users.docs.search(userId, { ...params }) -> DocSearchResponse

Jobs

Types:

• JobStatus

Methods:

• client.jobs.get(jobId) -> JobStatus

Docs

Types:

• Doc
• EmbedQueryResponse
• Snippet

Methods:

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

Tasks

Types:

• Task
• Tool

Methods:

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

Executions

Types:

• Execution
• Transition
• ExecutionChangeStatusResponse

Methods:

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

Transitions

Types:

• TransitionStreamResponse

Methods:

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