Paste a link and get a tested API

Paste the address of an OpenAPI document, an API address or a cURL command: {{brand}} sends the safe reads, writes checks from each answer and saves it all as a suite. Before you sign up, try it on the sandbox.

In short

Test this API takes an OpenAPI address, an API address or a cURL command, sends only the safe reads, and suggests checks from each answer. "Save as a suite" keeps the requests, the checks and a suite to run again. Before you sign up, you can try it on a sandbox API.

Before you start

• Who: anyone can test the sandbox API without an account. For your own API, sign in first.
• Plan: Every request {{brand}} sends for you counts toward your plan's request allowance (see /help/settings/plan-limits).
• First: have the OpenAPI address, the API address or the cURL command ready.

Steps

1. Paste into the search box (Ctrl+K). Choose "Test the API this address describes" for an OpenAPI document, "Test this address" for another address, or "Test this cURL command". In a project you can also open the chevron beside "New request" and choose "Test an API from its address…".
2. Read each row as it arrives: "Works" or "Broken", the status, the time and how many checks its answer suggests.
3. Choose "Save as a suite".
4. Choose "Open the project".

Result: a request for every operation found, the suggested checks on the requests that answered, and a suite of exactly those.

What is sent, and what is not

• For an OpenAPI document, {{brand}} sends only the reads that need nothing from you: GET and HEAD operations with no required value and no sign-in. It sends at most ten, five at a time.
• "Ready to run" lists everything else. It never sends these for you: operations that need a value, operations that change data, and reads past the first ten.
• A single address or cURL command that is a read goes out once. Anything else waits until you choose "Send it".
• Each request counts as one request of your plan, and goes through the same checks of where requests may go.

Try it before you sign up

On the {{brand}} front page, choose "Test this API": {{brand}} sends the reads of the built-in sandbox bookstore right there, and each answer gets its checks. It stores nothing and uses no AI. Without an account you can test only the sandbox. The browser tab keeps an address of your own that you paste, and right after you create a free account or sign in, Test this API opens with it and tests it. The tab never keeps a cURL command, because it may hold a password or a token.

Good to know

• Running the saved suite never sends an operation that the list only showed.
• Started from the search box, it makes a new project named after the API; started in a project, it saves into that project.
• An OpenAPI document can be JSON or YAML.
• What happens next: "Save as a suite" makes a project with a request for each operation found and a suite. Nothing is saved before you choose it.

If something goes wrong

• A row is "Broken": the operation answered with an error or did not answer. Open it to see the status.
• "That address can't be fetched": it points at a network the server may not reach, such as localhost. Download the document and import the file.
• Nothing is sent for most operations: they need a value or change data. Fill them in and send them yourself.

Related

• /help/api-testing/har-and-openapi-imports
• /help/api-testing/test-suites
• /help/api-testing/start-here