- Docs
- Resources
- API Requests
- FAQ, MCP & limits
FAQ, MCP & limits
Answers to common questions about API Requests, how AI assistants work with the API library, and its limits.
In short
On this page you can
- Find quick answers about internal APIs, environments, tokens and methods.
- Let an AI assistant build the API library without handling secrets.
- Check the limits and timeouts of requests.
How to use it
- Filter the questions by your role with the chips.
- Open a question; follow its link for the full procedure.
- For AI work, connect an assistant and try the example prompts.
- Keep the limits table in mind when you design API steps.
Questions and answers#
Our API is only reachable inside our network. Can we test it?Customers
Yes, in runs on an agent or self-hosted runner inside the network. Send on the API Requests page and Swagger URL imports go out from the SmartestQA server and cannot reach it; import the spec as a file and check requests with a Dry Run on the agent. See Where connections are opened from.
How do I call the TEST API in TEST runs and the DEV API in DEV runs?Customers
Start the URL with a key: {{ds:apiBase}}/orders. Create apiBase and apiBase_TEST (and apiBase_PRP if needed). Runs pick the variant for their environment; Send uses the default. See Environment-specific keys.
Where do I put the API token?Customers
In an encrypted key, for example apiToken, and in the request as Bearer Token {{ds:apiToken}}. If the token comes from a login call in the same test, extract it there and use {{tc:accessToken}}. See Authorization in runs.
Can I use Basic Auth in tests?Customers
Not through Basic Auth: a run applies only Bearer Token. Add the header Authorization: Basic {{ds:apiBasicAuth}} instead, with the Base64 of user:password in an encrypted key.
I fixed a request in the library. Do my tests use the fix?Customers
No. Each step keeps its own copy. Edit the step’s request, or add the request again. See Each step keeps its own copy.
Which HTTP methods work?Customers
You can save GET, POST, PUT, DELETE, PATCH, HEAD and OPTIONS. Runs send GET, POST, PUT, PATCH and DELETE. Send on this page sends POST, PUT and DELETE as such and everything else as GET.
Do we still need Postman?Customers
For exploring an API, Postman remains handy. For automated checks, import the collection once and use the requests as steps next to UI steps, with shared test data, environments and reports. See Import a Postman collection.
Can I test SOAP or XML APIs?Customers
You can store and send XML bodies from this page. In a run, request bodies are sent as JSON, so check an XML request with a Dry Run before you rely on it. See Bodies in runs.
Who can delete requests and folders?Admins
Every project member can delete a single request or an empty folder or collection. A folder or collection with content needs an Admin. Steps made from deleted requests keep working.
Are tokens in saved requests visible to others?Admins
Yes. Tokens and Basic passwords are stored encrypted, but everyone who opens the request sees them in the Authorization fields. Use {{ds:…}} references to encrypted keys. See Where secrets belong.
For AI assistants (MCP)#
An assistant connected through the SmartestQA MCP server uses smartest_api_library to add a request to the library or change one by id: name, url, method (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS), headers, queryParams, body, formData, authType, token, username, password, and an optional library folder. Tokens and passwords must be {{ds:key}} or {{tc:…}} references; a literal secret is refused and nothing is saved. Scenarios then copy a library request into an API step. Connect an assistant from Device FarmTest AgentsConnect to Claude; more in Discover › MCP.
Read our OpenAPI file at ./api/openapi.yaml and add the order endpoints to the API library of project "Web Shop", folder Orders. Use {{ds:apiBase}} as the host and {{ds:apiToken}} as Bearer token.
Write a scenario that creates an order through the API, opens it in the web app and checks the total.
Add a GET request "Health check" to the API library of project "Web Shop": {{ds:apiBase}}/health, no authorization.Limits#
| Item | Limit |
|---|---|
| URL | 2,048 characters |
| Basic Auth user name / password | 255 / 128 characters |
| Send and run time limit per request | 30 seconds |
| Methods in runs | GET, POST, PUT, PATCH, DELETE |
| Methods sent as such by Send | POST, PUT, DELETE (others as GET) |
| Authorization applied in runs | Bearer Token |
| Import formats | Postman collection JSON; Swagger / OpenAPI JSON or YAML (file) or JSON (URL); curl |
| Sharing between projects | Not available |
Didn’t find your answer?Write to support with your project name and what you see on screen.
info@smartestqa.ai