@canarycoders/ai 0.3.0 → 0.5.0

package/dist/index.d.cts

@@ -57,7 +57,7 @@ interface Citation {
     startIndex?: number;
     endIndex?: number;
 }
-/** The standard CanaryLLM success envelope: `{ success: true, data: T }`. */
+/** The standard CanaryCoders AI success envelope: `{ success: true, data: T }`. */
 interface ApiEnvelope<T> {
     success: boolean;
     data: T;
@@ -124,6 +124,12 @@ interface CreateConversationSessionParams {
 interface ConversationSession {
     session: ConversationSessionRecord;
     signedUrl: string;
+    /**
+     * Pass verbatim into the ElevenLabs client's `Conversation.startSession({ dynamicVariables })`
+     * so the post-call webhook correlates this session deterministically. Contains
+     * `canary_session_id` (this session's id).
+     */
+    dynamicVariables: Record<string, string>;
     /** seconds until the signed URL expires (≈900) */
     expiresIn: number;
     textOnly: boolean;
@@ -179,6 +185,8 @@ declare class Transport {
     raw(method: HttpMethod, path: string, opts?: RequestOptions): Promise<Response>;
     /** Perform the request and return the raw text body (CSV, YAML, …). */
     text(method: HttpMethod, path: string, opts?: RequestOptions): Promise<string>;
+    /** Perform the request and return the raw binary body (audio, …). */
+    bytes(method: HttpMethod, path: string, opts?: RequestOptions): Promise<ArrayBuffer>;
     /** Open a streaming response. Throws if the initial response is an error. */
     stream(method: HttpMethod, path: string, opts?: RequestOptions): Promise<Response>;
     private maybeUnwrap;
@@ -447,6 +455,13 @@ interface ImageGenerateParams {
     size?: string;
     aspectRatio?: string;
     quality?: "standard" | "hd" | "ultra";
+    /**
+     * Reference/input images for image-to-image and subject/style consistency.
+     * Each entry is an http(s) URL, a `data:` URI, or a bare base64 string. When
+     * present, the provider routes to its image-edit path. Per-provider max:
+     * openai 16, gemini 14, vertex 4, xai 3. Not supported by ollama.
+     */
+    referenceImages?: string[];
     tag?: string;
     service?: string;
 }
@@ -665,6 +680,12 @@ declare class SessionsAPI extends BaseResource {
         templateId?: number;
     }, signal?: AbortSignal): Promise<ConversationSessionRecord[]>;
     get(id: number, signal?: AbortSignal): Promise<ConversationSessionRecord>;
+    /**
+     * Fetch the session recording as raw audio bytes. Single use: the recording
+     * is deleted from ElevenLabs on retrieval, so a second call rejects with 404.
+     * Unfetched recordings are purged after 30 days.
+     */
+    getAudio(id: number, signal?: AbortSignal): Promise<ArrayBuffer>;
 }
 declare class ConversationsResource extends BaseResource {
     readonly templates: TemplatesAPI;
@@ -956,7 +977,7 @@ declare class VisionResource extends BaseResource {
     }>;
 }
 
-interface CanaryLLMOptions {
+interface CanaryCodersAIOptions {
     /** API key. Defaults to `process.env.CANARY_AI_API_KEY` (legacy `CANARYLLM_API_KEY` still read). */
     apiKey?: string;
     /** Base URL. Defaults to `https://api.ai.canarycoders.es`. */
@@ -975,7 +996,7 @@ interface CanaryLLMOptions {
     /** Default polling behavior for queued operations. */
     poll?: PollOptions;
 }
-declare class CanaryLLM {
+declare class CanaryCodersAI {
     readonly chat: ChatResource;
     readonly queue: QueueResource;
     readonly images: ImagesResource;
@@ -994,7 +1015,7 @@ declare class CanaryLLM {
     private readonly transport;
     private readonly baseURL;
     private readonly apiKey?;
-    constructor(options?: CanaryLLMOptions);
+    constructor(options?: CanaryCodersAIOptions);
     /** Targets to plug into the official `openai` / `@anthropic-ai/sdk` clients. */
     get compat(): {
         openai: () => CompatTarget;
@@ -1066,5 +1087,5 @@ interface StreamAdapterOptions extends SSEOptions {
 }
 
 // @ts-ignore
-export = CanaryLLM;
-export { APIConnectionError, APIConnectionTimeoutError, APIError, type ApiEnvelope, type AudioOutputFormat, AuthenticationError, type AutoLabelParams, type AutoLabelResult, type AutoTrainParams, BadRequestError, type BoundingBox, BrokeredCredential, CanaryLLM, type CanaryLLMOptions, type ChatProvider, type ChatStreamEvent, type ChatStreamOptions, type Citation, CompatTarget, type CompleteParams, type CompletionResult, ConflictError, type ContentPart, type ConversationQuestion, type ConversationSession, type ConversationSessionRecord, type ConversationTemplate, type ConversationTemplateParams, type ConversationTemplateType, type ConversationTemplateUpdate, type ConversationTool, type ConversationVoiceSettings, type CreateConversationSessionParams, CreateRealtimeSessionParams, type DetectParams, type Detection, type DialogueInput, type DialogueParams, type DialogueResult, type DocumentContent, type EmbeddingParams, type EmbeddingResult, type FaceDetectParams, type FaceDetectionResult, FinalizeRealtimeParams, type GeneratedImage, type GeneratedVideo, type ImageContent, type ImageGenerateParams, type ImageGenerationResult, type ImageRecognitionResult, InternalServerError, Job, type JobSnapshot, type JobStatus, type JobStreamOptions, type KeyInfo, type KeyValidation, type Message, type MessageContent, type MessageRole, type ModelCapability, type ModelInfo, type MusicParams, type MusicResult, NotFoundError, PermissionError, type PollOptions, type PortalPeriod, type ProviderType, RateLimitError, RealtimeSession, RealtimeSessionRecord, type ResponseFormat, type STTResult, type SignedUrlParams, type SignedUrlResult, type SoundEffectParams, type SoundEffectResult, type SpeechParams, type StreamAdapterOptions, type StreamChunk, type StreamProtocol, type TTSResult, type TaskKind, type TextContent, type ThinkingMode, type TokenUsage, type ToolCall, type ToolCallDelta, type ToolChoice, type ToolDefinition, type TrainParams, type TrainingJob, type TranscribeParams, type TranscriptWord, UnprocessableEntityError, type UsageSummary, type VideoContent, type VideoGenerateParams, type VideoGenerationResult, type VideoUploadOptions, type VideoUploadResult, type VisionModel, type VoiceInfo, type VoiceSettings, type WebDetectParams, type WebDetectionResult, type WebEntity, type WebSearchOptions, type ZeroShotDetectParams, toBrokeredCredential };
+export = CanaryCodersAI;
+export { APIConnectionError, APIConnectionTimeoutError, APIError, type ApiEnvelope, type AudioOutputFormat, AuthenticationError, type AutoLabelParams, type AutoLabelResult, type AutoTrainParams, BadRequestError, type BoundingBox, BrokeredCredential, CanaryCodersAI, type CanaryCodersAIOptions, CanaryCodersAI as CanaryLLM, type CanaryCodersAIOptions as CanaryLLMOptions, type ChatProvider, type ChatStreamEvent, type ChatStreamOptions, type Citation, CompatTarget, type CompleteParams, type CompletionResult, ConflictError, type ContentPart, type ConversationQuestion, type ConversationSession, type ConversationSessionRecord, type ConversationTemplate, type ConversationTemplateParams, type ConversationTemplateType, type ConversationTemplateUpdate, type ConversationTool, type ConversationVoiceSettings, type CreateConversationSessionParams, CreateRealtimeSessionParams, type DetectParams, type Detection, type DialogueInput, type DialogueParams, type DialogueResult, type DocumentContent, type EmbeddingParams, type EmbeddingResult, type FaceDetectParams, type FaceDetectionResult, FinalizeRealtimeParams, type GeneratedImage, type GeneratedVideo, type ImageContent, type ImageGenerateParams, type ImageGenerationResult, type ImageRecognitionResult, InternalServerError, Job, type JobSnapshot, type JobStatus, type JobStreamOptions, type KeyInfo, type KeyValidation, type Message, type MessageContent, type MessageRole, type ModelCapability, type ModelInfo, type MusicParams, type MusicResult, NotFoundError, PermissionError, type PollOptions, type PortalPeriod, type ProviderType, RateLimitError, RealtimeSession, RealtimeSessionRecord, type ResponseFormat, type STTResult, type SignedUrlParams, type SignedUrlResult, type SoundEffectParams, type SoundEffectResult, type SpeechParams, type StreamAdapterOptions, type StreamChunk, type StreamProtocol, type TTSResult, type TaskKind, type TextContent, type ThinkingMode, type TokenUsage, type ToolCall, type ToolCallDelta, type ToolChoice, type ToolDefinition, type TrainParams, type TrainingJob, type TranscribeParams, type TranscriptWord, UnprocessableEntityError, type UsageSummary, type VideoContent, type VideoGenerateParams, type VideoGenerationResult, type VideoUploadOptions, type VideoUploadResult, type VisionModel, type VoiceInfo, type VoiceSettings, type WebDetectParams, type WebDetectionResult, type WebEntity, type WebSearchOptions, type ZeroShotDetectParams, toBrokeredCredential };

package/dist/index.d.ts

@@ -57,7 +57,7 @@ interface Citation {
     startIndex?: number;
     endIndex?: number;
 }
-/** The standard CanaryLLM success envelope: `{ success: true, data: T }`. */
+/** The standard CanaryCoders AI success envelope: `{ success: true, data: T }`. */
 interface ApiEnvelope<T> {
     success: boolean;
     data: T;
@@ -124,6 +124,12 @@ interface CreateConversationSessionParams {
 interface ConversationSession {
     session: ConversationSessionRecord;
     signedUrl: string;
+    /**
+     * Pass verbatim into the ElevenLabs client's `Conversation.startSession({ dynamicVariables })`
+     * so the post-call webhook correlates this session deterministically. Contains
+     * `canary_session_id` (this session's id).
+     */
+    dynamicVariables: Record<string, string>;
     /** seconds until the signed URL expires (≈900) */
     expiresIn: number;
     textOnly: boolean;
@@ -179,6 +185,8 @@ declare class Transport {
     raw(method: HttpMethod, path: string, opts?: RequestOptions): Promise<Response>;
     /** Perform the request and return the raw text body (CSV, YAML, …). */
     text(method: HttpMethod, path: string, opts?: RequestOptions): Promise<string>;
+    /** Perform the request and return the raw binary body (audio, …). */
+    bytes(method: HttpMethod, path: string, opts?: RequestOptions): Promise<ArrayBuffer>;
     /** Open a streaming response. Throws if the initial response is an error. */
     stream(method: HttpMethod, path: string, opts?: RequestOptions): Promise<Response>;
     private maybeUnwrap;
@@ -447,6 +455,13 @@ interface ImageGenerateParams {
     size?: string;
     aspectRatio?: string;
     quality?: "standard" | "hd" | "ultra";
+    /**
+     * Reference/input images for image-to-image and subject/style consistency.
+     * Each entry is an http(s) URL, a `data:` URI, or a bare base64 string. When
+     * present, the provider routes to its image-edit path. Per-provider max:
+     * openai 16, gemini 14, vertex 4, xai 3. Not supported by ollama.
+     */
+    referenceImages?: string[];
     tag?: string;
     service?: string;
 }
@@ -665,6 +680,12 @@ declare class SessionsAPI extends BaseResource {
         templateId?: number;
     }, signal?: AbortSignal): Promise<ConversationSessionRecord[]>;
     get(id: number, signal?: AbortSignal): Promise<ConversationSessionRecord>;
+    /**
+     * Fetch the session recording as raw audio bytes. Single use: the recording
+     * is deleted from ElevenLabs on retrieval, so a second call rejects with 404.
+     * Unfetched recordings are purged after 30 days.
+     */
+    getAudio(id: number, signal?: AbortSignal): Promise<ArrayBuffer>;
 }
 declare class ConversationsResource extends BaseResource {
     readonly templates: TemplatesAPI;
@@ -956,7 +977,7 @@ declare class VisionResource extends BaseResource {
     }>;
 }
 
-interface CanaryLLMOptions {
+interface CanaryCodersAIOptions {
     /** API key. Defaults to `process.env.CANARY_AI_API_KEY` (legacy `CANARYLLM_API_KEY` still read). */
     apiKey?: string;
     /** Base URL. Defaults to `https://api.ai.canarycoders.es`. */
@@ -975,7 +996,7 @@ interface CanaryLLMOptions {
     /** Default polling behavior for queued operations. */
     poll?: PollOptions;
 }
-declare class CanaryLLM {
+declare class CanaryCodersAI {
     readonly chat: ChatResource;
     readonly queue: QueueResource;
     readonly images: ImagesResource;
@@ -994,7 +1015,7 @@ declare class CanaryLLM {
     private readonly transport;
     private readonly baseURL;
     private readonly apiKey?;
-    constructor(options?: CanaryLLMOptions);
+    constructor(options?: CanaryCodersAIOptions);
     /** Targets to plug into the official `openai` / `@anthropic-ai/sdk` clients. */
     get compat(): {
         openai: () => CompatTarget;
@@ -1065,4 +1086,4 @@ interface StreamAdapterOptions extends SSEOptions {
     includeRaw?: boolean;
 }
 
-export { APIConnectionError, APIConnectionTimeoutError, APIError, type ApiEnvelope, type AudioOutputFormat, AuthenticationError, type AutoLabelParams, type AutoLabelResult, type AutoTrainParams, BadRequestError, type BoundingBox, BrokeredCredential, CanaryLLM, type CanaryLLMOptions, type ChatProvider, type ChatStreamEvent, type ChatStreamOptions, type Citation, CompatTarget, type CompleteParams, type CompletionResult, ConflictError, type ContentPart, type ConversationQuestion, type ConversationSession, type ConversationSessionRecord, type ConversationTemplate, type ConversationTemplateParams, type ConversationTemplateType, type ConversationTemplateUpdate, type ConversationTool, type ConversationVoiceSettings, type CreateConversationSessionParams, CreateRealtimeSessionParams, type DetectParams, type Detection, type DialogueInput, type DialogueParams, type DialogueResult, type DocumentContent, type EmbeddingParams, type EmbeddingResult, type FaceDetectParams, type FaceDetectionResult, FinalizeRealtimeParams, type GeneratedImage, type GeneratedVideo, type ImageContent, type ImageGenerateParams, type ImageGenerationResult, type ImageRecognitionResult, InternalServerError, Job, type JobSnapshot, type JobStatus, type JobStreamOptions, type KeyInfo, type KeyValidation, type Message, type MessageContent, type MessageRole, type ModelCapability, type ModelInfo, type MusicParams, type MusicResult, NotFoundError, PermissionError, type PollOptions, type PortalPeriod, type ProviderType, RateLimitError, RealtimeSession, RealtimeSessionRecord, type ResponseFormat, type STTResult, type SignedUrlParams, type SignedUrlResult, type SoundEffectParams, type SoundEffectResult, type SpeechParams, type StreamAdapterOptions, type StreamChunk, type StreamProtocol, type TTSResult, type TaskKind, type TextContent, type ThinkingMode, type TokenUsage, type ToolCall, type ToolCallDelta, type ToolChoice, type ToolDefinition, type TrainParams, type TrainingJob, type TranscribeParams, type TranscriptWord, UnprocessableEntityError, type UsageSummary, type VideoContent, type VideoGenerateParams, type VideoGenerationResult, type VideoUploadOptions, type VideoUploadResult, type VisionModel, type VoiceInfo, type VoiceSettings, type WebDetectParams, type WebDetectionResult, type WebEntity, type WebSearchOptions, type ZeroShotDetectParams, CanaryLLM as default, toBrokeredCredential };
+export { APIConnectionError, APIConnectionTimeoutError, APIError, type ApiEnvelope, type AudioOutputFormat, AuthenticationError, type AutoLabelParams, type AutoLabelResult, type AutoTrainParams, BadRequestError, type BoundingBox, BrokeredCredential, CanaryCodersAI, type CanaryCodersAIOptions, CanaryCodersAI as CanaryLLM, type CanaryCodersAIOptions as CanaryLLMOptions, type ChatProvider, type ChatStreamEvent, type ChatStreamOptions, type Citation, CompatTarget, type CompleteParams, type CompletionResult, ConflictError, type ContentPart, type ConversationQuestion, type ConversationSession, type ConversationSessionRecord, type ConversationTemplate, type ConversationTemplateParams, type ConversationTemplateType, type ConversationTemplateUpdate, type ConversationTool, type ConversationVoiceSettings, type CreateConversationSessionParams, CreateRealtimeSessionParams, type DetectParams, type Detection, type DialogueInput, type DialogueParams, type DialogueResult, type DocumentContent, type EmbeddingParams, type EmbeddingResult, type FaceDetectParams, type FaceDetectionResult, FinalizeRealtimeParams, type GeneratedImage, type GeneratedVideo, type ImageContent, type ImageGenerateParams, type ImageGenerationResult, type ImageRecognitionResult, InternalServerError, Job, type JobSnapshot, type JobStatus, type JobStreamOptions, type KeyInfo, type KeyValidation, type Message, type MessageContent, type MessageRole, type ModelCapability, type ModelInfo, type MusicParams, type MusicResult, NotFoundError, PermissionError, type PollOptions, type PortalPeriod, type ProviderType, RateLimitError, RealtimeSession, RealtimeSessionRecord, type ResponseFormat, type STTResult, type SignedUrlParams, type SignedUrlResult, type SoundEffectParams, type SoundEffectResult, type SpeechParams, type StreamAdapterOptions, type StreamChunk, type StreamProtocol, type TTSResult, type TaskKind, type TextContent, type ThinkingMode, type TokenUsage, type ToolCall, type ToolCallDelta, type ToolChoice, type ToolDefinition, type TrainParams, type TrainingJob, type TranscribeParams, type TranscriptWord, UnprocessableEntityError, type UsageSummary, type VideoContent, type VideoGenerateParams, type VideoGenerationResult, type VideoUploadOptions, type VideoUploadResult, type VisionModel, type VoiceInfo, type VoiceSettings, type WebDetectParams, type WebDetectionResult, type WebEntity, type WebSearchOptions, type ZeroShotDetectParams, CanaryCodersAI as default, toBrokeredCredential };

package/dist/index.js

@@ -317,6 +317,12 @@ var Transport = class {
     if (!res.ok) throw await toAPIError(res);
     return res.text();
   }
+  /** Perform the request and return the raw binary body (audio, …). */
+  async bytes(method, path, opts = {}) {
+    const res = await this.send(method, path, opts);
+    if (!res.ok) throw await toAPIError(res);
+    return res.arrayBuffer();
+  }
   /** Open a streaming response. Throws if the initial response is an error. */
   async stream(method, path, opts = {}) {
     const res = await this.send(method, path, {
@@ -1193,6 +1199,18 @@ var SessionsAPI = class extends BaseResource {
     const data = await this.transport.json("GET", `/api/convagents/sessions/${id}`, { signal });
     return data.session;
   }
+  /**
+   * Fetch the session recording as raw audio bytes. Single use: the recording
+   * is deleted from ElevenLabs on retrieval, so a second call rejects with 404.
+   * Unfetched recordings are purged after 30 days.
+   */
+  getAudio(id, signal) {
+    return this.transport.bytes(
+      "GET",
+      `/api/convagents/sessions/${id}/audio`,
+      { signal }
+    );
+  }
 };
 var ConversationsResource = class extends BaseResource {
   templates = new TemplatesAPI(this.transport, this.defaultPoll);
@@ -1572,7 +1590,7 @@ function readEnv(key) {
   if (typeof process !== "undefined" && process.env) return process.env[key];
   return void 0;
 }
-var CanaryLLM = class {
+var CanaryCodersAI = class {
   chat;
   queue;
   images;
@@ -1631,8 +1649,8 @@ var CanaryLLM = class {
 };
 
 // src/index.ts
-var src_default = CanaryLLM;
+var src_default = CanaryCodersAI;
 
-export { APIConnectionError, APIConnectionTimeoutError, APIError, AuthenticationError, BadRequestError, CanaryLLM, ConflictError, InternalServerError, Job, NotFoundError, PermissionError, RateLimitError, UnprocessableEntityError, anthropicTarget, src_default as default, openaiTarget, toBrokeredCredential };
+export { APIConnectionError, APIConnectionTimeoutError, APIError, AuthenticationError, BadRequestError, CanaryCodersAI, CanaryCodersAI as CanaryLLM, ConflictError, InternalServerError, Job, NotFoundError, PermissionError, RateLimitError, UnprocessableEntityError, anthropicTarget, src_default as default, openaiTarget, toBrokeredCredential };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map