TypeScript SDKReference

TypeScript SDK Full Reference

Complete TypeScript type reference for every interface, enum, class, and constant exported by the Skytells SDK.

This page documents every type, interface, enum, class, and constant exported by the skytells package (v1.0.5). Use it as a companion to the feature pages — each section links back to the relevant guide.

Imports

The SDK supports default, named, and type-only imports:

// Default import
import Skytells from 'skytells';

// Named imports
import {
  Skytells,
  SkytellsClient,
  Prediction,
  PredictionsAPI,
  ModelsAPI,
  Chat,
  Completions,
  Responses,
  Embeddings,
  Safety,
  Orchestrator,
  Webhook,
  WebhookListener,
  WebhookEvent,
  SkytellsError,
  ApiErrorId,
  SafetyTemplates,
  createWebhookListener,
  verifySkytellsWebhookSignature,
  API_BASE_URL,
  ORCHESTRATOR_BASE_URL,
} from 'skytells';

// Type-only imports
import type {
  ClientOptions,
  RetryOptions,
  SkytellsRuntime,
  PredictionRequest,
  PredictionResponse,
  PredictionSdkOptions,
  RunOptions,
  WaitOptions,
  PredictionsListOptions,
  OnProgressCallback,
  QueueItem,
  PaginatedResponse,
  Pagination,
  Model,
  ModelType,
  ModelPrivacy,
  ModelMetadata,
  ModelFieldsOptions,
  ModelInputSchema,
  ModelOutputSchema,
  Vendor,
  Pricing,
  PricingCriteria,
  PricingFormula,
  PricingUnit,
  PricingOperator,
  Service,
  DeploymentHardware,
  ChatCompletion,
  ChatCompletionChunk,
  ChatCompletionChoice,
  ChatCompletionChunkChoice,
  ChatCompletionMessage,
  ChatCompletionMessageParam,
  ChatCompletionCreateParams,
  ChatCompletionTool,
  ChatCompletionToolChoiceOption,
  CompletionUsage,
  CompletionTokensDetails,
  PromptTokensDetails,
  ResponsesResponse,
  ResponsesCreateParams,
  ResponsesInputMessage,
  ResponsesOutputMessage,
  ResponsesStreamEvent,
  ResponsesUsage,
  ResponsesContentFilter,
  Embedding,
  CreateEmbeddingResponse,
  EmbeddingCreateParams,
  SafetyCheckResult,
  SafetyEvaluationResult,
  SafetyFilterSummary,
  SafetyTemplateConfig,
  SafetyCheckableInput,
  EvaluateInput,
  WebhookRoute,
  WebhookVerifyOptions,
  WebhookListenerOptions,
} from 'skytells';

Reference Sections

Browse the complete type reference organized by feature:

  • Client Types — ClientOptions, RetryOptions, SkytellsRuntime
  • Prediction Types — PredictionRequest, PredictionResponse, RunOptions, WaitOptions, Prediction class
  • Model Types — Model, Vendor, Pricing, metadata, schemas
  • Chat Types — ChatCompletionCreateParams, ChatCompletion, ChatCompletionChunk, message types
  • Responses Types — ResponsesCreateParams, ResponsesResponse, streaming events
  • Embeddings Types — EmbeddingCreateParams, CreateEmbeddingResponse, Embedding
  • Safety Types — SafetyTemplates, SafetyCheckResult, SafetyEvaluationResult, categories, severity
  • Webhook Types — Webhook class, WebhookListener class, WebhookEvent
  • Orchestrator Types — Workflow, API key, webhook trigger types
  • Error Types — SkytellsError, ApiErrorId
  • Constants — Base URLs, timeouts, endpoints

How is this guide?

On this page