[{"data":1,"prerenderedAt":39},["ShallowReactive",2],{"docs:providers/xai":3},{"title":4,"navTitle":4,"description":5,"api":6,"html":7,"toc":8,"path":31,"tab":32,"group":33,"prev":34,"next":6,"markdownUrl":37,"sourceUrl":38,"lastModified":6},"@standardagents/xai","xAI provider package for Standard Agents using the official @ai-sdk/xai package",null,"\u003Caside class=\"docs-callout\" data-kind=\"info\" role=\"note\">\u003Cp>For direct access, set \u003Ccode>XAI_API_KEY\u003C/code> in your environment. Standard Agents Builder can use hosted routing through \u003Ccode>STANDARD_AGENTS_API_KEY\u003C/code> when the provider key is absent. Hosted access depends on platform configuration.\u003C/p>\u003C/aside>\n\u003Ch2 id=\"overview\">\u003Ca class=\"docs-anchor\" href=\"#overview\" aria-label=\"Link to this section\">\u003C/a>Overview\u003C/h2>\n\u003Cp>The \u003Ccode>@standardagents/xai\u003C/code> package provides a Standard Agents provider for Grok chat and image models. It uses the official \u003Ccode>@ai-sdk/xai\u003C/code> package, supports Grok streaming responses, and routes \u003Ccode>grok-imagine-image*\u003C/code> models through xAI's image generation/edit APIs.\u003C/p>\n\u003Cdiv class=\"docs-card\">\u003Cspan class=\"docs-icon\" data-icon=\"cpu\">\u003C/span>\u003Cspan class=\"docs-card-title\">Key Features\u003C/span>\u003Cdiv class=\"docs-card-body\">\u003Cul>\n\u003Cli>Official \u003Ccode>@ai-sdk/xai\u003C/code> integration\u003C/li>\n\u003Cli>Grok chat model streaming, reasoning, and tool calls\u003C/li>\n\u003Cli>xAI provider-executed tools such as \u003Ccode>web_search\u003C/code>, \u003Ccode>x_search\u003C/code>, and \u003Ccode>code_execution\u003C/code>\u003C/li>\n\u003Cli>xAI image generation and image editing support\u003C/li>\n\u003Cli>Built-in pricing for documented Grok text models\u003C/li>\n\u003Cli>Request inspection support in the admin UI\u003C/li>\n\u003C/ul>\u003C/div>\u003C/div>\n\u003Ch2 id=\"installation\">\u003Ca class=\"docs-anchor\" href=\"#installation\" aria-label=\"Link to this section\">\u003C/a>Installation\u003C/h2>\n\u003Cfigure class=\"docs-code\" data-docs=\"code\" data-lang=\"bash\">\u003Cfigcaption class=\"docs-code-title\">pnpm\u003C/figcaption>\u003Cpre class=\"shiki shiki-themes one-light github-dark\" style=\"--shiki-light:#383A42;--shiki-dark:#e1e4e8;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#24292e\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#4078F2;--shiki-dark:#B392F0\">pnpm\u003C/span>\u003Cspan style=\"--shiki-light:#50A14F;--shiki-dark:#9ECBFF\"> add\u003C/span>\u003Cspan style=\"--shiki-light:#50A14F;--shiki-dark:#9ECBFF\"> @standardagents/xai\u003C/span>\u003C/span>\u003C/code>\u003C/pre>\u003C/figure>\n\u003Ch2 id=\"quick-start\">\u003Ca class=\"docs-anchor\" href=\"#quick-start\" aria-label=\"Link to this section\">\u003C/a>Quick Start\u003C/h2>\n\u003Cfigure class=\"docs-code\" data-docs=\"code\" data-lang=\"typescript\">\u003Cpre class=\"shiki shiki-themes one-light github-dark\" style=\"--shiki-light:#383A42;--shiki-dark:#e1e4e8;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#24292e\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#A626A4;--shiki-dark:#F97583\">import\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\"> { \u003C/span>\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\">defineModel\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\"> } \u003C/span>\u003Cspan style=\"--shiki-light:#A626A4;--shiki-dark:#F97583\">from\u003C/span>\u003Cspan style=\"--shiki-light:#50A14F;--shiki-dark:#9ECBFF\"> '@standardagents/spec'\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">;\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#A626A4;--shiki-dark:#F97583\">import\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\"> { \u003C/span>\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\">xai\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\"> } \u003C/span>\u003Cspan style=\"--shiki-light:#A626A4;--shiki-dark:#F97583\">from\u003C/span>\u003Cspan style=\"--shiki-light:#50A14F;--shiki-dark:#9ECBFF\"> '@standardagents/xai'\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">;\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#A626A4;--shiki-dark:#F97583\">export\u003C/span>\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#F97583\"> default\u003C/span>\u003Cspan style=\"--shiki-light:#4078F2;--shiki-dark:#B392F0\"> defineModel\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">({\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\">  name\u003C/span>\u003Cspan style=\"--shiki-light:#0184BC;--shiki-dark:#E1E4E8\">:\u003C/span>\u003Cspan style=\"--shiki-light:#50A14F;--shiki-dark:#9ECBFF\"> 'grok-default'\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">,\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\">  provider\u003C/span>\u003Cspan style=\"--shiki-light:#0184BC;--shiki-dark:#E1E4E8\">:\u003C/span>\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\"> xai\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">,\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\">  model\u003C/span>\u003Cspan style=\"--shiki-light:#0184BC;--shiki-dark:#E1E4E8\">:\u003C/span>\u003Cspan style=\"--shiki-light:#50A14F;--shiki-dark:#9ECBFF\"> 'grok-4-0709'\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">,\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\">  providerOptions\u003C/span>\u003Cspan style=\"--shiki-light:#0184BC;--shiki-dark:#E1E4E8\">:\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\"> {\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\">    reasoningEffort\u003C/span>\u003Cspan style=\"--shiki-light:#0184BC;--shiki-dark:#E1E4E8\">:\u003C/span>\u003Cspan style=\"--shiki-light:#50A14F;--shiki-dark:#9ECBFF\"> 'high'\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">,\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">  },\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">});\u003C/span>\u003C/span>\u003C/code>\u003C/pre>\u003C/figure>\n\u003Ch2 id=\"common-models\">\u003Ca class=\"docs-anchor\" href=\"#common-models\" aria-label=\"Link to this section\">\u003C/a>Common Models\u003C/h2>\n\u003Cul>\n\u003Cli>\u003Ccode>grok-4-0709\u003C/code>\u003C/li>\n\u003Cli>\u003Ccode>grok-4-fast-reasoning\u003C/code>\u003C/li>\n\u003Cli>\u003Ccode>grok-4-1-fast-reasoning\u003C/code>\u003C/li>\n\u003Cli>\u003Ccode>grok-code-fast-1\u003C/code>\u003C/li>\n\u003Cli>\u003Ccode>grok-3\u003C/code>\u003C/li>\n\u003Cli>\u003Ccode>grok-imagine-image\u003C/code>\u003C/li>\n\u003Cli>\u003Ccode>grok-imagine-image-pro\u003C/code>\u003C/li>\n\u003C/ul>\n\u003Ch2 id=\"provider-options\">\u003Ca class=\"docs-anchor\" href=\"#provider-options\" aria-label=\"Link to this section\">\u003C/a>Provider Options\u003C/h2>\n\u003Cp>Chat options include \u003Ccode>reasoningEffort\u003C/code>, \u003Ccode>logprobs\u003C/code>, \u003Ccode>topLogprobs\u003C/code>, \u003Ccode>store\u003C/code>, and \u003Ccode>previousResponseId\u003C/code>.\u003C/p>\n\u003Cp>Image options include \u003Ccode>aspect_ratio\u003C/code>, \u003Ccode>output_format\u003C/code>, \u003Ccode>resolution\u003C/code>, \u003Ccode>quality\u003C/code>, and \u003Ccode>numberOfImages\u003C/code>.\u003C/p>\n\u003Ch2 id=\"provider-tools\">\u003Ca class=\"docs-anchor\" href=\"#provider-tools\" aria-label=\"Link to this section\">\u003C/a>Provider Tools\u003C/h2>\n\u003Cp>xAI built-in tools are provider-executed. Enable provider-defined names on the\nmodel and select them from prompts:\u003C/p>\n\u003Cfigure class=\"docs-code\" data-docs=\"code\" data-lang=\"typescript\">\u003Cpre class=\"shiki shiki-themes one-light github-dark\" style=\"--shiki-light:#383A42;--shiki-dark:#e1e4e8;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#24292e\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#A626A4;--shiki-dark:#F97583\">export\u003C/span>\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#F97583\"> default\u003C/span>\u003Cspan style=\"--shiki-light:#4078F2;--shiki-dark:#B392F0\"> defineModel\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">({\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\">  name\u003C/span>\u003Cspan style=\"--shiki-light:#0184BC;--shiki-dark:#E1E4E8\">:\u003C/span>\u003Cspan style=\"--shiki-light:#50A14F;--shiki-dark:#9ECBFF\"> 'grok-research'\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">,\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\">  provider\u003C/span>\u003Cspan style=\"--shiki-light:#0184BC;--shiki-dark:#E1E4E8\">:\u003C/span>\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\"> xai\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">,\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\">  model\u003C/span>\u003Cspan style=\"--shiki-light:#0184BC;--shiki-dark:#E1E4E8\">:\u003C/span>\u003Cspan style=\"--shiki-light:#50A14F;--shiki-dark:#9ECBFF\"> 'grok-4-0709'\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">,\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\">  providerTools\u003C/span>\u003Cspan style=\"--shiki-light:#0184BC;--shiki-dark:#E1E4E8\">:\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\"> [\u003C/span>\u003Cspan style=\"--shiki-light:#50A14F;--shiki-dark:#9ECBFF\">'x_search'\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">, \u003C/span>\u003Cspan style=\"--shiki-light:#50A14F;--shiki-dark:#9ECBFF\">'web_search'\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">, \u003C/span>\u003Cspan style=\"--shiki-light:#50A14F;--shiki-dark:#9ECBFF\">'code_execution'\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">],\u003C/span>\u003C/span>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#E1E4E8\">});\u003C/span>\u003C/span>\u003C/code>\u003C/pre>\u003C/figure>\n\u003Cp>Image and video understanding helpers are modeled as provider tool names in\nStandard Agents Builder and translated by \u003Ccode>@standardagents/xai\u003C/code> into the corresponding xAI\nsearch-tool options. Completed xAI tool calls are reported through the generic\nStandard Agents provider-tool log path, not the local function executor.\u003C/p>\n\u003Ch2 id=\"environment-setup\">\u003Ca class=\"docs-anchor\" href=\"#environment-setup\" aria-label=\"Link to this section\">\u003C/a>Environment Setup\u003C/h2>\n\u003Cfigure class=\"docs-code\" data-docs=\"code\" data-lang=\"bash\">\u003Cfigcaption class=\"docs-code-title\">.dev.vars\u003C/figcaption>\u003Cpre class=\"shiki shiki-themes one-light github-dark\" style=\"--shiki-light:#383A42;--shiki-dark:#e1e4e8;--shiki-light-bg:#FAFAFA;--shiki-dark-bg:#24292e\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#E45649;--shiki-dark:#E1E4E8\">XAI_API_KEY\u003C/span>\u003Cspan style=\"--shiki-light:#383A42;--shiki-dark:#F97583\">=\u003C/span>\u003Cspan style=\"--shiki-light:#50A14F;--shiki-dark:#9ECBFF\">...\u003C/span>\u003C/span>\u003C/code>\u003C/pre>\u003C/figure>",[9,13,16,19,22,25,28],{"id":10,"text":11,"depth":12},"overview","Overview",2,{"id":14,"text":15,"depth":12},"installation","Installation",{"id":17,"text":18,"depth":12},"quick-start","Quick Start",{"id":20,"text":21,"depth":12},"common-models","Common Models",{"id":23,"text":24,"depth":12},"provider-options","Provider Options",{"id":26,"text":27,"depth":12},"provider-tools","Provider Tools",{"id":29,"text":30,"depth":12},"environment-setup","Environment Setup","providers/xai","docs","Providers",{"path":35,"title":36,"navTitle":36},"providers/typesafe","@standardagents/typesafe","/docs/providers/xai.md","https://github.com/standardagents/agentbuilder/blob/main/docs/providers/xai.mdx",1794580510094]