Grok Imagine API access for AI agents: run image and video generation operations, poll asynchronous results, and check pricing through one focused MCP server.
Works with Claude Code, Codex, Cursor, Windsurf, VS Code, Roo Code, and any MCP-compatible host.
Install | Tools | Models | Agent Prompts | Configuration | Links
--- ## Why This Package? `@runapi.ai/grok-imagine-mcp` is a focused Model Context Protocol server for the **Grok Imagine** model line on RunAPI. It gives MCP-compatible assistants direct access to 7 endpoints and 7 model variants without loading the full RunAPI catalog. Use this per-model server when an agent should stay scoped to Grok Imagine. Use [`@runapi.ai/mcp`](https://github.com/runapi-ai/mcp) when one assistant should discover every RunAPI model line. --- ## Install Add it to Claude Code: ```bash claude mcp add grok-imagine -s user -- npx -y @runapi.ai/grok-imagine-mcp ``` Use project scope when the server should be shared with a repository: ```bash claude mcp add grok-imagine -s project -- npx -y @runapi.ai/grok-imagine-mcp ``` Codex, Cursor, Windsurf, VS Code, Roo Code, and other MCP hosts can use the same stdio command: ```json { "mcpServers": { "grok-imagine": { "command": "npx", "args": ["-y", "@runapi.ai/grok-imagine-mcp"] } } } ``` `check_pricing` works before sign-in. For task creation and status polling, ask your assistant to call the `login` tool. It opens a browser login and saves credentials to `~/.config/runapi/config.json`, the same file used by `runapi login`. Headless and CI hosts can still set `RUNAPI_API_KEY` before starting the MCP host. Ready-made examples are in [`examples/`](examples/) for Claude, Cursor, Windsurf, VS Code, and Roo Code. --- ## Tools | Tool | Auth | Purpose | |---|---|---| | `edit_image` | Yes | Create a Grok Imagine edit image task and optionally wait for a terminal status. Returns the task id, status, and output URLs. | | `extend_video` | Yes | Create a Grok Imagine extend video task and optionally wait for a terminal status. Returns the task id, status, and output URLs. | | `image_to_video` | Yes | Create a Grok Imagine image to video task and optionally wait for a terminal status. Returns the task id, status, and output URLs. | | `segment_map` | Yes | Create a Grok Imagine segment map task and optionally wait for a terminal status. Returns the task id, status, and output URLs. | | `text_to_image` | Yes | Create a Grok Imagine text to image task and optionally wait for a terminal status. Returns the task id, status, and output URLs. | | `text_to_video` | Yes | Create a Grok Imagine text to video task and optionally wait for a terminal status. Returns the task id, status, and output URLs. | | `upscale_image` | Yes | Create a Grok Imagine upscale image task and optionally wait for a terminal status. Returns the task id, status, and output URLs. | | `get_task` | Yes | Fetch the current status and latest payload for an existing task. | | `check_pricing` | No | Look up current pricing for a Grok Imagine model and endpoint. | --- ## Models Grok Imagine covers 7 model variants across 7 endpoints. Each tool accepts the models listed for it: | Tool | Models | |---|---| | `edit_image` | `grok-imagine-edit-image`, `grok-imagine-image-2-0` | | `extend_video` | _no model parameter_ | | `image_to_video` | `grok-imagine-image-to-video`, `grok-imagine-video-1.5-fast`, `grok-imagine-video-1.5-preview` | | `segment_map` | `grok-imagine-image-2-0` | | `text_to_image` | `grok-imagine-image-2-0`, `grok-imagine-text-to-image` | | `text_to_video` | `grok-imagine-text-to-video`, `grok-imagine-video-1.5-fast`, `grok-imagine-video-1.5-preview` | | `upscale_image` | _no model parameter_ | Model availability can change between releases. Use `check_pricing` or the [Grok Imagine model page](https://runapi.ai/models/grok-imagine) for the current catalog view. --- ## Agent Prompts Ask your assistant in natural language; it can inspect pricing, create the task, and return the task id plus output URLs. ### Create a task ```text Run a Grok Imagine edit image task with RunAPI. ``` The assistant can call `check_pricing`, then `edit_image`, and return the task id, status, and output URLs. ### Submit without waiting ```text Create the task but don't wait for it to finish. ``` The assistant calls the create tool with `wait: false` and returns the task id. Check on it later with `get_task`. ### Check pricing before creating ```text Check current Grok Imagine pricing, then create the task if it matches my request. ``` The assistant calls `check_pricing` and can link to the [Grok Imagine model page](https://runapi.ai/models/grok-imagine) for the canonical catalog entry. --- ## Configuration The server resolves auth in this order: 1. `RUNAPI_API_KEY` environment variable, useful for headless and CI hosts 2. `~/.config/runapi/config.json`, created by the MCP `login` tool or `runapi login` 3. No key, which still allows `check_pricing` The config file is normally managed by login. A pre-provisioned headless config can use: ```json { "apiKey": "your_runapi_key" } ``` Do not commit real API keys. --- ## Links | Resource | URL | |---|---| | Grok Imagine model page | [https://runapi.ai/models/grok-imagine](https://runapi.ai/models/grok-imagine) | | npm package | [@runapi.ai/grok-imagine-mcp](https://www.npmjs.com/package/@runapi.ai/grok-imagine-mcp) | | GitHub repository | [runapi-ai/grok-imagine-mcp](https://github.com/runapi-ai/grok-imagine-mcp) | | RunAPI MCP overview | [runapi.ai/mcp](https://runapi.ai/mcp) | | RunAPI docs | [runapi.ai/docs](https://runapi.ai/docs) | --- ## License Licensed under the [Apache License, Version 2.0](LICENSE).