venice-ai-sdk-apl/dist/resources/characters/index.d.ts

A comprehensive SDK for the Venice AI API with CLI support, programmatic CLI usage, CLI-style interface, and interactive demo

/**
 * Characters Resource
 *
 * This module provides access to the Characters API resources.
 */
import { HttpClient } from '../../utils/http';
import { BaseResource } from '../base-resource';
import { ListCharactersResponse } from '../../types/characters';
/**
 * Characters Resource
 */
export declare class CharactersResource extends BaseResource {
    /**
     * Creates a new characters resource
     *
     * @param http - HTTP client
     */
    constructor(http: HttpClient);
    /**
     * Lists available characters
     *
     * @param options - Options for filtering characters
     * @param options.isWebEnabled - Filter by web-enabled status
     * @param options.isAdult - Filter by adult content status
     * @returns Promise that resolves with the list of available characters
     *
     * @example
     * ```typescript
     * // List all characters
     * const response = await venice.characters.list();
     *
     * // List only web-enabled characters
     * const webEnabledCharacters = await venice.characters.list({ isWebEnabled: true });
     *
     * // List non-adult characters
     * const familyFriendlyCharacters = await venice.characters.list({ isAdult: false });
     * ```
     */
    list(options?: {
        isWebEnabled?: boolean;
        isAdult?: boolean;
    }): Promise<ListCharactersResponse>;
    /**
     * Gets a character by slug
     *
     * @param slug - Character slug
     * @returns Promise that resolves with the character
     *
     * @example
     * ```typescript
     * const character = await venice.characters.getCharacter('assistant');
     * ```
     */
    getCharacter(slug: string): Promise<ListCharactersResponse>;
}