ResponsesRequestToolUnion - TypeScript SDK

ResponsesRequestToolUnion type definition

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Supported Types

models.ResponsesRequestToolFunction

1const value: models.ResponsesRequestToolFunction = {
2 name: "get_weather",
3 parameters: {
4 "properties": {
5 "location": {
6 "description": "The city and state",
7 "type": "string",
8 },
9 "unit": {
10 "enum": [
11 "celsius",
12 "fahrenheit",
13 ],
14 "type": "string",
15 "x-speakeasy-unknown-values": "allow",
16 },
17 },
18 "required": [
19 "location",
20 ],
21 "type": "object",
22 },
23 type: "function",
24};

models.PreviewWebSearchServerTool

1const value: models.PreviewWebSearchServerTool = {
2 type: "web_search_preview",
3};

models.Preview20250311WebSearchServerTool

1const value: models.Preview20250311WebSearchServerTool = {
2 type: "web_search_preview_2025_03_11",
3};

models.LegacyWebSearchServerTool

1const value: models.LegacyWebSearchServerTool = {
2 type: "web_search",
3};

models.WebSearchServerTool

1const value: models.WebSearchServerTool = {
2 type: "web_search_2025_08_26",
3};

models.FileSearchServerTool

1const value: models.FileSearchServerTool = {
2 type: "file_search",
3 vectorStoreIds: [
4 "vs_abc123",
5 ],
6};

models.ComputerUseServerTool

1const value: models.ComputerUseServerTool = {
2 displayHeight: 768,
3 displayWidth: 1024,
4 environment: "linux",
5 type: "computer_use_preview",
6};

models.CodeInterpreterServerTool

1const value: models.CodeInterpreterServerTool = {
2 container: "auto",
3 type: "code_interpreter",
4};

models.McpServerTool

1const value: models.McpServerTool = {
2 serverLabel: "my-server",
3 type: "mcp",
4};

models.ImageGenerationServerTool

1const value: models.ImageGenerationServerTool = {
2 type: "image_generation",
3};

models.CodexLocalShellTool

1const value: models.CodexLocalShellTool = {
2 type: "local_shell",
3};

models.ShellServerTool

1const value: models.ShellServerTool = {
2 type: "shell",
3};

models.ApplyPatchServerTool

1const value: models.ApplyPatchServerTool = {
2 type: "apply_patch",
3};

models.CustomTool

1const value: models.CustomTool = {
2 name: "my_tool",
3 type: "custom",
4};

models.AdvisorServerToolOpenRouter

1const value: models.AdvisorServerToolOpenRouter = {
2 type: "openrouter:advisor",
3};

models.DatetimeServerTool

1const value: models.DatetimeServerTool = {
2 type: "openrouter:datetime",
3};

models.FusionServerToolOpenRouter

1const value: models.FusionServerToolOpenRouter = {
2 type: "openrouter:fusion",
3};

models.ImageGenerationServerToolOpenRouter

1const value: models.ImageGenerationServerToolOpenRouter = {
2 type: "openrouter:image_generation",
3};

models.ChatSearchModelsServerTool

1const value: models.ChatSearchModelsServerTool = {
2 type: "openrouter:experimental__search_models",
3};

models.WebFetchServerTool

1const value: models.WebFetchServerTool = {
2 type: "openrouter:web_fetch",
3};

models.WebSearchServerToolOpenRouter

1const value: models.WebSearchServerToolOpenRouter = {
2 type: "openrouter:web_search",
3};

models.ApplyPatchServerToolOpenRouter

1const value: models.ApplyPatchServerToolOpenRouter = {
2 type: "openrouter:apply_patch",
3};

models.BashServerTool

1const value: models.BashServerTool = {
2 type: "openrouter:bash",
3};

models.ShellServerToolOpenRouter

1const value: models.ShellServerToolOpenRouter = {
2 type: "openrouter:shell",
3};