Types Reference

Complete TypeScript type definitions for the AgenticWork SDK.

Message Types

type MessageRole = 'system' | 'user' | 'assistant' | 'tool';

interface Message {
  role: MessageRole;
  content: string | ContentPart[];
  name?: string;
  toolCalls?: ToolCall[];
  toolCallId?: string;
}

interface TextContent {
  type: 'text';
  text: string;
}

interface ImageContent {
  type: 'image';
  source: {
    type: 'base64' | 'url';
    mediaType?: string;
    data?: string;
    url?: string;
  };
}

type ContentPart = TextContent | ImageContent;

Tool Types

interface ToolDefinition {
  name: string;
  description: string;
  inputSchema: z.ZodType<unknown> | Record<string, unknown>;
}

interface Tool extends ToolDefinition {
  execute: ToolExecutor;
}

type ToolExecutor = (
  args: Record<string, unknown>,
  context: ToolContext
) => Promise<string>;

interface ToolContext {
  workingDirectory: string;
  signal: AbortSignal;
  onProgress?: (output: string) => void;
}

interface ToolCall {
  id: string;
  name: string;
  arguments: Record<string, unknown>;
}

interface ToolResult {
  toolCallId: string;
  content: string;
  isError?: boolean;
}

Completion Types

interface CompletionOptions {
  model: string;
  messages: Message[];
  tools?: ToolDefinition[];
  temperature?: number;
  maxTokens?: number;
  topP?: number;
  stopSequences?: string[];
  stream?: boolean;
}

interface CompletionResponse {
  id: string;
  model: string;
  choices: CompletionChoice[];
  usage?: TokenUsage;
}

interface CompletionChoice {
  index: number;
  message: Message;
  finishReason: 'stop' | 'length' | 'tool_calls' | 'content_filter' | null;
}

interface TokenUsage {
  promptTokens: number;
  completionTokens: number;
  totalTokens: number;
}

Streaming Types

interface TextDelta {
  type: 'text_delta';
  text: string;
}

interface ToolCallDelta {
  type: 'tool_call_delta';
  toolCall: Partial<Omit<ToolCall, 'arguments'>> & {
    index: number;
    arguments?: string | Record<string, unknown>;
  };
}

interface StreamDone {
  type: 'done';
  finishReason?: string;
  usage?: TokenUsage;
}

interface StreamError {
  type: 'error';
  error: string;
}

type StreamChunk = TextDelta | ToolCallDelta | StreamDone | StreamError;

Rich Streaming Events

For CLI and UI applications:

type StreamEventType =
  | 'text'
  | 'thinking'
  | 'tool_start'
  | 'tool_progress'
  | 'tool_complete'
  | 'tool_error'
  | 'usage'
  | 'done'
  | 'error';

interface StreamEvent {
  type: StreamEventType;
  text?: string;
  tool?: {
    id: string;
    name: string;
    args: Record<string, unknown>;
    status: 'pending' | 'running' | 'success' | 'error';
    output?: string;
    error?: string;
    startTime?: number;
    endTime?: number;
    duration?: number;
  };
  usage?: TokenUsage;
  error?: string;
}

Provider Types

type ProviderType =
  | 'anthropic'
  | 'openai'
  | 'google'
  | 'ollama'
  | 'azure-openai'
  | 'vertex-ai'
  | 'bedrock'
  | 'aws-bedrock';

interface ProviderConfig {
  type: ProviderType;
  apiKey?: string;
  baseUrl?: string;
  defaultModel?: string;
  projectId?: string;
  location?: string;
  resourceName?: string;
}

interface Provider {
  readonly type: ProviderType;
  complete(options: CompletionOptions): Promise<CompletionResponse>;
  stream(options: CompletionOptions): AsyncGenerator<StreamChunk>;
  listModels(): Promise<string[]>;
  healthCheck(): Promise<boolean>;
}

interface ProviderCredentials {
  type: ProviderType;
  apiKey?: string;
  baseUrl?: string;
  defaultModel?: string;

  // AWS Bedrock
  awsRegion?: string;
  awsAccessKeyId?: string;
  awsSecretAccessKey?: string;
  awsSessionToken?: string;

  // Azure OpenAI
  azureEndpoint?: string;
  azureApiKey?: string;
  azureApiVersion?: string;
  azureDeploymentName?: string;

  // Azure AI Foundry
  azureAIEndpoint?: string;
  azureAIApiKey?: string;

  // Google Vertex AI
  googleProjectId?: string;
  googleLocation?: string;
  googleCredentials?: string | Record<string, unknown>;
}

Agent Types

interface AgentConfig {
  provider: Provider;
  model: string;
  systemPrompt?: string;
  tools?: Tool[];
  maxIterations?: number;
  maxToolCalls?: number;
  onToolCall?: (toolCall: ToolCall) => void;
  onToolResult?: (result: ToolResult) => void;
  onText?: (text: string) => void;
}

interface AgentRunOptions {
  prompt: string;
  context?: ToolContext;
  signal?: AbortSignal;
}

interface AgentResult {
  messages: Message[];
  finalResponse: string;
  toolCallCount: number;
  usage?: TokenUsage;
}

Platform Types

interface PlatformConfig {
  apiEndpoint: string;
  authToken?: string;
  clientId?: string;
  clientSecret?: string;
  impersonateUserId?: string;
}

interface User {
  id: string;
  email: string;
  name: string;
  isAdmin: boolean;
  groups: string[];
  permissions: string[];
}

interface Workspace {
  id: string;
  name: string;
  path: string;
  userId: string;
  createdAt: Date;
}

interface MCPServer {
  name: string;
  description: string;
  tools: ToolDefinition[];
  status: 'connected' | 'disconnected' | 'error';
}

interface FlowiseWorkflow {
  id: string;
  name: string;
  description?: string;
  category?: string;
  deployed: boolean;
  createdAt: Date;
  updatedAt: Date;
}

interface LLMModel {
  id: string;
  name: string;
  provider: string;
  capabilities: string[];
  maxTokens: number;
  supportsTools: boolean;
  supportsVision: boolean;
}

AgentiCode Config Types

interface AgenticodeConfig {
  providers: AgenticodeProvider[];
  models: AgenticodeModelConfig[];
  defaultModel?: string;
  mcpServers?: string[];
  flowiseEnabled?: boolean;
}

interface AgenticodeProvider {
  type: ProviderType;
  id: string;
  name: string;
  enabled: boolean;
  credentials: ProviderCredentials;
}

interface AgenticodeModelConfig {
  id: string;
  providerId: string;
  name: string;
  available: boolean;
}

Importing Types

import type {
  Message,
  MessageRole,
  ContentPart,
  Tool,
  ToolDefinition,
  ToolCall,
  ToolResult,
  ToolContext,
  Provider,
  ProviderType,
  ProviderCredentials,
  CompletionOptions,
  CompletionResponse,
  StreamChunk,
  TokenUsage,
  AgentConfig,
  AgentResult,
  User,
  Workspace,
  MCPServer,
  FlowiseWorkflow
} from '@agentic-work/sdk';