Class HTTP

HTTP client for interacting with a Teleprompter REST API.

Supports both direct HTTP URLs and Cloudflare Worker service bindings for flexible deployment scenarios. Implements the full TeleprompterSDK interface for managing prompt templates over HTTP.

Example

Using with a base URL:

const client = new Teleprompter.HTTP('https://api.example.com');
const prompts = await client.listPrompts();

Example

Using with a Cloudflare Worker binding:

const client = new Teleprompter.HTTP(env.API_BINDING);
const prompt = await client.getPrompt('welcome-email');

Implements

Constructors

constructor

Methods

deletePrompt getPrompt getPromptVersions listPrompts rollbackPrompt writePrompt

Constructors

constructor

Methods

deletePrompt

  • deletePrompt(id): Promise<void>

  • Deletes a prompt by its ID.

    Parameters

    • id: string

      The unique identifier of the prompt to delete

    Returns Promise<void>

    Promise that resolves when the deletion completes

    Throws

    Error if the prompt is not found or deletion fails

getPrompt

  • getPrompt(id): Promise<Prompt>

  • Retrieves a specific prompt by its ID.

    Parameters

    • id: string

      The unique identifier of the prompt

    Returns Promise<Prompt>

    Promise resolving to the requested prompt

    Throws

    Error if the prompt is not found or the request fails

getPromptVersions

  • getPromptVersions(id): Promise<Prompt[]>

  • Retrieves all versions of a specific prompt.

    Parameters

    • id: string

      The unique identifier of the prompt

    Returns Promise<Prompt[]>

    Promise resolving to an array of all versions of the prompt

    Throws

    Error if the prompt is not found or the request fails

listPrompts

  • listPrompts(): Promise<Prompt[]>

  • Retrieves all available prompts from the API.

    Returns Promise<Prompt[]>

    Promise resolving to an array of all prompts

    Throws

    Error if the HTTP request fails

rollbackPrompt

  • rollbackPrompt(id, version): Promise<void>

  • Rolls back a prompt to a previous version.

    Parameters

    • id: string

      The unique identifier of the prompt

    • version: number

      The version number to roll back to

    Returns Promise<void>

    Promise that resolves when the rollback completes

    Throws

    Error if the prompt or version is not found, or rollback fails

writePrompt

  • writePrompt(prompt): Promise<void>

  • Creates a new prompt or updates an existing one.

    Parameters

    Returns Promise<void>

    Promise that resolves when the operation completes

    Throws

    Error if the write operation fails

Settings

Member Visibility

On This Page

Constructors
Methods