This page focuses on the connection layer: how each agent finds Zap and executes it. For the agent behavioral contract (read
SKILL.md first, keep spend opt-in, etc.), see Agent Setup. For the tools the Eve runtime exposes to agents, see Agent Overview.The Skill Download URLs
Every agent bootstraps from the same three endpoints. Point your agent at these before any other configuration:
Appending
?format=json returns { skill, hash, files: [{ path, content }] } instead of raw Markdown — preferable for programmatic ingestion.
CLI Contract
All agents drive Zap through the same CLI. Two commands are enough for a full flow:--json so output is machine-parseable. The result envelope contains runId, status, zapUrl, and a per-step breakdown — no additional API is needed to observe progress.
Per-Agent Setup
- Codex
- Claude Code
- Cursor
- OpenClaw
- Hermes
- Generic MCP / other
OpenAI Codex CLI
Codex reads project instructions fromAGENTS.md at the repo root. zap init writes this file automatically. To point Codex at the remote registry as well, add a zap section to your Codex configuration or paste the following into a session prompt:Handshake Flow
Every supported agent follows the same startup sequence. If your agent isn’t listed above, replicate this flow:1
Fetch the skill manifest
hash, path, and downloadUrl. Cache the manifest and diff against local agent/skills/ on subsequent starts to detect drift.2
Read the core framework skill
3
Read the authoring skill before editing recipes
Zap.md edit.4
Validate and run
--live after the user has approved the quoted spend.Live-Run Handshake
When a creator asks for a real (paid) run, every agent must follow the same three-step handshake:1
Show the quote
Run in mock first with
--json and surface the quoteUsd field to the user. Do not proceed if the quote exceeds budget.cap_usd.2
Confirm credentials are present
For CLI runs, verify
GMI_API_KEY (or the required provider key) is exported. For web runs, verify the creator has connected a wallet and uploaded keys via Auth & Secrets.3
Dispatch with --live and capture the runId
runId so status can be polled with zap status <runId> or GET /runs/<runId>.Related
- Agent Setup — the behavioral contract every agent must follow.
- Agent Overview — Eve tools, pipeline grammar, and the primitive vs deterministic distinction.
- Providers — the seven BYOK secret types and provider routing.
- GMI Cloud (BYOK) — real live-run instructions for the primary video provider.
