api.md

Shared

Types:

• AuthorizationContext
• AuthorizationResponse
• Error

Admin

UserConnections

Types:

• UserConnectionResponse

Methods:

• client.admin.userConnections.list({ ...params }) -> UserConnectionResponsesOffsetPage
• client.admin.userConnections.delete(id) -> void

AuthProviders

Types:

• AuthProviderCreateRequest
• AuthProviderResponse
• AuthProviderUpdateRequest
• AuthProviderListResponse

Methods:

• client.admin.authProviders.create({ ...params }) -> AuthProviderResponse
• client.admin.authProviders.list() -> AuthProviderListResponse
• client.admin.authProviders.delete(id) -> AuthProviderResponse
• client.admin.authProviders.get(id) -> AuthProviderResponse
• client.admin.authProviders.patch(id, { ...params }) -> AuthProviderResponse

Secrets

Types:

• SecretResponse
• SecretListResponse

Methods:

• client.admin.secrets.create(secretKey, { ...params }) -> SecretResponse
• client.admin.secrets.list() -> SecretListResponse
• client.admin.secrets.delete(secretID) -> void

Auth

Types:

• AuthRequest
• ConfirmUserRequest
• ConfirmUserResponse

Methods:

• client.auth.authorize({ ...params }) -> AuthorizationResponse
• client.auth.confirmUser({ ...params }) -> ConfirmUserResponse
• client.auth.status({ ...params }) -> AuthorizationResponse

Health

Types:

• HealthSchema

Methods:

• client.health.check() -> HealthSchema

Chat

Types:

• ChatMessage
• ChatRequest
• ChatResponse
• Choice
• Usage

Completions

Methods:

• client.chat.completions.create({ ...params }) -> ChatResponse

Tools

Types:

• AuthorizeToolRequest
• ExecuteToolRequest
• ExecuteToolResponse
• ToolDefinition
• ToolExecution
• ToolExecutionAttempt
• ValueSchema

Methods:

• client.tools.list({ ...params }) -> ToolDefinitionsOffsetPage
• client.tools.authorize({ ...params }) -> AuthorizationResponse
• client.tools.execute({ ...params }) -> ExecuteToolResponse
• client.tools.get(name, { ...params }) -> ToolDefinition

Scheduled

Types:

• ScheduledGetResponse

Methods:

• client.tools.scheduled.list({ ...params }) -> ToolExecutionsOffsetPage
• client.tools.scheduled.get(id) -> ScheduledGetResponse

Formatted

Types:

• FormattedListResponse
• FormattedGetResponse

Methods:

• client.tools.formatted.list({ ...params }) -> FormattedListResponsesOffsetPage
• client.tools.formatted.get(name, { ...params }) -> FormattedGetResponse

Workers

Types:

• CreateWorkerRequest
• UpdateWorkerRequest
• WorkerHealthResponse
• WorkerResponse

Methods:

• client.workers.create({ ...params }) -> WorkerResponse
• client.workers.update(id, { ...params }) -> WorkerResponse
• client.workers.list({ ...params }) -> WorkerResponsesOffsetPage
• client.workers.delete(id) -> void
• client.workers.get(id) -> WorkerResponse
• client.workers.health(id) -> WorkerHealthResponse
• client.workers.tools(id, { ...params }) -> ToolDefinitionsOffsetPage