Make your first API call
The API Reference includes an in-browser request panel. It is intended to make real HTTP requests to the API, not demonstrate a static example.
Use a disposable, scoped test credential and a dedicated, revocable test account. This docs configuration disables persistence of Try-It credentials in local and session storage, so you may need to enter them again on another page. Do not share unredacted network captures or screenshots.
Prerequisites
- Sign in to the APIContext dashboard and obtain an API credential for a nonproduction project, or ask your administrator.
- Send the key in the
Authorizationheader asBearer <your API key>, the same format as Using the APIContext API. The in-browser panel works only with theAuthorizationheader: the API does not accept anX-Api-Keyheader from a browser. - Use only safe, read-only GET operations for the first call.
Step 1: Open the reference page
Open List All API Calls (v2). Its GET request has no mandatory path parameters. To explore v3, open List API Monitors.
Step 2: Authorize
Use the Auth section of the request panel on the right:
- On the v2 and v3 pages (for example, List All API Calls), enter
Bearer <your API key>in the ApiKeyAuth field. - On the complete-reference pages (
/reference/api-full/...), choose OAuth2 and paste your API key as the bearer token. Do not choose ApiKey: it sendsX-Api-Key, which the browser blocks.
Check the generated request before sending: it must show Authorization: Bearer ....
Step 3: Fill in parameters
For the v2 list-calls example, no path parameter is required. On other pages fill in the marked path, query, or header parameters. For example, the curated v3 organization downtimes listing requires an organization ID.
Step 4: Send the request
Click Send API Request in the browser panel. Inspect the HTTP status and response body. The v2 example must send a request to https://client.apimetrics.io/api/2/calls/. A successful list GET usually returns status 200 and response data.
The panel works on docs.apicontext.com only. The API accepts browser requests from that site, so a copy of these docs served from another address (a local build or a preview) gets a network error.
Troubleshooting
| Symptom | Check |
|---|---|
| 401 Unauthorized | Correct security scheme, credential, and Bearer prefix if applicable |
| 403 Forbidden | Account/project permissions |
| 400 or 422 | Missing or malformed required query, path, or header parameter |
| Network error, nothing in the response panel | You chose ApiKey (X-Api-Key) instead of the Authorization header, or the page is not on docs.apicontext.com |
| No send button | Confirm the API Explorer panel loaded and report the exact page to the documentation team |