@lumavox/server 0.6.0 → 0.8.0

package/README.md

@@ -1,7 +1,7 @@
 # @lumavox/server
 
 The Lumavox API from your server, with your organisation's API key: speech,
-images and video, voices, your asset library, agents, knowledge, end users
+images and video, voices, your asset library, agents, knowledge, tools, end users
 and the ephemeral keys their devices talk to agents with — every operation
 a key may call, typed from the published OpenAPI document. **Zero
 dependencies**: `fetch` and the web platform only — Node 20.3 or later,
@@ -68,7 +68,8 @@ list's page.
 | `tts`, `stt` | `create` |
 | `voices` | `list`, `page`, `get`, `create`, `uploadUrl`, `upload`, `update`, `delete`, `resample`, `design`, `saveDesign`, `wait` |
 | `assets` | `list`, `page`, `get`, `uploadUrl`, `confirm`, `upload`, `update`, `delete`, `deleteMany`, `move`, `wait`; `assets.folders.*` |
-| `agents` | `list`, `page`, `get`, `create`, `update`, `delete`; `agents.settings.get/update`; `agents.knowledge.list/set` |
+| `agents` | `list`, `page`, `get`, `create`, `update`, `delete`; `agents.settings.get/update`; `agents.knowledge.list/set`; `agents.tools.list/set` |
+| `tools` | `list`, `page`, `get`, `create` (a webhook's signing secret, shown once), `update`, `delete`, `rotateSecret`, `test` |
 | `knowledge` | `list`, `page`, `get`, `create`, `bulk`, `fromUrl`, `uploadUrl`, `fromFile`, `upload`, `update`, `delete`, `reindex`, `refresh`, `setAgents`, `search`, `categories`, `insights`, `wait` |
 | `usage` | `get`, `plan` |
 | the client | `health()` |

package/dist/client.d.ts

@@ -20,6 +20,7 @@ import { Generations, Jobs, Skybox } from "./resources/generations.js";
 import { Knowledge } from "./resources/knowledge.js";
 import { Stt, Tts } from "./resources/speech.js";
 import { Templates } from "./resources/templates.js";
+import { Tools } from "./resources/tools.js";
 import { Usage } from "./resources/usage.js";
 import { Voices } from "./resources/voices.js";
 import { type Fetch, type RequestOptions } from "./transport.js";
@@ -53,6 +54,7 @@ export interface Client {
     readonly assets: Assets;
     readonly agents: Agents;
     readonly knowledge: Knowledge;
+    readonly tools: Tools;
     /** Whether the API is up, and its version. Sends no key. */
     health(options?: RequestOptions): Promise<HealthResponse>;
 }

package/dist/client.js

@@ -6,6 +6,7 @@ import { Generations, Jobs, Skybox } from "./resources/generations.js";
 import { Knowledge } from "./resources/knowledge.js";
 import { Stt, Tts } from "./resources/speech.js";
 import { Templates } from "./resources/templates.js";
+import { Tools } from "./resources/tools.js";
 import { Usage } from "./resources/usage.js";
 import { Voices } from "./resources/voices.js";
 import { REFUSAL, refusedHere } from "./runtime.js";
@@ -45,6 +46,7 @@ export function createClient(options) {
         assets: new Assets(transport, "/v1/assets"),
         agents: new Agents(transport, "/v1/agents"),
         knowledge: new Knowledge(transport, "/v1/knowledge"),
+        tools: new Tools(transport, "/v1/tools"),
         health: (request) => transport
             .request({ method: "GET", path: "/health", open: true }, request)
             .then((answer) => answer.data),

package/dist/gen/index.d.ts

@@ -1 +1 @@
-export type { AgentCreateRequest, AgentInfo, AgentKnowledgeUpdate, AgentPage, AgentSettingsInfo, AgentSettingsUpdate, AgentStt, AgentSttInfo, AgentSummary, AgentUpdate, AgentVoice, AgentVoiceInfo, ApiKeySelf, AssetBulkRequest, AssetDetail, AssetMoveRequest, AssetPage, AssetsAffected, AssetSummary, AssetUpdate, AssignedAgent, AudioRequest, BulkEditKnowledgeData, BulkEditKnowledgeError, BulkEditKnowledgeErrors, BulkEditKnowledgeResponse, BulkEditKnowledgeResponses, ClientOptions, CompactionInfo, CompactRequest, CompactSessionData, CompactSessionError, CompactSessionErrors, CompactSessionResponse, CompactSessionResponses, ConfirmAssetUploadData, ConfirmAssetUploadError, ConfirmAssetUploadErrors, ConfirmAssetUploadResponse, ConfirmAssetUploadResponses, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentResponse, CreateAgentResponses, CreateAssetFolderData, CreateAssetFolderError, CreateAssetFolderErrors, CreateAssetFolderResponse, CreateAssetFolderResponses, CreateAssetUploadUrlData, CreateAssetUploadUrlError, CreateAssetUploadUrlErrors, CreateAssetUploadUrlResponse, CreateAssetUploadUrlResponses, CreateAudioData, CreateAudioError, CreateAudioErrors, CreateAudioResponse, CreateAudioResponses, CreateEndUserData, CreateEndUserError, CreateEndUserErrors, CreateEndUserResponse, CreateEndUserResponses, CreateEphemeralKeyData, CreateEphemeralKeyError, CreateEphemeralKeyErrors, CreateEphemeralKeyResponse, CreateEphemeralKeyResponses, CreateImageData, CreateImageError, CreateImageErrors, CreateImageResponse, CreateImageResponses, CreateKnowledgeData, CreateKnowledgeError, CreateKnowledgeErrors, CreateKnowledgeFromFileData, CreateKnowledgeFromFileError, CreateKnowledgeFromFileErrors, CreateKnowledgeFromFileResponse, CreateKnowledgeFromFileResponses, CreateKnowledgeFromUrlData, CreateKnowledgeFromUrlError, CreateKnowledgeFromUrlErrors, CreateKnowledgeFromUrlResponse, CreateKnowledgeFromUrlResponses, CreateKnowledgeResponse, CreateKnowledgeResponses, CreateKnowledgeUploadUrlData, CreateKnowledgeUploadUrlError, CreateKnowledgeUploadUrlErrors, CreateKnowledgeUploadUrlResponse, CreateKnowledgeUploadUrlResponses, CreateSessionData, CreateSessionError, CreateSessionErrors, CreateSessionResponse, CreateSessionResponses, CreateSkyboxData, CreateSkyboxError, CreateSkyboxErrors, CreateSkyboxResponse, CreateSkyboxResponses, CreateTranscriptionData, CreateTranscriptionError, CreateTranscriptionErrors, CreateTranscriptionResponse, CreateTranscriptionResponses, CreateVideoData, CreateVideoError, CreateVideoErrors, CreateVideoResponse, CreateVideoResponses, CreateVoiceData, CreateVoiceError, CreateVoiceErrors, CreateVoiceResponse, CreateVoiceResponses, CreateVoiceUploadUrlData, CreateVoiceUploadUrlError, CreateVoiceUploadUrlErrors, CreateVoiceUploadUrlResponse, CreateVoiceUploadUrlResponses, DeleteAgentData, DeleteAgentError, DeleteAgentErrors, DeleteAgentResponse, DeleteAgentResponses, DeleteAllFactsData, DeleteAllFactsError, DeleteAllFactsErrors, DeleteAllFactsResponse, DeleteAllFactsResponses, DeleteAssetData, DeleteAssetError, DeleteAssetErrors, DeleteAssetFolderData, DeleteAssetFolderError, DeleteAssetFolderErrors, DeleteAssetFolderResponse, DeleteAssetFolderResponses, DeleteAssetResponse, DeleteAssetResponses, DeleteAssetsData, DeleteAssetsError, DeleteAssetsErrors, DeleteAssetsResponse, DeleteAssetsResponses, DeleteEndUserData, DeleteEndUserError, DeleteEndUserErrors, DeleteEndUserResponse, DeleteEndUserResponses, DeleteFactData, DeleteFactError, DeleteFactErrors, DeleteFactResponse, DeleteFactResponses, DeleteKnowledgeData, DeleteKnowledgeError, DeleteKnowledgeErrors, DeleteKnowledgeResponse, DeleteKnowledgeResponses, DeleteSessionData, DeleteSessionError, DeleteSessionErrors, DeleteSessionResponse, DeleteSessionResponses, DeleteVoiceData, DeleteVoiceError, DeleteVoiceErrors, DeleteVoiceResponse, DeleteVoiceResponses, DesignVoiceData, DesignVoiceError, DesignVoiceErrors, DesignVoiceResponse, DesignVoiceResponses, EndUserCreateRequest, EndUserDeleted, EndUserInfo, EndUserPage, EndUserUpdateRequest, EphemeralKeyCreateRequest, EphemeralKeyCreateResponse, EphemeralKeyInfo, EphemeralKeyLimits, EphemeralKeyPage, EphemeralTokenSelf, ErrorCode, ErrorInfo, ErrorResponse, ExtractSessionFactsData, ExtractSessionFactsError, ExtractSessionFactsErrors, ExtractSessionFactsResponse, ExtractSessionFactsResponses, FactInfo, FactPage, FactsDeleted, FolderCreate, FolderDeleted, FolderDetail, FolderPage, FolderSummary, FolderUpdate, GenerateFromTemplateData, GenerateFromTemplateError, GenerateFromTemplateErrors, GenerateFromTemplateResponse, GenerateFromTemplateResponses, GenerationAudio, GenerationImage, GenerationInfo, GenerationPage, GenerationSkybox, GenerationTranscript, GenerationVideo, GetAgentData, GetAgentError, GetAgentErrors, GetAgentResponse, GetAgentResponses, GetAgentSettingsData, GetAgentSettingsError, GetAgentSettingsErrors, GetAgentSettingsResponse, GetAgentSettingsResponses, GetAssetData, GetAssetError, GetAssetErrors, GetAssetFolderData, GetAssetFolderError, GetAssetFolderErrors, GetAssetFolderResponse, GetAssetFolderResponses, GetAssetResponse, GetAssetResponses, GetAudioData, GetAudioError, GetAudioErrors, GetAudioResponse, GetAudioResponses, GetEndUserData, GetEndUserError, GetEndUserErrors, GetEndUserResponse, GetEndUserResponses, GetEphemeralKeyData, GetEphemeralKeyError, GetEphemeralKeyErrors, GetEphemeralKeyLimitsData, GetEphemeralKeyLimitsError, GetEphemeralKeyLimitsErrors, GetEphemeralKeyLimitsResponse, GetEphemeralKeyLimitsResponses, GetEphemeralKeyResponse, GetEphemeralKeyResponses, GetGenerationData, GetGenerationError, GetGenerationErrors, GetGenerationResponse, GetGenerationResponses, GetHealthData, GetHealthResponse, GetHealthResponses, GetImageData, GetImageError, GetImageErrors, GetImageResponse, GetImageResponses, GetKnowledgeData, GetKnowledgeError, GetKnowledgeErrors, GetKnowledgeInsightsData, GetKnowledgeInsightsError, GetKnowledgeInsightsErrors, GetKnowledgeInsightsResponse, GetKnowledgeInsightsResponses, GetKnowledgeResponse, GetKnowledgeResponses, GetPlanData, GetPlanError, GetPlanErrors, GetPlanResponse, GetPlanResponses, GetSessionData, GetSessionError, GetSessionErrors, GetSessionResponse, GetSessionResponses, GetSkyboxData, GetSkyboxError, GetSkyboxErrors, GetSkyboxResponse, GetSkyboxResponses, GetTemplateData, GetTemplateError, GetTemplateErrors, GetTemplateFileData, GetTemplateFileError, GetTemplateFileErrors, GetTemplateFileResponses, GetTemplateResponse, GetTemplateResponses, GetTokenData, GetTokenError, GetTokenErrors, GetTokenResponse, GetTokenResponses, GetTranscriptionData, GetTranscriptionError, GetTranscriptionErrors, GetTranscriptionResponse, GetTranscriptionResponses, GetUsageData, GetUsageError, GetUsageErrors, GetUsageResponse, GetUsageResponses, GetVideoData, GetVideoError, GetVideoErrors, GetVideoResponse, GetVideoResponses, GetVoiceData, GetVoiceError, GetVoiceErrors, GetVoiceResponse, GetVoiceResponses, HealthResponse, ImageRequest, KnowledgeAgentsUpdate, KnowledgeAssigned, KnowledgeBulk, KnowledgeBulkResult, KnowledgeCategoryPage, KnowledgeCitation, KnowledgeCreate, KnowledgeEntryUsage, KnowledgeFileCreate, KnowledgeInfo, KnowledgeInsights, KnowledgeLookupInfo, KnowledgePage, KnowledgeSearchHit, KnowledgeSearchRequest, KnowledgeSearchResult, KnowledgeUpdate, KnowledgeUploadRequest, KnowledgeUploadTicket, KnowledgeUrlCreate, ListAgentKnowledgeData, ListAgentKnowledgeError, ListAgentKnowledgeErrors, ListAgentKnowledgeResponse, ListAgentKnowledgeResponses, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListAssetFoldersData, ListAssetFoldersError, ListAssetFoldersErrors, ListAssetFoldersResponse, ListAssetFoldersResponses, ListAssetsData, ListAssetsError, ListAssetsErrors, ListAssetsResponse, ListAssetsResponses, ListEndUsersData, ListEndUsersError, ListEndUsersErrors, ListEndUsersResponse, ListEndUsersResponses, ListEphemeralKeysData, ListEphemeralKeysError, ListEphemeralKeysErrors, ListEphemeralKeysResponse, ListEphemeralKeysResponses, ListFactsData, ListFactsError, ListFactsErrors, ListFactsResponse, ListFactsResponses, ListGenerationsData, ListGenerationsError, ListGenerationsErrors, ListGenerationsResponse, ListGenerationsResponses, ListKnowledgeCategoriesData, ListKnowledgeCategoriesError, ListKnowledgeCategoriesErrors, ListKnowledgeCategoriesResponse, ListKnowledgeCategoriesResponses, ListKnowledgeData, ListKnowledgeError, ListKnowledgeErrors, ListKnowledgeResponse, ListKnowledgeResponses, ListRelationsData, ListRelationsError, ListRelationsErrors, ListRelationsResponse, ListRelationsResponses, ListSessionsData, ListSessionsError, ListSessionsErrors, ListSessionsResponse, ListSessionsResponses, ListSkyboxStylesData, ListSkyboxStylesError, ListSkyboxStylesErrors, ListSkyboxStylesResponse, ListSkyboxStylesResponses, ListTemplatesData, ListTemplatesError, ListTemplatesErrors, ListTemplatesResponse, ListTemplatesResponses, ListVoicesData, ListVoicesError, ListVoicesErrors, ListVoicesResponse, ListVoicesResponses, MessageInfo, MessageKnowledge, MessagePage, MoveAssetsData, MoveAssetsError, MoveAssetsErrors, MoveAssetsResponse, MoveAssetsResponses, OrgPlan, ProviderVoiceSettings, ProviderVoiceSettingsInfo, Reference, RefreshKnowledgeData, RefreshKnowledgeError, RefreshKnowledgeErrors, RefreshKnowledgeResponse, RefreshKnowledgeResponses, ReindexKnowledgeData, ReindexKnowledgeError, ReindexKnowledgeErrors, ReindexKnowledgeResponse, ReindexKnowledgeResponses, RelationInfo, RelationPage, ResampleVoiceData, ResampleVoiceError, ResampleVoiceErrors, ResampleVoiceResponse, ResampleVoiceResponses, RevokeEphemeralKeyData, RevokeEphemeralKeyError, RevokeEphemeralKeyErrors, RevokeEphemeralKeyResponse, RevokeEphemeralKeyResponses, SaveDesignedVoiceData, SaveDesignedVoiceError, SaveDesignedVoiceErrors, SaveDesignedVoiceResponse, SaveDesignedVoiceResponses, SearchKnowledgeData, SearchKnowledgeError, SearchKnowledgeErrors, SearchKnowledgeResponse, SearchKnowledgeResponses, SessionCreateRequest, SessionDetail, SessionInfo, SessionPage, SetAgentKnowledgeData, SetAgentKnowledgeError, SetAgentKnowledgeErrors, SetAgentKnowledgeResponse, SetAgentKnowledgeResponses, SetKnowledgeAgentsData, SetKnowledgeAgentsError, SetKnowledgeAgentsErrors, SetKnowledgeAgentsResponse, SetKnowledgeAgentsResponses, SkyboxFile, SkyboxRequest, SkyboxStyle, SkyboxStylePage, SpeechProvider, StreamDone, StreamError, StreamSegment, StreamTranscript, SynthesizeSpeechData, SynthesizeSpeechError, SynthesizeSpeechErrors, SynthesizeSpeechResponse, SynthesizeSpeechResponses, TemplateGenerateRequest, TemplateInfo, TemplateInput, TemplatePage, TokenSelf, TranscribeAssetRequest, TranscribeData, TranscribeError, TranscribeErrors, TranscribeResponse, TranscribeResponses, Transcription, TranscriptionStreamLine, TranscriptWord, TtsOptions, TtsRequest, UnansweredQuestion, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentResponse, UpdateAgentResponses, UpdateAgentSettingsData, UpdateAgentSettingsError, UpdateAgentSettingsErrors, UpdateAgentSettingsResponse, UpdateAgentSettingsResponses, UpdateAssetData, UpdateAssetError, UpdateAssetErrors, UpdateAssetFolderData, UpdateAssetFolderError, UpdateAssetFolderErrors, UpdateAssetFolderResponse, UpdateAssetFolderResponses, UpdateAssetResponse, UpdateAssetResponses, UpdateEndUserData, UpdateEndUserError, UpdateEndUserErrors, UpdateEndUserResponse, UpdateEndUserResponses, UpdateKnowledgeData, UpdateKnowledgeError, UpdateKnowledgeErrors, UpdateKnowledgeResponse, UpdateKnowledgeResponses, UpdateVoiceData, UpdateVoiceError, UpdateVoiceErrors, UpdateVoiceResponse, UpdateVoiceResponses, UploadConfirm, UploadTicket, UploadTicketRequest, UsageByKey, UsageDay, UsageResponse, UsageSummary, ValidationIssue, VariantInfo, VideoRequest, VoiceDesignPreview, VoiceDesignRequest, VoiceDesignResult, VoiceDesignSaveRequest, VoiceDetail, VoiceInfo, VoiceInfoPage, VoiceKind, VoiceSample, VoiceSource, VoiceStatus, VoiceUpdate, VoiceUpload, VoiceUploadRequest, VoiceUploadTicket } from './types.gen.js';
+export type { AgentCreateRequest, AgentInfo, AgentKnowledgeUpdate, AgentPage, AgentSettingsInfo, AgentSettingsUpdate, AgentStt, AgentSttInfo, AgentSummary, AgentToolsUpdate, AgentUpdate, AgentVoice, AgentVoiceInfo, ApiKeySelf, AssetBulkRequest, AssetDetail, AssetMoveRequest, AssetPage, AssetsAffected, AssetSummary, AssetUpdate, AssignedAgent, AudioRequest, BulkEditKnowledgeData, BulkEditKnowledgeError, BulkEditKnowledgeErrors, BulkEditKnowledgeResponse, BulkEditKnowledgeResponses, ClientOptions, CompactionInfo, CompactRequest, CompactSessionData, CompactSessionError, CompactSessionErrors, CompactSessionResponse, CompactSessionResponses, ConfirmAssetUploadData, ConfirmAssetUploadError, ConfirmAssetUploadErrors, ConfirmAssetUploadResponse, ConfirmAssetUploadResponses, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentResponse, CreateAgentResponses, CreateAssetFolderData, CreateAssetFolderError, CreateAssetFolderErrors, CreateAssetFolderResponse, CreateAssetFolderResponses, CreateAssetUploadUrlData, CreateAssetUploadUrlError, CreateAssetUploadUrlErrors, CreateAssetUploadUrlResponse, CreateAssetUploadUrlResponses, CreateAudioData, CreateAudioError, CreateAudioErrors, CreateAudioResponse, CreateAudioResponses, CreateEndUserData, CreateEndUserError, CreateEndUserErrors, CreateEndUserResponse, CreateEndUserResponses, CreateEphemeralKeyData, CreateEphemeralKeyError, CreateEphemeralKeyErrors, CreateEphemeralKeyResponse, CreateEphemeralKeyResponses, CreateImageData, CreateImageError, CreateImageErrors, CreateImageResponse, CreateImageResponses, CreateKnowledgeData, CreateKnowledgeError, CreateKnowledgeErrors, CreateKnowledgeFromFileData, CreateKnowledgeFromFileError, CreateKnowledgeFromFileErrors, CreateKnowledgeFromFileResponse, CreateKnowledgeFromFileResponses, CreateKnowledgeFromUrlData, CreateKnowledgeFromUrlError, CreateKnowledgeFromUrlErrors, CreateKnowledgeFromUrlResponse, CreateKnowledgeFromUrlResponses, CreateKnowledgeResponse, CreateKnowledgeResponses, CreateKnowledgeUploadUrlData, CreateKnowledgeUploadUrlError, CreateKnowledgeUploadUrlErrors, CreateKnowledgeUploadUrlResponse, CreateKnowledgeUploadUrlResponses, CreateSessionData, CreateSessionError, CreateSessionErrors, CreateSessionResponse, CreateSessionResponses, CreateSkyboxData, CreateSkyboxError, CreateSkyboxErrors, CreateSkyboxResponse, CreateSkyboxResponses, CreateToolData, CreateToolError, CreateToolErrors, CreateToolResponse, CreateToolResponses, CreateTranscriptionData, CreateTranscriptionError, CreateTranscriptionErrors, CreateTranscriptionResponse, CreateTranscriptionResponses, CreateVideoData, CreateVideoError, CreateVideoErrors, CreateVideoResponse, CreateVideoResponses, CreateVoiceData, CreateVoiceError, CreateVoiceErrors, CreateVoiceResponse, CreateVoiceResponses, CreateVoiceUploadUrlData, CreateVoiceUploadUrlError, CreateVoiceUploadUrlErrors, CreateVoiceUploadUrlResponse, CreateVoiceUploadUrlResponses, DeleteAgentData, DeleteAgentError, DeleteAgentErrors, DeleteAgentResponse, DeleteAgentResponses, DeleteAllFactsData, DeleteAllFactsError, DeleteAllFactsErrors, DeleteAllFactsResponse, DeleteAllFactsResponses, DeleteAssetData, DeleteAssetError, DeleteAssetErrors, DeleteAssetFolderData, DeleteAssetFolderError, DeleteAssetFolderErrors, DeleteAssetFolderResponse, DeleteAssetFolderResponses, DeleteAssetResponse, DeleteAssetResponses, DeleteAssetsData, DeleteAssetsError, DeleteAssetsErrors, DeleteAssetsResponse, DeleteAssetsResponses, DeleteEndUserData, DeleteEndUserError, DeleteEndUserErrors, DeleteEndUserResponse, DeleteEndUserResponses, DeleteFactData, DeleteFactError, DeleteFactErrors, DeleteFactResponse, DeleteFactResponses, DeleteKnowledgeData, DeleteKnowledgeError, DeleteKnowledgeErrors, DeleteKnowledgeResponse, DeleteKnowledgeResponses, DeleteSessionData, DeleteSessionError, DeleteSessionErrors, DeleteSessionResponse, DeleteSessionResponses, DeleteToolData, DeleteToolError, DeleteToolErrors, DeleteToolResponse, DeleteToolResponses, DeleteVoiceData, DeleteVoiceError, DeleteVoiceErrors, DeleteVoiceResponse, DeleteVoiceResponses, DesignVoiceData, DesignVoiceError, DesignVoiceErrors, DesignVoiceResponse, DesignVoiceResponses, EndUserCreateRequest, EndUserDeleted, EndUserInfo, EndUserPage, EndUserUpdateRequest, EphemeralKeyCreateRequest, EphemeralKeyCreateResponse, EphemeralKeyInfo, EphemeralKeyLimits, EphemeralKeyPage, EphemeralTokenSelf, ErrorCode, ErrorInfo, ErrorResponse, ExtractSessionFactsData, ExtractSessionFactsError, ExtractSessionFactsErrors, ExtractSessionFactsResponse, ExtractSessionFactsResponses, FactInfo, FactPage, FactsDeleted, FolderCreate, FolderDeleted, FolderDetail, FolderPage, FolderSummary, FolderUpdate, GenerateFromTemplateData, GenerateFromTemplateError, GenerateFromTemplateErrors, GenerateFromTemplateResponse, GenerateFromTemplateResponses, GenerationAudio, GenerationImage, GenerationInfo, GenerationPage, GenerationSkybox, GenerationTranscript, GenerationVideo, GetAgentData, GetAgentError, GetAgentErrors, GetAgentResponse, GetAgentResponses, GetAgentSettingsData, GetAgentSettingsError, GetAgentSettingsErrors, GetAgentSettingsResponse, GetAgentSettingsResponses, GetAssetData, GetAssetError, GetAssetErrors, GetAssetFolderData, GetAssetFolderError, GetAssetFolderErrors, GetAssetFolderResponse, GetAssetFolderResponses, GetAssetResponse, GetAssetResponses, GetAudioData, GetAudioError, GetAudioErrors, GetAudioResponse, GetAudioResponses, GetEndUserData, GetEndUserError, GetEndUserErrors, GetEndUserResponse, GetEndUserResponses, GetEphemeralKeyData, GetEphemeralKeyError, GetEphemeralKeyErrors, GetEphemeralKeyLimitsData, GetEphemeralKeyLimitsError, GetEphemeralKeyLimitsErrors, GetEphemeralKeyLimitsResponse, GetEphemeralKeyLimitsResponses, GetEphemeralKeyResponse, GetEphemeralKeyResponses, GetGenerationData, GetGenerationError, GetGenerationErrors, GetGenerationResponse, GetGenerationResponses, GetHealthData, GetHealthResponse, GetHealthResponses, GetImageData, GetImageError, GetImageErrors, GetImageResponse, GetImageResponses, GetKnowledgeData, GetKnowledgeError, GetKnowledgeErrors, GetKnowledgeInsightsData, GetKnowledgeInsightsError, GetKnowledgeInsightsErrors, GetKnowledgeInsightsResponse, GetKnowledgeInsightsResponses, GetKnowledgeResponse, GetKnowledgeResponses, GetPlanData, GetPlanError, GetPlanErrors, GetPlanResponse, GetPlanResponses, GetSessionData, GetSessionError, GetSessionErrors, GetSessionResponse, GetSessionResponses, GetSkyboxData, GetSkyboxError, GetSkyboxErrors, GetSkyboxResponse, GetSkyboxResponses, GetTemplateData, GetTemplateError, GetTemplateErrors, GetTemplateFileData, GetTemplateFileError, GetTemplateFileErrors, GetTemplateFileResponses, GetTemplateResponse, GetTemplateResponses, GetTokenData, GetTokenError, GetTokenErrors, GetTokenResponse, GetTokenResponses, GetToolData, GetToolError, GetToolErrors, GetToolResponse, GetToolResponses, GetTranscriptionData, GetTranscriptionError, GetTranscriptionErrors, GetTranscriptionResponse, GetTranscriptionResponses, GetUsageData, GetUsageError, GetUsageErrors, GetUsageResponse, GetUsageResponses, GetVideoData, GetVideoError, GetVideoErrors, GetVideoResponse, GetVideoResponses, GetVoiceData, GetVoiceError, GetVoiceErrors, GetVoiceResponse, GetVoiceResponses, HealthResponse, ImageRequest, KnowledgeAgentsUpdate, KnowledgeAssigned, KnowledgeBulk, KnowledgeBulkResult, KnowledgeCategoryPage, KnowledgeCitation, KnowledgeCreate, KnowledgeEntryUsage, KnowledgeFileCreate, KnowledgeInfo, KnowledgeInsights, KnowledgeLookupInfo, KnowledgePage, KnowledgeSearchHit, KnowledgeSearchRequest, KnowledgeSearchResult, KnowledgeUpdate, KnowledgeUploadRequest, KnowledgeUploadTicket, KnowledgeUrlCreate, ListAgentKnowledgeData, ListAgentKnowledgeError, ListAgentKnowledgeErrors, ListAgentKnowledgeResponse, ListAgentKnowledgeResponses, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListAgentToolsData, ListAgentToolsError, ListAgentToolsErrors, ListAgentToolsResponse, ListAgentToolsResponses, ListAssetFoldersData, ListAssetFoldersError, ListAssetFoldersErrors, ListAssetFoldersResponse, ListAssetFoldersResponses, ListAssetsData, ListAssetsError, ListAssetsErrors, ListAssetsResponse, ListAssetsResponses, ListEndUsersData, ListEndUsersError, ListEndUsersErrors, ListEndUsersResponse, ListEndUsersResponses, ListEphemeralKeysData, ListEphemeralKeysError, ListEphemeralKeysErrors, ListEphemeralKeysResponse, ListEphemeralKeysResponses, ListFactsData, ListFactsError, ListFactsErrors, ListFactsResponse, ListFactsResponses, ListGenerationsData, ListGenerationsError, ListGenerationsErrors, ListGenerationsResponse, ListGenerationsResponses, ListKnowledgeCategoriesData, ListKnowledgeCategoriesError, ListKnowledgeCategoriesErrors, ListKnowledgeCategoriesResponse, ListKnowledgeCategoriesResponses, ListKnowledgeData, ListKnowledgeError, ListKnowledgeErrors, ListKnowledgeResponse, ListKnowledgeResponses, ListRelationsData, ListRelationsError, ListRelationsErrors, ListRelationsResponse, ListRelationsResponses, ListSessionsData, ListSessionsError, ListSessionsErrors, ListSessionsResponse, ListSessionsResponses, ListSkyboxStylesData, ListSkyboxStylesError, ListSkyboxStylesErrors, ListSkyboxStylesResponse, ListSkyboxStylesResponses, ListTemplatesData, ListTemplatesError, ListTemplatesErrors, ListTemplatesResponse, ListTemplatesResponses, ListToolsData, ListToolsError, ListToolsErrors, ListToolsResponse, ListToolsResponses, ListVoicesData, ListVoicesError, ListVoicesErrors, ListVoicesResponse, ListVoicesResponses, MessageInfo, MessageKnowledge, MessagePage, MessageToolCall, MoveAssetsData, MoveAssetsError, MoveAssetsErrors, MoveAssetsResponse, MoveAssetsResponses, OrgPlan, ProviderVoiceSettings, ProviderVoiceSettingsInfo, Reference, RefreshKnowledgeData, RefreshKnowledgeError, RefreshKnowledgeErrors, RefreshKnowledgeResponse, RefreshKnowledgeResponses, ReindexKnowledgeData, ReindexKnowledgeError, ReindexKnowledgeErrors, ReindexKnowledgeResponse, ReindexKnowledgeResponses, RelationInfo, RelationPage, ResampleVoiceData, ResampleVoiceError, ResampleVoiceErrors, ResampleVoiceResponse, ResampleVoiceResponses, RevokeEphemeralKeyData, RevokeEphemeralKeyError, RevokeEphemeralKeyErrors, RevokeEphemeralKeyResponse, RevokeEphemeralKeyResponses, RotateToolSecretData, RotateToolSecretError, RotateToolSecretErrors, RotateToolSecretResponse, RotateToolSecretResponses, SaveDesignedVoiceData, SaveDesignedVoiceError, SaveDesignedVoiceErrors, SaveDesignedVoiceResponse, SaveDesignedVoiceResponses, SearchKnowledgeData, SearchKnowledgeError, SearchKnowledgeErrors, SearchKnowledgeResponse, SearchKnowledgeResponses, SessionCreateRequest, SessionDetail, SessionInfo, SessionPage, SetAgentKnowledgeData, SetAgentKnowledgeError, SetAgentKnowledgeErrors, SetAgentKnowledgeResponse, SetAgentKnowledgeResponses, SetAgentToolsData, SetAgentToolsError, SetAgentToolsErrors, SetAgentToolsResponse, SetAgentToolsResponses, SetKnowledgeAgentsData, SetKnowledgeAgentsError, SetKnowledgeAgentsErrors, SetKnowledgeAgentsResponse, SetKnowledgeAgentsResponses, SkyboxFile, SkyboxRequest, SkyboxStyle, SkyboxStylePage, SpeechProvider, StreamDone, StreamError, StreamSegment, StreamTranscript, SynthesizeSpeechData, SynthesizeSpeechError, SynthesizeSpeechErrors, SynthesizeSpeechResponse, SynthesizeSpeechResponses, TemplateGenerateRequest, TemplateInfo, TemplateInput, TemplatePage, TestToolData, TestToolError, TestToolErrors, TestToolResponse, TestToolResponses, TokenSelf, ToolCreate, ToolInfo, ToolPage, ToolsAssigned, ToolTestRequest, ToolTestResult, ToolUpdate, ToolWithSecret, TranscribeAssetRequest, TranscribeData, TranscribeError, TranscribeErrors, TranscribeResponse, TranscribeResponses, Transcription, TranscriptionStreamLine, TranscriptWord, TtsOptions, TtsRequest, UnansweredQuestion, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentResponse, UpdateAgentResponses, UpdateAgentSettingsData, UpdateAgentSettingsError, UpdateAgentSettingsErrors, UpdateAgentSettingsResponse, UpdateAgentSettingsResponses, UpdateAssetData, UpdateAssetError, UpdateAssetErrors, UpdateAssetFolderData, UpdateAssetFolderError, UpdateAssetFolderErrors, UpdateAssetFolderResponse, UpdateAssetFolderResponses, UpdateAssetResponse, UpdateAssetResponses, UpdateEndUserData, UpdateEndUserError, UpdateEndUserErrors, UpdateEndUserResponse, UpdateEndUserResponses, UpdateKnowledgeData, UpdateKnowledgeError, UpdateKnowledgeErrors, UpdateKnowledgeResponse, UpdateKnowledgeResponses, UpdateToolData, UpdateToolError, UpdateToolErrors, UpdateToolResponse, UpdateToolResponses, UpdateVoiceData, UpdateVoiceError, UpdateVoiceErrors, UpdateVoiceResponse, UpdateVoiceResponses, UploadConfirm, UploadTicket, UploadTicketRequest, UsageByKey, UsageDay, UsageResponse, UsageSummary, ValidationIssue, VariantInfo, VideoRequest, VoiceDesignPreview, VoiceDesignRequest, VoiceDesignResult, VoiceDesignSaveRequest, VoiceDetail, VoiceInfo, VoiceInfoPage, VoiceKind, VoiceSample, VoiceSource, VoiceStatus, VoiceUpdate, VoiceUpload, VoiceUploadRequest, VoiceUploadTicket } from './types.gen.js';

package/dist/gen/types.gen.d.ts

@@ -1124,6 +1124,10 @@ export type MessageInfo = {
      */
     mood_intensity: number | null;
     role: 'user' | 'assistant';
+    /**
+     * On a reply: the calls of your tools it made, in order, each with its arguments and what it answered. Empty when it called none, and on the person's messages.
+     */
+    tool_calls: Array<MessageToolCall>;
 };
 export type MessageKnowledge = {
     lookups: Array<KnowledgeLookupInfo>;
@@ -1149,6 +1153,40 @@ export type KnowledgeCitation = {
     score: number;
     title: string;
 };
+export type MessageToolCall = {
+    /**
+     * The call's id, `call_…`: what your server or app was sent.
+     */
+    call_id: string;
+    name: string;
+    kind: 'webhook' | 'app';
+    /**
+     * What the model called it with.
+     */
+    arguments: {
+        [key: string]: unknown;
+    };
+    /**
+     * What it answered, as the model read it — its JSON, or its text, cut at 16 KB. Null when it answered nothing.
+     */
+    result?: unknown;
+    /**
+     * It answered in time, with a 2xx or a result.
+     */
+    ok: boolean;
+    /**
+     * What failed, as the model was told — or, for a tool that asks first, that it waited for the person's yes. Null when nothing did.
+     */
+    error: string | null;
+    /**
+     * How long it took.
+     */
+    ms: number;
+    /**
+     * Which of the reply's rounds of calls, 1 to 3; 0 for a call the person confirmed with a tap.
+     */
+    round: number;
+};
 export type RelationInfo = {
     agent_id: string;
     /**
@@ -2574,6 +2612,218 @@ export type AgentKnowledgeUpdate = {
      */
     entry_ids: Array<string>;
 };
+export type ToolPage = {
+    data: Array<ToolInfo>;
+    /**
+     * Pass as `cursor` for the next page; `null` when this is the last.
+     */
+    next_cursor: string | null;
+};
+export type ToolInfo = {
+    /**
+     * The tool's id, `tl_…`.
+     */
+    id: string;
+    /**
+     * What the model calls the tool by: 1 to 64 lower-case letters, digits and underscores, starting with a letter. Unique in your organisation; `search_knowledge` and `remember_relation` are the platform's own.
+     */
+    name: string;
+    description: string;
+    /**
+     * `webhook`: your server, sent a signed `POST` with the call. `app`: the person's app, called over the agent's WebSocket. Fixed at creation.
+     */
+    kind: 'webhook' | 'app';
+    /**
+     * Its inputs, as a JSON Schema object: `{"type": "object", "properties": {…}, "required": […]}`, each property `string` (with an optional `enum`), `number`, `integer`, `boolean`, `array` (with `items`) or `object`, each with an optional `description`. Nothing else is taken: a key outside this set is refused rather than passed on unenforced.
+     */
+    parameters: {
+        [key: string]: unknown;
+    };
+    /**
+     * A webhook's address; `null` for an app's.
+     */
+    url: string | null;
+    /**
+     * How long a call may take, in milliseconds: 1000 to 30000, 10000 by default. Past it the call failed, and the model is told so.
+     */
+    timeout_ms: number;
+    /**
+     * Never run on the model's word alone: the agent asks the person first, and the tool runs only after they say yes.
+     */
+    ask_first: boolean;
+    /**
+     * An app's tool only: the app is told to act and the reply carries on at once, with no answer awaited.
+     */
+    action_only: boolean;
+    /**
+     * The line said before the call; `null` for none.
+     */
+    filler: string | null;
+    /**
+     * The names of the headers sent with each call; their values are never shown.
+     */
+    header_names: Array<string>;
+    /**
+     * The signing secret's last four characters; `null` for an app's tool.
+     */
+    secret_hint: string | null;
+    /**
+     * The agents it is turned on for.
+     */
+    agent_ids: Array<string>;
+    /**
+     * Moves by one on every save. Send it back as `expected_version` on an update to have the save refused (409) if somebody else changed the tool since you read it.
+     */
+    version: number;
+    created_at: string;
+    updated_at: string;
+};
+export type ToolWithSecret = ToolInfo & {
+    /**
+     * The signing secret, `whsec_…`, **shown this once**: every call is signed with it (`X-Tool-Signature`). Keep it on your server. `null` for an app's tool.
+     */
+    secret: string | null;
+};
+export type ToolCreate = {
+    /**
+     * What the model calls the tool by: 1 to 64 lower-case letters, digits and underscores, starting with a letter. Unique in your organisation; `search_knowledge` and `remember_relation` are the platform's own.
+     */
+    name: string;
+    /**
+     * What the tool does and when to call it, in the model's terms: it reads this to decide.
+     */
+    description: string;
+    /**
+     * `webhook`: your server, sent a signed `POST` with the call. `app`: the person's app, called over the agent's WebSocket. Fixed at creation.
+     */
+    kind: 'webhook' | 'app';
+    /**
+     * Its inputs (as above); omitted: it takes none.
+     */
+    parameters?: {
+        [key: string]: unknown;
+    };
+    /**
+     * A webhook's `https://` address, public, and not this platform's. An app's tool has none.
+     */
+    url?: string | null;
+    /**
+     * How long a call may take, in milliseconds: 1000 to 30000, 10000 by default. Past it the call failed, and the model is told so.
+     */
+    timeout_ms?: number;
+    /**
+     * Never run on the model's word alone: the agent asks the person first, and the tool runs only after they say yes.
+     */
+    ask_first?: boolean;
+    /**
+     * An app's tool only: the app is told to act and the reply carries on at once, with no answer awaited.
+     */
+    action_only?: boolean;
+    /**
+     * A line the agent says before the call, while it waits: `Let me check that for you.` `null`: none.
+     */
+    filler?: string | null;
+    /**
+     * A webhook's own headers, sent with every call (your API token): at most 10, stored encrypted and never shown again — a tool answers their names. `Content-Type`, `User-Agent`, `X-Tool-*` and HTTP's own are the platform's.
+     */
+    headers?: {
+        [key: string]: string;
+    } | null;
+};
+export type ToolUpdate = {
+    /**
+     * What the model calls the tool by: 1 to 64 lower-case letters, digits and underscores, starting with a letter. Unique in your organisation; `search_knowledge` and `remember_relation` are the platform's own.
+     */
+    name?: string;
+    /**
+     * What the tool does and when to call it, in the model's terms: it reads this to decide.
+     */
+    description?: string;
+    /**
+     * Its inputs, as a JSON Schema object: `{"type": "object", "properties": {…}, "required": […]}`, each property `string` (with an optional `enum`), `number`, `integer`, `boolean`, `array` (with `items`) or `object`, each with an optional `description`. Nothing else is taken: a key outside this set is refused rather than passed on unenforced.
+     */
+    parameters?: {
+        [key: string]: unknown;
+    };
+    /**
+     * A webhook's `https://` address, public, and not this platform's. An app's tool has none.
+     */
+    url?: string;
+    /**
+     * How long a call may take, in milliseconds: 1000 to 30000, 10000 by default. Past it the call failed, and the model is told so.
+     */
+    timeout_ms?: number;
+    /**
+     * Never run on the model's word alone: the agent asks the person first, and the tool runs only after they say yes.
+     */
+    ask_first?: boolean;
+    /**
+     * An app's tool only: the app is told to act and the reply carries on at once, with no answer awaited.
+     */
+    action_only?: boolean;
+    /**
+     * A line the agent says before the call, while it waits: `Let me check that for you.` `null`: none.
+     */
+    filler?: string | null;
+    /**
+     * Replaces every header; `null` or `{}` sends none.
+     */
+    headers?: {
+        [key: string]: string;
+    } | null;
+    /**
+     * The `version` you last read. When set and the tool has been changed since, the update is refused with 409 and nothing is written. Omit it to write unconditionally.
+     */
+    expected_version?: number | null;
+};
+export type ToolTestResult = {
+    /**
+     * Your server answered 2xx within the timeout.
+     */
+    ok: boolean;
+    /**
+     * Its HTTP status; `null` when none came (unreachable, or too slow).
+     */
+    status: number | null;
+    /**
+     * From sending to its answer's last byte.
+     */
+    duration_ms: number;
+    /**
+     * Its answer: the JSON it sent, else its text, cut at 16384 bytes; `null` for none.
+     */
+    result?: unknown;
+    /**
+     * The answer was longer than 16384 bytes and was cut.
+     */
+    truncated: boolean;
+    /**
+     * What failed, as the model would be told; `null` when it did not.
+     */
+    error: string | null;
+};
+export type ToolTestRequest = {
+    /**
+     * What the call carries as `arguments`; `{}` when omitted.
+     */
+    arguments?: {
+        [key: string]: unknown;
+    };
+};
+export type ToolsAssigned = {
+    added: number;
+    removed: number;
+    /**
+     * Ids sent that are not this organisation's, ignored.
+     */
+    skipped: Array<string>;
+};
+export type AgentToolsUpdate = {
+    /**
+     * The complete set, at most 20. An empty list turns every tool off.
+     */
+    tool_ids: Array<string>;
+};
 export type TtsRequest = {
     /**
      * An id from `GET /v1/voices` — the built-in voice, a platform voice, or one your organisation uploaded.
@@ -6111,6 +6361,380 @@ export type SetAgentKnowledgeResponses = {
     200: KnowledgeAssigned;
 };
 export type SetAgentKnowledgeResponse = SetAgentKnowledgeResponses[keyof SetAgentKnowledgeResponses];
+export type ListToolsData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/tools';
+};
+export type ListToolsErrors = {
+    /**
+     * Missing or invalid credentials
+     */
+    401: ErrorResponse;
+    /**
+     * The key is valid but its scopes do not cover this capability — a key limited to `tts` gets this from `/v1/images` rather than a 401
+     */
+    403: ErrorResponse;
+    /**
+     * The request failed validation
+     */
+    422: ErrorResponse;
+    /**
+     * Rate limit exceeded
+     */
+    429: ErrorResponse;
+};
+export type ListToolsError = ListToolsErrors[keyof ListToolsErrors];
+export type ListToolsResponses = {
+    /**
+     * Every tool
+     */
+    200: ToolPage;
+};
+export type ListToolsResponse = ListToolsResponses[keyof ListToolsResponses];
+export type CreateToolData = {
+    body: ToolCreate;
+    path?: never;
+    query?: never;
+    url: '/v1/tools';
+};
+export type CreateToolErrors = {
+    /**
+     * The request could not be read: malformed JSON
+     */
+    400: ErrorResponse;
+    /**
+     * Missing or invalid credentials
+     */
+    401: ErrorResponse;
+    /**
+     * The key is valid but its scopes do not cover this capability — a key limited to `tts` gets this from `/v1/images` rather than a 401
+     */
+    403: ErrorResponse;
+    /**
+     * A tool by that name exists already, or the library holds 200 tools.
+     */
+    409: ErrorResponse;
+    /**
+     * The request failed validation
+     */
+    422: ErrorResponse;
+    /**
+     * Rate limit exceeded
+     */
+    429: ErrorResponse;
+    /**
+     * This deployment cannot seal a tool's secret (`TOOL_SECRET_KEY` unset): webhook tools cannot be saved or called.
+     */
+    503: ErrorResponse;
+};
+export type CreateToolError = CreateToolErrors[keyof CreateToolErrors];
+export type CreateToolResponses = {
+    /**
+     * The tool, with its signing secret shown this once
+     */
+    201: ToolWithSecret;
+};
+export type CreateToolResponse = CreateToolResponses[keyof CreateToolResponses];
+export type DeleteToolData = {
+    body?: never;
+    path: {
+        tool_id: string;
+    };
+    query?: never;
+    url: '/v1/tools/{tool_id}';
+};
+export type DeleteToolErrors = {
+    /**
+     * Missing or invalid credentials
+     */
+    401: ErrorResponse;
+    /**
+     * The key is valid but its scopes do not cover this capability — a key limited to `tts` gets this from `/v1/images` rather than a 401
+     */
+    403: ErrorResponse;
+    /**
+     * Unknown tool id
+     */
+    404: ErrorResponse;
+    /**
+     * The request failed validation
+     */
+    422: ErrorResponse;
+    /**
+     * Rate limit exceeded
+     */
+    429: ErrorResponse;
+};
+export type DeleteToolError = DeleteToolErrors[keyof DeleteToolErrors];
+export type DeleteToolResponses = {
+    /**
+     * The tool is gone
+     */
+    204: void;
+};
+export type DeleteToolResponse = DeleteToolResponses[keyof DeleteToolResponses];
+export type GetToolData = {
+    body?: never;
+    path: {
+        tool_id: string;
+    };
+    query?: never;
+    url: '/v1/tools/{tool_id}';
+};
+export type GetToolErrors = {
+    /**
+     * Missing or invalid credentials
+     */
+    401: ErrorResponse;
+    /**
+     * The key is valid but its scopes do not cover this capability — a key limited to `tts` gets this from `/v1/images` rather than a 401
+     */
+    403: ErrorResponse;
+    /**
+     * Unknown tool id
+     */
+    404: ErrorResponse;
+    /**
+     * The request failed validation
+     */
+    422: ErrorResponse;
+    /**
+     * Rate limit exceeded
+     */
+    429: ErrorResponse;
+};
+export type GetToolError = GetToolErrors[keyof GetToolErrors];
+export type GetToolResponses = {
+    /**
+     * The tool
+     */
+    200: ToolInfo;
+};
+export type GetToolResponse = GetToolResponses[keyof GetToolResponses];
+export type UpdateToolData = {
+    body: ToolUpdate;
+    path: {
+        tool_id: string;
+    };
+    query?: never;
+    url: '/v1/tools/{tool_id}';
+};
+export type UpdateToolErrors = {
+    /**
+     * The request could not be read: malformed JSON
+     */
+    400: ErrorResponse;
+    /**
+     * Missing or invalid credentials
+     */
+    401: ErrorResponse;
+    /**
+     * The key is valid but its scopes do not cover this capability — a key limited to `tts` gets this from `/v1/images` rather than a 401
+     */
+    403: ErrorResponse;
+    /**
+     * Unknown tool id
+     */
+    404: ErrorResponse;
+    /**
+     * `expected_version` was sent and the tool has been changed since, or the new name is taken. Nothing was written.
+     */
+    409: ErrorResponse;
+    /**
+     * The request failed validation
+     */
+    422: ErrorResponse;
+    /**
+     * Rate limit exceeded
+     */
+    429: ErrorResponse;
+    /**
+     * This deployment cannot seal a tool's secret (`TOOL_SECRET_KEY` unset): webhook tools cannot be saved or called.
+     */
+    503: ErrorResponse;
+};
+export type UpdateToolError = UpdateToolErrors[keyof UpdateToolErrors];
+export type UpdateToolResponses = {
+    /**
+     * The tool as it now stands
+     */
+    200: ToolInfo;
+};
+export type UpdateToolResponse = UpdateToolResponses[keyof UpdateToolResponses];
+export type RotateToolSecretData = {
+    body?: never;
+    path: {
+        tool_id: string;
+    };
+    query?: never;
+    url: '/v1/tools/{tool_id}/secret';
+};
+export type RotateToolSecretErrors = {
+    /**
+     * Missing or invalid credentials
+     */
+    401: ErrorResponse;
+    /**
+     * The key is valid but its scopes do not cover this capability — a key limited to `tts` gets this from `/v1/images` rather than a 401
+     */
+    403: ErrorResponse;
+    /**
+     * Unknown tool id
+     */
+    404: ErrorResponse;
+    /**
+     * The request failed validation
+     */
+    422: ErrorResponse;
+    /**
+     * Rate limit exceeded
+     */
+    429: ErrorResponse;
+    /**
+     * This deployment cannot seal a tool's secret (`TOOL_SECRET_KEY` unset): webhook tools cannot be saved or called.
+     */
+    503: ErrorResponse;
+};
+export type RotateToolSecretError = RotateToolSecretErrors[keyof RotateToolSecretErrors];
+export type RotateToolSecretResponses = {
+    /**
+     * The tool, with its new signing secret
+     */
+    200: ToolWithSecret;
+};
+export type RotateToolSecretResponse = RotateToolSecretResponses[keyof RotateToolSecretResponses];
+export type TestToolData = {
+    body: ToolTestRequest;
+    path: {
+        tool_id: string;
+    };
+    query?: never;
+    url: '/v1/tools/{tool_id}/test';
+};
+export type TestToolErrors = {
+    /**
+     * The request could not be read: malformed JSON
+     */
+    400: ErrorResponse;
+    /**
+     * Missing or invalid credentials
+     */
+    401: ErrorResponse;
+    /**
+     * The key is valid but its scopes do not cover this capability — a key limited to `tts` gets this from `/v1/images` rather than a 401
+     */
+    403: ErrorResponse;
+    /**
+     * Unknown tool id
+     */
+    404: ErrorResponse;
+    /**
+     * The tool's stored secret cannot be opened: `TOOL_SECRET_KEY` changed since it was saved. Rotate its secret, and save its headers again.
+     */
+    409: ErrorResponse;
+    /**
+     * The request failed validation
+     */
+    422: ErrorResponse;
+    /**
+     * Rate limit exceeded
+     */
+    429: ErrorResponse;
+    /**
+     * This deployment cannot seal a tool's secret (`TOOL_SECRET_KEY` unset): webhook tools cannot be saved or called.
+     */
+    503: ErrorResponse;
+};
+export type TestToolError = TestToolErrors[keyof TestToolErrors];
+export type TestToolResponses = {
+    /**
+     * What your server answered, or why it did not
+     */
+    200: ToolTestResult;
+};
+export type TestToolResponse = TestToolResponses[keyof TestToolResponses];
+export type ListAgentToolsData = {
+    body?: never;
+    path: {
+        agent_id: string;
+    };
+    query?: never;
+    url: '/v1/agents/{agent_id}/tools';
+};
+export type ListAgentToolsErrors = {
+    /**
+     * Missing or invalid credentials
+     */
+    401: ErrorResponse;
+    /**
+     * The key is valid but its scopes do not cover this capability — a key limited to `tts` gets this from `/v1/images` rather than a 401
+     */
+    403: ErrorResponse;
+    /**
+     * Unknown agent id
+     */
+    404: ErrorResponse;
+    /**
+     * The request failed validation
+     */
+    422: ErrorResponse;
+    /**
+     * Rate limit exceeded
+     */
+    429: ErrorResponse;
+};
+export type ListAgentToolsError = ListAgentToolsErrors[keyof ListAgentToolsErrors];
+export type ListAgentToolsResponses = {
+    /**
+     * The tools this agent can call
+     */
+    200: ToolPage;
+};
+export type ListAgentToolsResponse = ListAgentToolsResponses[keyof ListAgentToolsResponses];
+export type SetAgentToolsData = {
+    body: AgentToolsUpdate;
+    path: {
+        agent_id: string;
+    };
+    query?: never;
+    url: '/v1/agents/{agent_id}/tools';
+};
+export type SetAgentToolsErrors = {
+    /**
+     * The request could not be read: malformed JSON
+     */
+    400: ErrorResponse;
+    /**
+     * Missing or invalid credentials
+     */
+    401: ErrorResponse;
+    /**
+     * The key is valid but its scopes do not cover this capability — a key limited to `tts` gets this from `/v1/images` rather than a 401
+     */
+    403: ErrorResponse;
+    /**
+     * Unknown agent id
+     */
+    404: ErrorResponse;
+    /**
+     * The request failed validation
+     */
+    422: ErrorResponse;
+    /**
+     * Rate limit exceeded
+     */
+    429: ErrorResponse;
+};
+export type SetAgentToolsError = SetAgentToolsErrors[keyof SetAgentToolsErrors];
+export type SetAgentToolsResponses = {
+    /**
+     * How many tools were turned on and off
+     */
+    200: ToolsAssigned;
+};
+export type SetAgentToolsResponse = SetAgentToolsResponses[keyof SetAgentToolsResponses];
 export type SynthesizeSpeechData = {
     body: TtsRequest;
     path?: never;

package/dist/index.d.ts

@@ -8,15 +8,16 @@ export { type Client, type ClientOptions, createClient, DEFAULT_BASE_URL, } from
 export { AuthenticationError, ConflictError, ConnectionError, InsufficientCreditsError, NotFoundError, PermissionError, PlatformError, type PlatformErrorCode, type PlatformErrorInit, RateLimitError, ServerError, TimeoutError, ValidationError, } from "./errors.js";
 export type * from "./gen/index.js";
 export type { Page } from "./paging.js";
-export type { AgentKnowledge, AgentSettings, Agents, } from "./resources/agents.js";
+export type { AgentKnowledge, AgentSettings, Agents, AgentTools, } from "./resources/agents.js";
 export type { AssetListParams, Assets, AssetUploadFields, FolderListParams, Folders, } from "./resources/assets.js";
 export type { EndUserCreated, EndUserExport, EndUserListParams, EndUsers, } from "./resources/end-users.js";
 export type { EphemeralKeyCreateOptions, EphemeralKeyListParams, EphemeralKeyRevokeOptions, EphemeralKeys, } from "./resources/ephemeral-keys.js";
 export type { GenerationListParams, Generations, Jobs, Skybox, } from "./resources/generations.js";
 export type { Knowledge, KnowledgeInsightsParams, KnowledgeListParams, KnowledgeUploadFields, } from "./resources/knowledge.js";
-export type { Resource, Waitable } from "./resources/resource.js";
+export type { Library, Listing, Resource, Waitable, WaitableLibrary, } from "./resources/resource.js";
 export type { Speech, Stt, SttEvent, SttParams, Transcript, Tts, } from "./resources/speech.js";
 export type { TemplateFile, Templates } from "./resources/templates.js";
+export type { Tools } from "./resources/tools.js";
 export type { Usage, UsageParams } from "./resources/usage.js";
 export type { Voices, VoiceUploadFields } from "./resources/voices.js";
 export type { Fetch, RequestOptions } from "./transport.js";

package/dist/resources/agents.d.ts

@@ -6,15 +6,16 @@
  * - **A save reaches running sessions within a minute**, not at once: an
  *   agent's version travels through the platform's `STANDING` copy.
  * - **`settings`** are the organisation's, for every agent;
- *   **`knowledge.set`** replaces the entries one agent may look up.
+ *   **`knowledge.set`** replaces the entries one agent may look up, and
+ *   **`tools.set`** the tools it can call.
  * - **`create` is a 409 at the plan's maximum agents**; `delete` answers
  *   `true`, and `false` for one already gone.
  * - **`list()` reads one page**: an organisation's agents are few, and the
  *   route answers them all with `next_cursor` `null` (`paging.ts`).
  */
-import type { AgentCreateRequest, AgentInfo, AgentKnowledgeUpdate, AgentPage, AgentSettingsInfo, AgentSettingsUpdate, AgentSummary, AgentUpdate, KnowledgeAssigned, KnowledgeInfo } from "../gen/index.js";
+import type { AgentCreateRequest, AgentInfo, AgentKnowledgeUpdate, AgentPage, AgentSettingsInfo, AgentSettingsUpdate, AgentSummary, AgentToolsUpdate, AgentUpdate, KnowledgeAssigned, KnowledgeInfo, ToolInfo, ToolsAssigned } from "../gen/index.js";
 import type { RequestOptions, Transport } from "../transport.js";
-import { Editable } from "./resource.js";
+import { Library } from "./resource.js";
 /** `agents.settings`: the organisation's, for every agent. */
 export interface AgentSettings {
     get(options?: RequestOptions): Promise<AgentSettingsInfo>;
@@ -27,13 +28,18 @@ export interface AgentKnowledge {
     /** Replaces them all with these. */
     set(agentId: string, body: AgentKnowledgeUpdate, options?: RequestOptions): Promise<KnowledgeAssigned>;
 }
-export declare class Agents extends Editable<AgentInfo, AgentUpdate> {
+/** `agents.tools`: the tools one agent can call. */
+export interface AgentTools {
+    /** Every tool it can call. */
+    list(agentId: string, options?: RequestOptions): AsyncGenerator<ToolInfo, void, undefined>;
+    /** Replaces them all with these, 20 at most. */
+    set(agentId: string, body: AgentToolsUpdate, options?: RequestOptions): Promise<ToolsAssigned>;
+}
+export declare class Agents extends Library<AgentInfo, AgentUpdate, AgentSummary, AgentPage, AgentCreateRequest> {
     readonly settings: AgentSettings;
     readonly knowledge: AgentKnowledge;
+    readonly tools: AgentTools;
     constructor(api: Transport, base: string);
-    /** The page of agents, as the route answers it. */
-    page(options?: RequestOptions): Promise<AgentPage>;
-    /** Every agent. */
-    list(options?: RequestOptions): AsyncGenerator<AgentSummary, void, undefined>;
-    create(body: AgentCreateRequest, options?: RequestOptions): Promise<AgentInfo>;
+    /** An agent's links to what the organisation has: its knowledge, its tools. */
+    protected links<T extends AgentKnowledge | AgentTools>(rest: string): T;
 }

package/dist/resources/agents.js

@@ -6,34 +6,29 @@
  * - **A save reaches running sessions within a minute**, not at once: an
  *   agent's version travels through the platform's `STANDING` copy.
  * - **`settings`** are the organisation's, for every agent;
- *   **`knowledge.set`** replaces the entries one agent may look up.
+ *   **`knowledge.set`** replaces the entries one agent may look up, and
+ *   **`tools.set`** the tools it can call.
  * - **`create` is a 409 at the plan's maximum agents**; `delete` answers
  *   `true`, and `false` for one already gone.
  * - **`list()` reads one page**: an organisation's agents are few, and the
  *   route answers them all with `next_cursor` `null` (`paging.ts`).
  */
-import { Editable } from "./resource.js";
-export class Agents extends Editable {
+import { Library } from "./resource.js";
+export class Agents extends Library {
     constructor(api, base) {
         super(api, base);
         this.settings = {
             get: (options) => this.send("GET", "/settings", options),
             update: (body, options) => this.send("PUT", "/settings", options, body),
         };
-        this.knowledge = {
-            list: (id, options) => this.each(this.at(id, "/knowledge"), {}, options),
-            set: (id, body, options) => this.send("PUT", this.at(id, "/knowledge"), options, body),
-        };
-    }
-    /** The page of agents, as the route answers it. */
-    page(options) {
-        return this.send("GET", "", options);
+        this.knowledge = this.links("/knowledge");
+        this.tools = this.links("/tools");
     }
-    /** Every agent. */
-    list(options) {
-        return this.each("", {}, options);
-    }
-    create(body, options) {
-        return this.send("POST", "", options, body);
+    /** An agent's links to what the organisation has: its knowledge, its tools. */
+    links(rest) {
+        return {
+            list: (id, options) => this.each(this.at(id, rest), {}, options),
+            set: (id, body, options) => this.send("PUT", this.at(id, rest), options, body),
+        };
     }
 }

package/dist/resources/resource.d.ts

@@ -40,3 +40,17 @@ export declare class Waitable<Item extends Job & {
     /** `item` as made, or as it ended when `options.wait` says to wait. */
     protected settled(item: Item, options: UploadOptions): Promise<Item>;
 }
+/** What a `Library` adds to its base. */
+export interface Listing<Listed, ListPage, Create, Created> {
+    /** The page, as the route answers it: all of them, `next_cursor` `null`. */
+    page(options?: RequestOptions): Promise<ListPage>;
+    /** Every one of them. */
+    list(options?: RequestOptions): AsyncGenerator<Listed, void, undefined>;
+    create(body: Create, options?: RequestOptions): Promise<Created>;
+}
+/** An editable listed whole and made by a `POST`: the agents, the tools. */
+export declare const Library: new <Item, Update, Listed, ListPage, Create, Created = Item>(api: Transport, base: string) => Editable<Item, Update> & Listing<Listed, ListPage, Create, Created>;
+/** A waitable listed whole and made by a `POST`: the voices. */
+export declare const WaitableLibrary: new <Item extends Job & {
+    id: string;
+}, Update, Listed, ListPage, Create>(api: Transport, base: string) => Waitable<Item, Update> & Listing<Listed, ListPage, Create, Item>;

package/dist/resources/resource.js

@@ -13,6 +13,9 @@
  *   `false` when there is nothing by that id — already done. One that
  *   reports what went with it (an end user's, a folder's) answers those
  *   counts, and `null` for nothing by that id: the same rule, with a body.
+ * - **`Library`** and **`WaitableLibrary`**: one of the two, listed whole
+ *   in one page and made by a `POST` to the list — `page()`, `list()`,
+ *   `create(body)`, written once (`listed`).
  * - **`Waitable`**: an editable whose items are jobs — a voice, an asset,
  *   a knowledge entry — with `wait(id)` and `settled`, which an upload
  *   answers through.
@@ -83,3 +86,23 @@ export class Waitable extends Editable {
             : item;
     }
 }
+/**
+ * `Listing`'s three methods on `Base`, written once for every resource
+ * listed whole in one page and made by a `POST` to the list: a mixin, as
+ * the agents and the tools are editables and the voices waitables.
+ */
+const listed = (Base) => class extends Base {
+    page(options) {
+        return this.send("GET", "", options);
+    }
+    list(options) {
+        return this.each("", {}, options);
+    }
+    create(body, options) {
+        return this.send("POST", "", options, body);
+    }
+};
+/** An editable listed whole and made by a `POST`: the agents, the tools. */
+export const Library = listed(Editable);
+/** A waitable listed whole and made by a `POST`: the voices. */
+export const WaitableLibrary = listed(Waitable);

package/dist/resources/tools.d.ts

@@ -0,0 +1,24 @@
+/**
+ * `client.tools`: what an organisation's agents can call while they reply
+ * — `/v1/tools*`. A tool is your server (`webhook`), sent a signed `POST`
+ * with the call, or the person's app (`app`), called over the agent's
+ * socket; each is turned on per agent (`agents.tools.set`), 20 at most.
+ *
+ * - **`create(body)`** answers a webhook's signing secret once, as does
+ *   `rotateSecret` (`secret`); every call carries `X-Tool-Signature`.
+ * - **`test(id, { arguments })`** sends your server one call, signed as a
+ *   real one, and answers what came back.
+ * - **`list()` reads one page**: a library holds 200 tools at most.
+ * - **`update` with `expected_version`** refuses an edit made over
+ *   somebody else's (409); `delete` answers `true`, and `false` for one
+ *   already gone.
+ */
+import type { ToolCreate, ToolInfo, ToolPage, ToolTestRequest, ToolTestResult, ToolUpdate, ToolWithSecret } from "../gen/index.js";
+import type { RequestOptions } from "../transport.js";
+import { Library } from "./resource.js";
+export declare class Tools extends Library<ToolInfo, ToolUpdate, ToolInfo, ToolPage, ToolCreate, ToolWithSecret> {
+    /** A new signing secret, shown this once. */
+    rotateSecret(id: string, options?: RequestOptions): Promise<ToolWithSecret>;
+    /** One call to your server, as a conversation would send it: `{ arguments }`. */
+    test(id: string, body?: ToolTestRequest, options?: RequestOptions): Promise<ToolTestResult>;
+}

package/dist/resources/tools.js

@@ -0,0 +1,26 @@
+/**
+ * `client.tools`: what an organisation's agents can call while they reply
+ * — `/v1/tools*`. A tool is your server (`webhook`), sent a signed `POST`
+ * with the call, or the person's app (`app`), called over the agent's
+ * socket; each is turned on per agent (`agents.tools.set`), 20 at most.
+ *
+ * - **`create(body)`** answers a webhook's signing secret once, as does
+ *   `rotateSecret` (`secret`); every call carries `X-Tool-Signature`.
+ * - **`test(id, { arguments })`** sends your server one call, signed as a
+ *   real one, and answers what came back.
+ * - **`list()` reads one page**: a library holds 200 tools at most.
+ * - **`update` with `expected_version`** refuses an edit made over
+ *   somebody else's (409); `delete` answers `true`, and `false` for one
+ *   already gone.
+ */
+import { Library } from "./resource.js";
+export class Tools extends Library {
+    /** A new signing secret, shown this once. */
+    rotateSecret(id, options) {
+        return this.send("POST", this.at(id, "/secret"), options);
+    }
+    /** One call to your server, as a conversation would send it: `{ arguments }`. */
+    test(id, body = {}, options) {
+        return this.send("POST", this.at(id, "/test"), options, body);
+    }
+}

package/dist/resources/voices.d.ts

@@ -16,20 +16,18 @@
 import type { VoiceDesignRequest, VoiceDesignResult, VoiceDesignSaveRequest, VoiceDetail, VoiceInfo, VoiceInfoPage, VoiceUpdate, VoiceUpload, VoiceUploadRequest, VoiceUploadTicket } from "../gen/index.js";
 import type { RequestOptions } from "../transport.js";
 import { type UploadData, type UploadOptions } from "../upload.js";
-import { Waitable } from "./resource.js";
+import { WaitableLibrary } from "./resource.js";
 /** A recording's voice: the create's fields, and the recording's type. */
 export type VoiceUploadFields = Omit<VoiceUpload, "upload_id"> & {
     /** A Blob's own type by default: `audio/wav`, `audio/mpeg`, … */
     content_type?: string;
 };
-/** `update` renames a voice, or changes its description or defaults. */
-export declare class Voices extends Waitable<VoiceDetail, VoiceUpdate> {
-    /** The page of voices, as the route answers it: all of them, `next_cursor` `null`. */
-    page(options?: RequestOptions): Promise<VoiceInfoPage>;
-    /** Every voice this organisation may speak with. */
-    list(options?: RequestOptions): AsyncGenerator<VoiceInfo, void, undefined>;
-    /** Clones a recording already `PUT` to its ticket: `pending` at once. */
-    create(body: VoiceUpload, options?: RequestOptions): Promise<VoiceDetail>;
+/**
+ * `update` renames a voice, or changes its description or defaults;
+ * `list()` is every voice this organisation may speak with; `create(body)`
+ * clones a recording already `PUT` to its ticket, `pending` at once.
+ */
+export declare class Voices extends WaitableLibrary<VoiceDetail, VoiceUpdate, VoiceInfo, VoiceInfoPage, VoiceUpload> {
     /** A signed URL to `PUT` a recording to, with exactly this type. */
     uploadUrl(body: VoiceUploadRequest, options?: RequestOptions): Promise<VoiceUploadTicket>;
     /** Uploads a recording and clones it: `uploadUrl`, the `PUT`, `create`. */

package/dist/resources/voices.js

@@ -14,21 +14,13 @@
  * - **`list()` reads one page**: the route answers every voice in it.
  */
 import { needType, put, } from "../upload.js";
-import { Waitable } from "./resource.js";
-/** `update` renames a voice, or changes its description or defaults. */
-export class Voices extends Waitable {
-    /** The page of voices, as the route answers it: all of them, `next_cursor` `null`. */
-    page(options) {
-        return this.send("GET", "", options);
-    }
-    /** Every voice this organisation may speak with. */
-    list(options) {
-        return this.each("", {}, options);
-    }
-    /** Clones a recording already `PUT` to its ticket: `pending` at once. */
-    create(body, options) {
-        return this.send("POST", "", options, body);
-    }
+import { WaitableLibrary } from "./resource.js";
+/**
+ * `update` renames a voice, or changes its description or defaults;
+ * `list()` is every voice this organisation may speak with; `create(body)`
+ * clones a recording already `PUT` to its ticket, `pending` at once.
+ */
+export class Voices extends WaitableLibrary {
     /** A signed URL to `PUT` a recording to, with exactly this type. */
     uploadUrl(body, options) {
         return this.send("POST", "/upload-url", options, body);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumavox/server",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "The Lumavox API from your server: end users, ephemeral keys and the rest, typed from the published OpenAPI document. Zero dependencies.",
   "license": "MIT",
   "type": "module",