Requests

Requests are the core of API testing in RESTK. Each request lets you configure the HTTP method, URL, parameters, headers, body, authentication, and scripts.

Quick Start

---

HTTP Methods

Select the appropriate method for your API endpoint. Each method has a distinct color in the UI for quick identification.

---

URL and Parameters

Entering the URL

Type or paste the complete URL in the URL field:

https://api.example.com/v1/users

Using Variables

Reference variables with double curly braces:

{{baseUrl}}/v1/users/{{userId}}

As you type {{, an autocomplete dropdown shows available variables from all scopes.

Query Parameters

Example:

Sends: ?page=1&limit=10 (debug is disabled)

---

Authentication

Requests can inherit authentication from their parent folder or collection, or define their own.

Inherit from Parent

By default, requests use Inherit, which walks up the full hierarchy:

• Request → Folder → Parent Folders → Collection
• The first level with explicit auth is used
• RESTK shows the source of the active auth

Override Authentication

Auth Types

---

Headers

Add custom HTTP headers to your request.

Adding Headers

Common Headers

Content-Type

Content-Type: application/json

Accept

Accept: application/json

Custom Headers

X-Request-ID: {{requestId}}
X-Client-Version: 1.0.0

---

Request Body

Configure the request body for POST, PUT, PATCH, and other requests that support a body.

Body Types

RESTK supports six body types:

None

• No request body
• Default for GET, HEAD, and OPTIONS

Raw

• Text-based body with a sub-format picker: JSON, XML, HTML, JavaScript, or Plain Text
• JSON includes syntax highlighting, validation, and a format/prettify shortcut (Option+Shift+F)
• Auto-sets the appropriate Content-Type header based on the selected sub-format

{
  "name": "John Doe",
  "email": "[email protected]",
  "age": {{userAge}}
}

Form Data

• For file uploads and multipart form submissions
• Content-Type: multipart/form-data

URL Encoded

• For traditional form submissions
• Content-Type: application/x-www-form-urlencoded

Binary

• Upload a raw binary file as the request body
• Useful for file upload APIs, image processing endpoints, and binary protocols

GraphQL

• Dedicated GraphQL body type with query and variables fields
• Separate input areas for the GraphQL query and variables JSON

query GetUser($id: ID!) {
  user(id: $id) {
    name
    email
    posts {
      title
    }
  }
}

---

Scripts

Automate workflows and run tests with JavaScript scripts.

Pre-request Scripts

Run code before the request is sent.

Common uses:

• Generate timestamps
• Calculate signatures
• Set dynamic headers
• Modify request data

// Generate timestamp
nova.variable.set("timestamp", Date.now().toString());

// Create custom header value
const signature = calculateSignature();
nova.request.setHeader("X-Signature", signature);

Post-response Scripts

Run code after receiving the response.

Common uses:

• Test response data
• Extract values for later use
• Validate status codes
• Process response data

// Test the response
nova.test("Status is 200", function() {
  nova.expect(nova.response.status).toBe(200);
});

nova.test("Response has user ID", function() {
  const data = nova.response.json();
  nova.expect(data).toHaveProperty("id");

  // Save for next request
  nova.variable.set("userId", data.id);
});

Script Execution Order

When you send a request, scripts run in this order:

1. Collection pre-request
2. Folder pre-request (if in folder)
3. Request pre-request
4. HTTP request is sent
5. Request post-response
6. Folder post-response (if in folder)
7. Collection post-response

Skipping Parent Scripts

Check Skip Parent Scripts to run only the request's scripts, ignoring collection and folder scripts.

---

Request Variables

Define variables scoped to a single request.

Variable Priority

Request variables have the highest priority:

1. Request variables (highest)
2. Folder variables
3. Parent folder variables (if nested)
4. Collection variables
5. Environment variables (lowest)

---

Sending Requests

Send and View Response

Cancel Request

If a request is taking too long, click Cancel to stop it.

Timeout

Requests timeout based on:

1. Request-specific timeout (if set in the Settings tab)
2. Collection timeout setting
3. Default timeout (30 seconds)

---

Managing Requests

Renaming

1. Double-click the request name in the sidebar
2. Edit the name inline
3. Press Enter to confirm

Duplicating

1. Right-click the request
2. Select Duplicate
3. A copy is created with " Copy" suffix

Moving

Drag and drop requests between folders:

• Drag onto a folder to move inside
• Drag to reorder within the same folder

Deleting

1. Right-click the request
2. Select Delete
3. Confirm deletion

Copy as cURL

1. Right-click the request
2. Select Copy as cURL
3. Paste in terminal to execute

---

Permissions

Request editing is governed by workspace roles:

---

Tips

• Use variables everywhere: Avoid hardcoding values in URLs, headers, and bodies
• Test with scripts: Add post-response tests to validate API behavior
• Changes save automatically: Your edits are committed as you make them
• Organize with folders: Group related endpoints together
• Name descriptively: "Get User by ID" is clearer than "User Request 1"
• Extract response data: Use scripts to save IDs, tokens, and other values for subsequent requests

---

Next Steps