API Debugger

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.

Execute With

The Execute with control in the session bar sets which session the API Debugger uses to run a request. It persists across refreshes.

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.

Designer mode works for designer endpoints. It also works for two Express endpoints, Execute Module and Execute via Proxy, which accept a Designer session for debugging by impersonating an Express role. Other Express endpoints do not accept a Designer session, so use Express mode to call them.

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 ran.

If the selected role lacks designer access, designer-only API endpoints might 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. Any method of signing in to Express works, in any browser tab. The debugger detects the active session, so the sign-in tab it opens is optional.

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

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.

Creators who use Express SSO can sign in through whichever method they normally use. The debugger detects the active Express session and uses it, so the sign-in tab that opens from the debugger doesn't need to be the way they sign in.

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 and Execute via Proxy endpoints are exempt. When the hostname is not configured, the session bar displays a CORS warning with a link to open Environment Administration.

Internal Tab

The Internal tab sends a request to an internal API endpoint. The available endpoints are the internal Unqork APIs.

Request Settings Tabs

The Internal tab includes the following settings tabs for the request.

The Body tab provides two modes for building 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 icon on the group row.

Result Tabs

After clicking Execute, the results display in the tabs at the bottom of the panel. The Response tab displays for every endpoint. The following four tabs display only for the Execute Module and Execute via Proxy endpoints:

To use the Event Log and Timeline tabs to find slow steps, see Finding Slow Steps.