Skip to main content
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Supported Types

models.AnthropicTextBlockParam

const value: models.AnthropicTextBlockParam = {
  text: "Hello, world!",
  type: "text",
};

models.AnthropicImageBlockParam

const value: models.AnthropicImageBlockParam = {
  source: {
    data: "/9j/4AAQ...",
    mediaType: "image/jpeg",
    type: "base64",
  },
  type: "image",
};

models.AnthropicDocumentBlockParam

const value: models.AnthropicDocumentBlockParam = {
  source: {
    data: "Hello, world!",
    mediaType: "text/plain",
    type: "text",
  },
  type: "document",
};

models.ContentToolUse

const value: models.ContentToolUse = {
  id: "<id>",
  name: "<value>",
  type: "tool_use",
};

models.ContentToolResult

const value: models.ContentToolResult = {
  toolUseId: "<id>",
  type: "tool_result",
};

models.ContentThinking

const value: models.ContentThinking = {
  signature: "<value>",
  thinking: "<value>",
  type: "thinking",
};

models.ContentRedactedThinking

const value: models.ContentRedactedThinking = {
  data: "<value>",
  type: "redacted_thinking",
};

models.ContentServerToolUse

const value: models.ContentServerToolUse = {
  id: "<id>",
  name: "<value>",
  type: "server_tool_use",
};

models.ContentWebSearchToolResult

const value: models.ContentWebSearchToolResult = {
  content: [
    {
      encryptedContent: "enc_content_0",
      title: "Example Page",
      type: "web_search_result",
      url: "https://example.com",
    },
  ],
  toolUseId: "<id>",
  type: "web_search_tool_result",
};

models.AnthropicSearchResultBlockParam

const value: models.AnthropicSearchResultBlockParam = {
  content: [
    {
      text: "Result content",
      type: "text",
    },
  ],
  source: "example_source",
  title: "Example Result",
  type: "search_result",
};

models.ContentCompaction

const value: models.ContentCompaction = {
  content: null,
  type: "compaction",
};

models.MessagesAdvisorToolResultBlock

const value: models.MessagesAdvisorToolResultBlock = {
  content: {
    "text": "Advisor response text",
    "type": "advisor_result",
  },
  toolUseId: "srvtoolu_01abc",
  type: "advisor_tool_result",
};