Documentation
API client
The API client lets you craft and send requests to any API — set the method, URL, headers, auth, and body, then inspect the response.
Create an HTTP kit
- From the sidebar: hover over a collection or folder, click ... and select Add API Request.
- From the tab bar: click the v icon and select Add API Request.
Request config
- Method: GET, POST, PUT, PATCH, DELETE. Use Custom method for other types.
- URL: The request URL. You can paste a cURL command here; the method, URL, headers, and body are parsed automatically.
- Param: Request query parameters (
?key=value). - Header: Request headers.
- Auth: Authentication settings.
| Type | Description |
|---|---|
| None | No auth header added |
| Basic | Encodes username and password as Authorization: Basic ... |
| Bearer Token | Adds Authorization: Bearer <token> |
| Inherit from collection | Uses auth defined at the collection level |
- Body: Request payload format.
| Type | Usage |
|---|---|
| none | No body |
| raw | JSON, XML, HTML, or plain text |
| form-data | Multipart form submissions (files: desktop only) |
| x-www-form-urlencoded | HTML form submissions |
| binary | Send a raw file (desktop only) |
You can use variable syntax {{variableName}} in the URL, headers, query parameters, auth fields, and inside the request body.
Sending the request
Click Send or press Ctrl+Enter / Cmd+Enter. Click Cancel to abort an active request.
Inspecting the response
The response panel displays the status code, round-trip time, and the response body.
The response body uses an integrated data inspector:
- Click any JSON key to copy its JSONPath.
- Enter a JSONPath expression in the query input on the right to filter the view.
- Click ... next to a value and select Extract to variable to save it.
- Search by JSON key or value.
- Use the format tool to beautify the output.