Unqork documentation is available in two workspaces: UnqorkAI for the latest AI-first platform, and legacy Unqork for previous versions. Use the drop-down near the logo to switch.

API Debugger

Prev Next

The API Debugger lets Creators send requests to any Unqork API and inspect the results without publishing. Use it to verify logic, check data changes, and trace component execution.

The API Debugger is part of the Dev Overlay Toolbar, the collapsible panel at the bottom of the UnqorkAI platform. To open it, select Debugger from the tool selector in the toolbar and expand the toolbar using the expand icon or keyboard shortcut. The API Debugger is available in all environments.

Request Tabs

The API Debugger panel on the Internal tab showing a Search APIs input, GET HTTP method selector, URL field, Execute button, Execute Options, Docs, Params, Headers, and Body tabs, and Response, Event Log, Data Changes, Timeline, and Execution Chain result tabs.

Tab Description
Internal Sends a request to an internal API endpoint. Search for an endpoint using Search APIs, or enter a URL directly.
External Sends a request to any external service endpoint. Search for a configured service using Search Services, or enter a URL directly.

Internal Tab

The Internal tab sends a request to an internal API endpoint.

Control Description
ListTree Search APIs Searches for an API endpoint to call. Selecting an endpoint pre-fills the HTTP method and URL.
HTTP Method The HTTP method for the request.
URL The endpoint URL. Pre-fills when an endpoint is selected from Search APIs.
Play Execute Sends the request and populates the result tabs below.
Execute Options Collapsible section for additional execution settings.

External Tab

The External tab sends a request to any external endpoint.

Control Description
ListTree Search Services Searches for a configured service to use as the endpoint.
HTTP Method The HTTP method for the request.
URL The URL of the endpoint to call. Enter any valid URL.
Play Execute Sends the request and populates the result tabs below.

Request Settings Tabs

Both the Internal and External tabs include the following settings tabs for the request.

Tab Description
Docs Displays the API documentation for the selected module or service endpoint.
Params Adds query parameters to the request URL as key-value pairs.
Headers Adds HTTP headers to the request.
Body Builds the JSON body to send with the request.

The Body tab provides two modes for building the request body.

Mode Description
Key-Value Build the request body using a visual key-value editor. Use groups to create nested JSON objects.
Raw JSON Enter the request body as a raw JSON string.
Control Description
Trash2 Clear Removes all fields and groups from the body builder.
Plus Add Adds a new key-value field. Inside a group, the field is nested under that group. At the top level, the field is added to the root of the body.
FolderPlus Add Group Adds a new named group that creates a nested JSON object in the request body.

Groups can be expanded or collapsed with the toggle at the left of the group row. Each group displays a field count and its own Add and Add Group controls for nesting content inside it. To delete a group, click the Trash2 icon on the group row.

Execute With

The Execute with control in the session bar sets the authentication identity for Internal tab module executions. It persists across refreshes.

Mode Description
Designer Executes from the designer session, impersonating the selected Express role. No Express sign-in required. Works for all designer accounts, including SSO Creators.
Express Executes using an active Express session. Picks up an existing session from another open tab automatically.

Designer Mode

Designer mode was the original API Debugger authentication method and continues to work the same way. In Designer mode, module executes run through the designer endpoint using the authenticated designer session. No Express sign-in is needed; SSO Creators and all standard designer accounts can execute.

The Run as selector lists available Express roles and controls which role the request impersonates on Execute Module and Execute via Proxy requests. It defaults to Administrator. After execution, the Ran as indicator in the Response panel displays the role the server applied. Environment permissions and production-mode settings can cause the server to ignore the role header; the indicator always reflects the role that actually ran.

If the selected role lacks designer access, designer-only API endpoints may refuse the request. Select a role with the required access, or switch to Express to run as a real Express account.

Express Mode

Express mode runs requests through the Express endpoint using the active Express session. Selecting Express automatically picks up any existing Express session from the browser, including one from another open tab. If no session exists, a sign-in tab opens immediately.

The session bar displays different states depending on the current sign-in status:

State Session bar Action
Signing in "Waiting for sign-in in the other tab…" Reopen Tab brings the sign-in tab to the front if it moved behind the window
Signed in Express identity and role information Switch Express User opens the Express sign-in page to sign in as a different user
Session ended "Your Express session ended." Sign in again opens a new sign-in tab

The Execute button is blocked while the session is ended. The debugger does not fall back to Designer mode automatically when a session ends. A deliberate sign-in choice prevents executions from running under an unintended identity.

If the Express sign-in tab does not work for an Express SSO account, log into Express through the standard SSO method in any browser tab. The debugger recognizes an active Express session regardless of how it was established.

Role display in Express mode

For creator accounts and Express roles with Designer Access, a Run as selector displays the available Express roles for impersonation. The Ran as indicator in the Response panel shows the role the server applied after execution. For standard Express accounts, real roles are listed inline with no impersonation selector, because requests run as the account's actual role.

To return to Designer mode, select Designer in the Execute with control. No additional sign-in is required.

Express endpoints require the designer hostname to be added to the Allowed Origins List (CORS) in Environment Administration. The Execute Module endpoint is exempt. When the hostname is not configured, the session bar displays a CORS warning with a link to open Environment Administration.

Result Tabs

After clicking Execute, the results display in the tabs at the bottom of the panel. The Response tab is always present. The following four tabs display only for Internal mode executions:

Tab Description
Response The HTTP response status and body returned by the request.
Event Log A log of events that occurred during module execution.
Data Changes A record of submission data fields that changed during execution.
Timeline A timing breakdown of each execution step.
Execution Chain The sequence of components that executed during the request.

Changelog

Date Change
2026-10-06 Added Execute With section — Designer and Express modes, Run as selector, Ran as indicator, and CORS requirement.
2026-09-12 Renamed Debugger to API Debugger; updated description to reflect reach across all Unqork APIs.
2026-08-06 Updated access : Debugger moved from Explorer panel Utilities to the Dev Overlay Toolbar. Available in all environments.
2026-07-01 Restored Docs tab to Request Settings. Fixed Explorer link text. Updated screenshots.
2026-06-30 Moved from tools-dropdown/debugger to module-builder/debugger. Updated nav path: Debugger is now accessible from the Explorer panel under Utilities, not the Definition drop-down.
2026-05-27 Initial publication.