Tela SDK for JavaScript
    Preparing search index...

    Class TelaSDK

    The main class for interacting with the Tela API.

    Provides methods to access various Tela API resources.

    const tela = new TelaSDK({ apiKey: 'your-api-key' });
    const completion = await tela.completions.create({
      canvasId: "your-canvas-id",
      messages: [{ role: "user", content: "Hello!" }],
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    agents baseURL canvas createFile fetch maxRetries tasks timeout vault workstation AgentExecutionFailedError APIError AuthenticationError AuthorizationError BadRequestError ConflictApiKeyAndJWTError ConflictAuthMethodsError ConflictError ConnectionError ConnectionTimeout DEFAULT_TIMEOUT EmptyFileError ExecutionFailedError FileUploadError InternalServerError InvalidFileURL MissingApiKeyOrJWTError MissingAuthError NotFoundError RateLimitError TaskFailedError TelaSDK UnprocessableEntityError UserAbortError

    Accessors

    authToken

    Methods

    buildRequest buildURL createHeaders delete fetchWithTimeout get getAuthHeaders getUserAgent patch post put requestRaw stringifyQuery

    Constructors

    Properties

    agents: Agents

    Agents API resource. Run an agent by agentId via the Tela gateway (POST /agent/:id/run), then stream events, fetch the timeline, or cancel by sessionId (delegated to @meistrari/agent-sdk).

    const { sessionId } = await tela.agents.run({
      agentId: 'agent-id',
      message: 'Hello',
    })
    for await (const event of await tela.agents.streamSession(sessionId))
      console.log(event.kind)
    baseURL: string
    canvas: {
        get: <
            TInput extends
                | Record<string, unknown>
                | ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> = Record<
                string,
                unknown,
            >,
            TOutput extends
                | Record<string, unknown>
                | ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> = Record<
                string,
                unknown,
            >,
        >(
            options: CanvasGetOptions<TInput, TOutput>,
        ) => Promise<Canvas<TInput, TOutput>>;
    } = ...

    Retrieves a canvas by its ID, version ID, or application ID. Validates input and output schemas if provided via schema builder functions.

    Options for retrieving the canvas.

    A promise resolving to a Canvas instance.

    // Get canvas by ID with schemas
    const canvas = await tela.canvas.get({
      id: 'canvas-id',
      input: schema => schema.object({
        query: schema.string()
      }),
      output: schema => schema.object({
        response: schema.string()
      })
    });

    // Get canvas by application ID
    const canvas = await tela.canvas.get({
      applicationId: 'app-id'
    });

    // Execute the canvas
    const execution = await canvas.execute({ query: 'Hello' });
    const result = await execution.result;
    createFile: {
        (file: string | Blob | File, options?: BaseTelaFileOptions): TelaFile;
        (
            file: Uint8Array | ReadableStream<any>,
            options: TelaFileOptionsWithMimeType,
        ): TelaFile;
    } = ...

    Creates a new TelaFile instance from the provided file input.

    The file input to create a TelaFile instance from.

    A new TelaFile instance.

    fetch: typeof fetch
    maxRetries: number
    tasks: Tasks = ...

    Tasks API resource for managing workstation tasks (fetch, list, update, approve, rename, edit output, re-run, etc.).

    const task = await tela.tasks.get('task-id')
    await tela.tasks.approve('task-id')
    await tela.tasks.rename('task-id', 'New name')
    const files = await tela.tasks.getInputFiles('task-id')
    timeout: number
    vault: Vault = ...

    Vault API resource for resolving, downloading, and streaming files stored in the Tela vault.

    const url = await tela.vault.getSignedUrl('vault://abc-123')
    const blob = await tela.vault.download('vault://abc-123')
    workstation: {
        get: <
            TInput extends
                | Record<string, unknown>
                | ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> = Record<
                string,
                unknown,
            >,
            TOutput extends
                | Record<string, unknown>
                | ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> = Record<
                string,
                unknown,
            >,
        >(
            options: WorkstationGetOptions<TInput, TOutput>,
        ) => Promise<Workstation<TInput, TOutput>>;
    } = ...
    AgentExecutionFailedError: typeof AgentExecutionFailedError = Errors.AgentExecutionFailedError

    Thrown when an agent session fails on the server.

    APIError: typeof APIError = Errors.APIError

    Thrown when an API request fails.

    AuthenticationError: typeof AuthenticationError = Errors.AuthenticationError

    Thrown when authentication fails (e.g., invalid API key).

    AuthorizationError: typeof AuthorizationError = Errors.AuthorizationError

    Thrown when the authenticated user doesn't have permission for the requested operation.

    BadRequestError: typeof BadRequestError = Errors.BadRequestError

    Thrown when the API returns a 400 Bad Request error.

    ConflictApiKeyAndJWTError: typeof ConflictAuthMethodsError = Errors.ConflictApiKeyAndJWTError

    Use ConflictAuthMethodsError instead

    ConflictAuthMethodsError: typeof ConflictAuthMethodsError = Errors.ConflictAuthMethodsError

    Thrown when multiple authentication methods are provided.

    ConflictError: typeof ConflictError = Errors.ConflictError

    Thrown when there's a conflict with the current state of the resource.

    ConnectionError: typeof ConnectionError = Errors.ConnectionError

    Thrown when there's a network connection error.

    ConnectionTimeout: typeof ConnectionTimeout = Errors.ConnectionTimeout

    Thrown when a request times out.

    DEFAULT_TIMEOUT: number = 0
    EmptyFileError: typeof EmptyFileError = Errors.EmptyFileError

    Thrown when attempting to upload an empty file.

    ExecutionFailedError: typeof ExecutionFailedError = Errors.ExecutionFailedError

    Thrown when a canvas execution fails on the server.

    FileUploadError: typeof FileUploadError = Errors.FileUploadError

    Thrown when there's an error during file upload.

    InternalServerError: typeof InternalServerError = Errors.InternalServerError

    Thrown when an unexpected server error occurs.

    InvalidFileURL: typeof InvalidFileURL = Errors.InvalidFileURL

    Thrown when an invalid file URL is provided.

    MissingApiKeyOrJWTError: typeof MissingAuthError = Errors.MissingApiKeyOrJWTError

    Use MissingAuthError instead

    MissingAuthError: typeof MissingAuthError = Errors.MissingAuthError

    Thrown when no authentication method is provided.

    NotFoundError: typeof NotFoundError = Errors.NotFoundError

    Thrown when the requested resource is not found.

    RateLimitError: typeof RateLimitError = Errors.RateLimitError

    Thrown when the API rate limit is exceeded.

    TaskFailedError: typeof TaskFailedError = Errors.TaskFailedError

    Thrown when a workstation task fails on the server.

    TelaSDK: typeof TelaSDK = ...
    UnprocessableEntityError: typeof UnprocessableEntityError = Errors.UnprocessableEntityError

    Thrown when the request is well-formed but unable to be processed due to semantic errors.

    UserAbortError: typeof UserAbortError = Errors.UserAbortError

    Thrown when a request is aborted by the user.

    Accessors

    • get authToken(): string

      Returns string

    Methods

    • Type Parameters

      • Req

      Parameters

      • path: string
      • query: Req | null | undefined

      Returns string

    • Parameters

      • Optionalopts: Record<string, string>

      Returns Headers

    • Parameters

      • url: string
      • _options: RequestInit
      • timeout: number
      • controller: AbortController

      Returns Promise<Response>

    post

    • Performs a request and returns the raw Response together with its AbortController, bypassing JSON parsing and case transformation.

      Intended for consumers that parse the response body themselves — e.g. custom Server-Sent Events streams whose framing differs from the chat completion stream handled by Stream.fromSSEResponse. Reuses the client's retry, auth, timeout, and baseURL handling.

      Type Parameters

      • Req

      Parameters

      • method: HTTPMethods

        The HTTP method to use.

      • path: string

        Request path (relative to baseURL/opts.baseURL, or absolute).

      • Optionalopts: RequestOptions<Req>

        Request options (notably baseURL, query, and signal).

      Returns Promise<{ controller: AbortController; response: Response }>

      The live Response and the AbortController controlling it.

    • Parameters

      • query: Record<string, unknown>

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods