Skip to content

// DOCUMENTATION

Public API authentication

Create purpose-specific integration keys and send them safely.

Create a key

Open Workspace settings → Integrations. Create a dedicated mock-server or SDK-generation key and optionally set expiration. Authorized workspace editors can reveal and copy the encrypted key later.

Bearer authentication

Send the key in the Authorization header. Never place it in a URL, source control, browser storage, logs, or generated configuration.

curl -H "Authorization: Bearer $REST_TEST_API_TOKEN" \
+  https://api.example.com/api/public/v1/workspace

Integration permissions

Permissions are assigned by integration type instead of user-selected checkboxes.

  • Mock server key — authenticated cloud mock execution only
  • SDK generation key — definition, operation, and schema reads plus type and SDK generation

// GET STARTED

Bring your API workflow into one workspace.

Start with an OpenAPI or Swagger JSON definition and keep the workflow together.

Start for free