Interface TeleprompterSDK

Core interface for Teleprompter SDK implementations. Defines the contract for managing prompt templates including CRUD operations and versioning.

interface TeleprompterSDK {
    deletePrompt(id: string): Promise<void>;
    getPrompt(id: string): Promise<Prompt>;
    getPromptVersions(id: string): Promise<Prompt[]>;
    listPrompts(): Promise<Prompt[]>;
    rollbackPrompt(id: string, version: number): Promise<void>;
    writePrompt(prompt: PromptInput): Promise<void>;
}

Implemented by

HTTP

Index

Methods

deletePrompt getPrompt getPromptVersions listPrompts rollbackPrompt writePrompt

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
- Defined in index.ts:89

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 prompt
- Defined in index.ts:68

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 prompt versions
- Defined in index.ts:75

listPrompts

listPrompts(): Promise<Prompt[]>
Retrieves all available prompts

Returns Promise<Prompt[]>
Promise resolving to an array of all prompts
- Defined in index.ts:61

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
- Defined in index.ts:97

writePrompt

writePrompt(prompt): Promise<void>
Creates a new prompt or updates an existing one
Parameters
- prompt: PromptInput
  The prompt data to write
Returns Promise<void>
Promise that resolves when the operation completes
- Defined in index.ts:82