Skip to main content
A REST API response is the data returned by the API after an application makes an HTTP request. It typically includes an HTTP status code indicating the result of the request, a response body that contains the requested data, and headers that provide metadata. The response may also include cookies set by the server. Auk uplifts this experience by providing an intuitive interface for analyzing responses, making it easier for you to visualize and interact with API data effectively.

​
Response Body

Depending on the content type of the response, Auk automatically presents the data in the appropriate format:
  • JSON: Formats the response in a structured JSON format for easy readability.
  • HTML: Renders the response as HTML for visual representation and structure content as a web page.
  • XML: Shows the response in XML format for compatibility with XML-based APIs.
  • Image: Displays image responses directly in the interface.

​
Raw Response

The Raw response tab in Auk presents the unprocessed response body, allowing you to view the exact data returned by the API without any formatting which can be particularly used for debugging or when you need to inspect the original response directly.

​
Response Headers

Response Headers give you important information about the API response that goes beyond just the data itself. They include information such as the content type, which indicates the format of the response (e.g., application/json or text/html), caching directives that control how the response can be stored and reused, security settings like CORS (Cross-Origin Resource Sharing) that help manage access, and various server-related information, like the server type and version.

​
Test Results

The Test Results section displays the outcomes of any assertions made on the API response, allowing you to verify key aspects such as status codes, response times, and the presence of expected data.

​
Save a response as an Example

In Auk, an example connects a specific request with its response, providing a complete view of how an API behaves. Each example includes the essential request details alongside the response information. You can create multiple examples for a single request, which is valuable for illustrating how the same endpoint might respond differently under various conditions. To save a response as an example in Auk, follow these steps:
  • Navigate to the right-sidebar and select the collection with your request.
  • Choose the request and hit “Send.”
  • In the response section, click the “Save as Example” icon.
  • The example will be stored in request’s history in the collection for easy retrieval and reference later.
  • Click on the example and select “Try” to open it as a request in a new tab.
You can easily Edit the response details using the menu icon, Save any changes made to the examples, and Duplicate them to generate various iterations. Using examples for API mocking: Saved examples can be used to create mock servers in Auk. When you create a mock server from a collection, each saved example automatically becomes a mock route with the exact response you captured. This lets you quickly convert real API behavior into mock endpoints for testing, prototyping, or development without a backend.
Auk also supports importing collections with examples attached to each request from various platforms, including Postman, Insomnia, OpenAPI, and Auk.

​
Filter Response Body

To extract specific data points from the response body, you can apply filters using jq syntax. jq is a powerful and flexible command-line JSON processor that allows you to slice, filter, map, and transform JSON data with ease.
Migration Notice: JSONPath has been replaced with jq for JSON response filtering. If you have existing JSONPath filters, you’ll need to migrate them to jq syntax. Refer to the jq manual for detailed documentation on jq syntax and features.

​
Download Response

You can download the response in various formats (JSON, XML, etc.) for offline analysis or record-keeping. Click the “Download” button and choose the format you wish to save.

​
Copy Response

To copy the entire response to the clipboard, simply click the “Copy” button.

​
Generate Data Schema

Using the “More” menu, you can generate a structured representation of the response data tailored to specific programming languages. You can download the file or copy the response in languages like TypeScript, C#, Go, and others, making it simpler for you to incorporate API responses into your applications.