API Client Documentation

The Unfour API Client lets you build, send, save, and inspect HTTP requests inside the active workspace, with shared variables, request scripts, history, and OpenAPI collection exchange.

Create and send a request

  1. Open API Client and create a request tab.
  2. Choose GET, POST, PUT, PATCH, DELETE, HEAD, or OPTIONS and enter the URL.
  3. Add enabled query parameters and headers. Configure No Auth, Bearer Token, Basic Auth, or an API Key placed in a header or query parameter.
  4. Choose no body, raw JSON or text, or x-www-form-urlencoded fields.
  5. Select Send. The resolved request is sent locally and its history entry is saved with sensitive fields masked.

Collections and folders

A collection is the top-level group for saved API requests. Folders organize requests inside a collection; folders can be nested. A saved request belongs to one collection and may belong to a folder.

  • Create or rename a collection from the API sidebar.
  • Create, rename, move, reorder, or delete folders and saved requests with the tree actions.
  • Use Save to place the current request in a collection and optional folder.
  • Duplicate a saved request when you need a variation without replacing the original.

Environments and variables

Variables are owned by the workspace. Workspace-global variables provide defaults; the active environment overlays values for a specific target. API requests consume the resolved result.

Variable syntax
{{base_url}}/v1/users/{{user_id}}
  1. Open the Workspace environment editor and create variables.
  2. Create an environment for values that differ by target, then make that environment active from the title bar.
  3. Use {{variable}} in URLs, headers, query values, authentication fields, bodies, and supported scripts.
  4. Review the active environment before sending a request to avoid targeting the wrong service.

Inspect the response

Status and body

Review the HTTP status, response size, and formatted or raw body.

Headers and cookies

Inspect returned headers and parsed cookies in separate tabs.

Timing and request

Review total duration and the resolved request snapshot that was sent.

History

Open a redacted request/response history entry and reuse it in a request tab.

Scripts

Saved requests can run bounded JavaScript before a request and after a response. The scripting surface is intentionally limited and is not a claim of complete Postman scripting API compatibility.

  • Pre-request scripts can adjust the outgoing request and read or update supported workspace and environment variables.
  • Post-response scripts can inspect the response, record tests, and write messages to the dedicated Console.
  • Tests, console output, script status, duration, timeouts, and errors appear in response tabs.
  • A pre-request failure stops the HTTP send; a post-response failure leaves the received response visible.

Import and export

Import an OpenAPI 3.x document in JSON or YAML to create a collection. Export a collection as OpenAPI 3.1 JSON or YAML.