Files
openclaw-openclaw/docs/tools/code-execution.md
Peter Steinberger f7d7148cf0 docs: rewrite published docs grounded in current source (#100142)
Source-grounded rewrite of 529 published docs pages with per-unit information-loss verification: 1,713 factual corrections cited to src/**, generated surfaces regenerated, frontmatter titles preserved for i18n, release notes pages untouched. All docs gates green.

Closes #100141
2026-07-05 00:32:47 -04:00

5.2 KiB

summary, read_when, title
summary read_when title
code_execution: run sandboxed remote Python analysis with xAI
You want to enable or configure code_execution
You want remote analysis without local shell access
You want to combine x_search or web_search with remote Python analysis
Code execution

code_execution runs sandboxed remote Python analysis on xAI's Responses API (https://api.x.ai/v1/responses, same endpoint x_search uses). It is registered by the bundled xai plugin under the tools contract.

Property Value
Tool name code_execution
Provider plugin xai (bundled, enabledByDefault: true)
Auth xAI auth profile, XAI_API_KEY, or plugins.entries.xai.config.webSearch.apiKey
Default model grok-4-1-fast
Default timeout 30 seconds
Default maxTurns unset (xAI applies its own internal limit)

Use it for calculations, tabulation, quick statistics, and chart-style analysis, including data returned by x_search or web_search. It has no access to local files, your shell, your repo, or paired devices, and it does not persist state between calls, so treat each call as ephemeral analysis, not a notebook session. For fresh X data, run x_search first and pipe the result in.

For local execution, use exec instead.

Setup

OAuth requires an eligible SuperGrok or X Premium subscription (device-code verification, so it works from remote hosts without a localhost callback):
```bash
openclaw models auth login --provider xai --method oauth
```

During a fresh install, the same choice is available in onboarding:

```bash
openclaw onboard --install-daemon --auth-choice xai-oauth
```

Or an API key:

```bash
openclaw models auth login --provider xai --method api-key
export XAI_API_KEY=xai-...
```

Or via config:

```json5
{
  plugins: {
    entries: {
      xai: {
        config: {
          webSearch: {
            apiKey: "xai-...",
          },
        },
      },
    },
  },
}
```

Any of these three also power `x_search` and Grok `web_search`.
`code_execution` is available whenever xAI credentials resolve. Set `plugins.entries.xai.config.codeExecution.enabled` to `false` to disable it, or use the same block to override the model, turn cap, or timeout:
```json5
{
  plugins: {
    entries: {
      xai: {
        config: {
          codeExecution: {
            enabled: true,
            model: "grok-4-1-fast", // override the default xAI code-execution model
            maxTurns: 2,            // optional cap on internal tool turns
            timeoutSeconds: 30,     // request timeout (default: 30)
          },
        },
      },
    },
  },
}
```
```bash openclaw gateway restart ```
`code_execution` appears in the agent's tool list once the xAI plugin
re-registers with `enabled: true`.

How to use it

Make the analysis intent explicit; the tool takes a single task parameter, so send the full request and any inline data in one prompt:

Use code_execution to calculate the 7-day moving average for these numbers: ...
Use x_search to find posts mentioning OpenClaw this week, then use code_execution to count them by day.
Use web_search to gather the latest AI benchmark numbers, then use code_execution to compare percent changes.

Errors

Without auth, the tool returns a structured JSON error (not a thrown exception), so the agent can self-correct:

{
  "error": "missing_xai_api_key",
  "message": "code_execution needs xAI credentials. Run `openclaw onboard --auth-choice xai-oauth` to sign in with Grok, run `openclaw onboard --auth-choice xai-api-key`, set `XAI_API_KEY` in the Gateway environment, or configure `plugins.entries.xai.config.webSearch.apiKey`.",
  "docs": "https://docs.openclaw.ai/tools/code-execution"
}
Local shell execution on your machine or paired node. Allow/deny policy for shell execution. `web_search`, `x_search`, and `web_fetch`. Grok models, web/x search, and code execution config.