Try an API endpoint in your browser
The APIContext reference docs include a Try-It console that lets you make real API requests directly from your browser. This guide walks you through authenticating and sending your first request.
Never use a production API key in the Try-It console. Create a separate API key with minimal scope for testing. The key is sent directly from your browser to the API origin (client.apimetrics.io) — it is not sent to or stored by the docs site, but it does appear in your browser's network traffic. Revoke the key when you are done testing.
Prerequisites
- An APIContext account with API access
- A test API key (see Authentication settings to create one)
- CORS must be enabled on
client.apimetrics.iofor the docs origin — this is a platform configuration, not a docs configuration. If requests fail with a CORS error, contact your APIContext account manager.
Step 1: Open the reference page
Navigate to any operation in the API Reference. Each operation page has a Try It panel on the right side.
Step 2: Authorize
- Click the Authorize button (lock icon) at the top of any reference page.
- In the dialog, paste your test API key into the
ApiKeyAuthfield. - Click Authorize, then Close.
Your credentials are stored in browser memory for the current session only — they are cleared when you close the tab or navigate away.
Step 3: Fill in parameters
In the Try-It panel:
- Select the operation you want to test.
- Fill in any required path or query parameters shown in the panel.
- For POST/PUT operations, provide a request body in the Body section.
Step 4: Send the request
Click Send. The panel displays:
- The full request URL and headers (with your Authorization header — confirm it shows
Bearer <your-key>) - The HTTP response status code
- The response body
A 200 or 201 response means the call succeeded. A 401 means the key was not accepted. A 403 means the key does not have permission for that operation.
Troubleshooting
| Symptom | Likely cause | Fix |
|---|---|---|
| Request blocked by browser (CORS error) | API server not whitelisting docs.apicontext.com | Contact your account manager to enable CORS for the docs origin |
| 401 Unauthorized | Wrong or expired key | Paste a fresh key via Authorize |
| 403 Forbidden | Key lacks required scope | Create a key with the correct permissions |
| Parameters ignored | Required fields left blank | Check that all required parameters (marked *) are filled |
See also
- Authentication settings — creating and managing API keys
- API Reference — all available operations
- REST API pagination — how to page through list responses