1. Docs
  2. Resources
  3. API Requests

API Requests

API Requests is the project’s API library. You build or import HTTP requests here, try them with Send, and add them as API steps to test cases, so UI and API checks live in the same scenario.

5 min read Updated CustomersAdmins

In short

On this page you can

  • Keep the project’s HTTP requests in collections and folders.
  • Import requests from Postman, Swagger / OpenAPI or a curl command.
  • Try a request with Send and read status, time, size and body.
  • Set authorization once on a collection or folder for its requests.
  • Add a saved request to a test case as an API step.

How to use it

  1. Open API Requests and create a collection with Add Collection.
  2. Click New Request, or import with Import Postman or Import Swagger / OpenAPI.
  3. Fill method, URL, body and Request settings, then Save.
  4. Click Send to check the response.
  5. In Automate, add an API step and pick the request in Select API Request.

At a glance

Where
Main menu › API Requests. Left: the API tree. Middle: the request. Right: Request settings (Authorization, Params, Header).
Who
Every project member creates, edits, sends and deletes requests. Deleting a folder or collection that is not empty needs an Admin.
You need
A selected project and the API’s address. For Send, the API must be reachable from the SmartestQA server.
Time
A request takes a minute; a Swagger import of a whole API takes seconds.
Produces
Saved requests: method, URL, headers, query parameters, body and authorization.
Used by
API steps in Automate (each step keeps its own copy) and AI assistants through MCP.
Project types
The same in WEB, MOBILE and DESKTOP projects. API steps can sit next to UI steps in any scenario.

Start from your question#

Where API Requests fits#

API Requests sits beside the order of work, like Data Source. You fill the library before or while you automate; Automate copies requests into steps.

  1. 1DiscoverPages and controls
  2. 2AnalyzeRequirements
  3. 3AutomateAPI steps copy saved requests
  4. 4SchedulePipelines run them
  5. 5ReportRequest and response in the step log
  6. 6MaintenanceFix the step’s copy

Why use it#

  • UI and API in one scenario. Create an order through the API, check it in the browser, or the other way round.
  • Start from what you have. Postman collections, Swagger / OpenAPI specs and curl commands from the browser’s developer tools become requests.
  • One place for authorization. Set a Bearer token or Basic Auth on a collection or folder and let requests inherit it while you try them here.
  • Data from Data Source. URLs, headers and bodies can hold {{ds:apiBase}} and other references, with a different value per environment. See Reference syntax.

The building blocks#

Collection
The top level of the tree, usually one per API or service. An import always creates one.
Folder
Groups requests inside a collection or another folder. Swagger imports create one folder per tag.
Request
One HTTP call: method, URL, headers, query parameters, body and authorization. Shown with a colored method chip.
Authorization
None, Bearer Token, Basic Auth or Inherit from parent. Collections and folders can hold one for their requests.
Send
Sends the request now, from the SmartestQA server, and shows the response. Nothing is saved.
API step
A step in a test case made from a saved request. It keeps its own copy of the request.
Reference
{{ds:key}}, {{tc:name}} or {{excel:name}}_column inside a request, filled in by the run.

The screen#

API Requests: tree with a collection, folders and requests with method chips; a POST request with JSON body; response 201 Created with time and size; Request settings on the right
API Requests with a request and its response.
AreaWhat it doesMore
API treeNew Request, More (Add Collection, Add Folder, Import Postman, Import Swagger / OpenAPI), search, and a menu on every item.The API library
RequestEditable name, HTTP method, Request URL, Send, Save, Body and Response.Edit and send
Request settingsAuthorization, Params, Header. On narrow screens it folds into a strip of tabs at the right edge.Authorization
FooterCreated by and Updated by with dates.

On screens narrower than 1600 pixels the tree folds into a rail on the left (“Show the tree”). The last selected item and the open folders are remembered for the session.

Who can do what#

TaskUserAdmin
Create, edit, duplicate, move, send and importYesYes
Delete a request or an empty folder or collectionYesYes
Delete a folder or collection that has contentNoYes

The top folder of the tree cannot be deleted. Roles: Roles & permissions.

Before you start#

  • Know where the API runs. Send and Swagger URL imports go out from the SmartestQA server; runs go out from the machine that runs the test. An API on your intranet needs an agent for runs and cannot be tried with Send.
  • Put the base URL in a key. {{ds:apiBase}}/orders with apiBase, apiBase_TEST… in Data Source.
  • Put tokens in encrypted keys. A token typed into a request is visible to everyone who opens it. See Where secrets belong.

Best practices#

Do

  • One collection per API, folders per resource.
  • Name requests by what they do: “Create order”, “Get order by id”.
  • Use {{ds:…}} for base URLs and secrets.
  • Use Bearer Token or an Authorization header for anything you will run in tests.
  • Check the response with Send before you add the request to a test.

Don’t

In this section#

Didn’t find your answer?Write to support with your project name and what you see on screen.

info@smartestqa.ai
© 2026 Selenity Technology · SmartestQAsmartestqa.aiThis page as MarkdownChecked against smarttest-fe predev 2a8c79cc, smarttest-be 633c2a03, smarttest-testsuite (runner), smartest-mcp-server