Skip to content
DocsOpen API and local execute

Concepts

Open API and local execute

Official Kody doc

Open API and local execute are behind the mcp-api-tool and local-execute feature flags (experiments cohort in production, plus per-user overrides). Signed-in users who are not already enabled can turn them on from this page. They may change or go away.

What they are

  • Open API — JSON HTTP at api.kody.codes (/openapi.json and /v1/*). Interactive docs: api-docs.kody.codes.
  • MCP api tool — run one Open API operation (operationId + params) from a connected agent when mcp-api-tool is on. Use it to mint, list, and revoke scoped API tokens (tokenCreate / tokenList / tokenRevoke). There is no account UI for tokens.
  • Local execute — @kodycodes/cli execute --local runs your module in a local workerd and forwards each kody:runtime call through the CapabilityProxy (/v1/capability-proxy/session and /v1/capability-proxy/call). Needs the local-execute flag and a token that holds the local-execute scope.

How to get access

  1. Experiments — turn on experiments at /account/experiments. Production already enables mcp-api-tool and local-execute for the experiments_opt_in audience.
  2. This page — signed-in users can opt in with the button above. That writes per-user on overrides for both flags without joining the broader experiments cohort.

First local run

  1. With MCP api available, mint a short-lived token (value returned once):

    {
        "operationId": "tokenCreate",
        "params": {
            "name": "kody-cli",
            "scopes": ["local-execute", "account:read"]
        }
    }

    Or from a shell already holding KODY_API_TOKEN with tokens:write and local-execute: use the CLI / MCP api helpers the same way. Prefer MCP tokenCreate for the first token.

  2. Export the value (do not paste it back into chat):

    export KODY_API_TOKEN='kody_at_…'
  3. Run a local module:

    npx @kodycodes/cli execute --local --code 'export default async function main() { return await kody.metaGetCurrentUser({}) }'

List and revoke tokens with MCP api (tokenList, tokenRevoke) or the same operations over HTTP. See the CLI package for flags such as --token.

Metering

Local CPU is not counted as execute or dynamic_worker_day; capabilities you call through the proxy still meter normally.

Where to go next

Working with an agent? This page is also plain markdown at /docs/open-api.md, or load it over MCP with search({ entity: 'guide:open_api' }).