SLIDESHOT [docs] Markdown
For agents: read the markdown version of these docs →

Codex setup

OpenAI Codex CLI can call Slideshot through the MCP server or the CLI. Use the MCP path for interactive recording sessions and the CLI for scripted runs that need to fit into shell pipelines.

Copy this into Codex

Paste this instruction into Codex and let it handle the setup steps.

You are helping me connect Slideshot to the Codex CLI.

1. Add the Slideshot MCP server at https://api.slideshot.ai/mcp to my Codex
   configuration. Walk me through the OAuth approval if it opens a browser tab.
2. Install the Slideshot skill from https://github.com/slideshot/skills so you
   know how to plan a Slideshot recording.
3. If shell access is available, you can also use the Slideshot CLI directly
   via `npx slideshot <command>` with `SLIDESHOT_API_KEY` set in my shell.
4. Create one test recording against a public URL and download `demo.mp4` when
   the run succeeds.

Do not print my API key or credentials in any output.

1. Add the MCP server

Codex reads MCP servers from its configuration file. Add Slideshot:

{
  "mcpServers": {
    "slideshot": {
      "transport": "http",
      "url": "https://api.slideshot.ai/mcp"
    }
  }
}

On first use, Codex opens the OAuth approval page in your browser. After you approve, Codex caches the access and refresh tokens and the Slideshot tools become callable inside the conversation.

2. Install the Slideshot skill

The skill teaches Codex when to enable video.blur_emails, video.shortcuts, artifacts.gif, and how to deal with runs that pause on an OTP step.

The fastest install is the shared skills installer:

npx skills install slideshot

Pick Codex from the list of detected agents. For the manual path, clone github.com/slideshot/skills and copy skills/slideshot/SKILL.md into your Codex configuration directory.

3. Use the CLI

Export your API key once in the shell Codex runs commands in:

export SLIDESHOT_API_KEY="sk_live_xxxx"

Then call the CLI through npx so it always uses the latest version:

npx slideshot runs create https://app.example.com \
  --goal "Open the analytics dashboard and create a new project" \
  --options '{"artifacts":{"gif":true}}'

Test the setup

Ask Codex to record a small workflow, for example:

Create a Slideshot recording of https://stripe.com showing the homepage and the pricing page.

Codex should call create_run, poll until succeeded, list artifacts, and download demo.mp4.

Troubleshooting

  • MCP server not appearing in tool list. Confirm the config file path Codex reads and restart the agent.
  • OAuth approval window did not return. Re-run the MCP setup and double-check the redirect URI Codex registered.
  • 401 invalid_token. Re-authorize the MCP connection. The refresh token may have expired.
  • CLI cannot reach the API. Make sure SLIDESHOT_API_KEY is set in the shell Codex runs commands in.