API Workspace

API Workspace is the API development surface in KeyRunner Desktop. It keeps requests, collections, environments, realtime connections, flows, history, mock servers, certificates, cookies, Vault connections, and developer utilities in one project context.

Build a request

Choose an HTTP method, enter the URL, and configure parameters, authorization, headers, body, scripts, and tests. Use {{variable}} anywhere supported to reference the selected environment without copying environment-specific values into the request.

The request tab indicates unsaved edits, similar to a code editor. Save the request to a collection when it is ready to share or reuse. A green check on a collection means it is marked QA ready.

Work with responses

After execution, the Response panel shows status, duration, size, body, headers, cookies, decoded JWT data, and test results. KeyRunner also provides:

• History for earlier executions of the current request
• Response Schema to understand the returned JSON structure
• Generate Types to produce typed models from a response
• Use response field to copy a JSONPath or turn a response value into a query parameter, request header, environment variable, or test assertion
• Copy and export actions for sharing response data

History Diff helps compare executions and identify changes in status, headers, and response data.

Authorization and environments

Configure authorization in the Authorization tab. Environment-aware inputs open a variable picker when you type {{. The environment quick peek in the header lets you inspect available variables and jump to the environment editor without leaving the request.

Sensitive variables remain masked until explicitly revealed. Use a secret-store reference for production credentials.

Code and editor workflows

The Code Snippet tab generates client code for the current request. You can copy the snippet, save it to a file, or open it in Visual Studio Code. KeyRunner preserves the request method, URL, headers, and body in the generated output.

Collections and history

Collections organize related requests. Use collection search, sorting, import, export, and context actions to manage large API projects. Request History groups prior executions by date and supports search.

More API tools

• Request flows for visual API automation
• Mock servers for simulated endpoints
• Secret Scanner for detected credentials and environment-variable remediation
• Certificate management for TLS and mTLS
• Cookie management
• Realtime WebSocket, Socket.IO, and Kafka connections
• Developer Tools for URL, JWT, Base64, PKCE, JSON, and cookie utilities

Turn a request into an AI tool

When a request is tested and stable, open Export as AI Tool. KeyRunner uses the request definition as the executable foundation for a governed agent tool. Continue with Export an API request as an AI tool.