Try it and mock
/workspace
PlanPathspaths
Try it opens from an operation's quick actions, a class's quick actions, or the lens toolbar's Mock & preview button. The console is titled Try it · METHOD path.
The request
| Field | What it does |
|---|---|
| Server / Send to | A server from the document root. Relative and templated server URLs are listed but cannot be chosen |
| Mock behaviour, Scenario, Response status | What the hosted mock should answer |
| Auth | Username and password, or an API key |
| Extra headers | + header |
| Body | Media type, and Prefill from an example |
| Copy as | The request in another form |
Before you send: "Nothing sent yet. Fill the request above and press Send — the status, timing and size shown here are all measured, never estimated." Requests leave through the studio's relay, which guards against requests to private addresses.
For a class, Try it shows a Sample payload and the Operations that carry it.
The hosted mock
A published version can answer from Apiome's hosted mock. The console checks the preconditions and says which one is missing:
- "Mock is off for this version — turn on its hosted mock in the Control Panel's versions table."
- "Publish this version to use its hosted mock — the hosted mock serves published revisions."
- "No mock host is configured for this deployment…" — the operator sets
APIOME_MOCK_PUBLIC_BASE_URL.
A draft version gets a synthesized preview instead of a live mock. The mock itself — scenarios, correlation, fixtures, capture — is documented in the Apiome mock runtime reference and Mock and try out.
The code layer's status bar carries a mock chip that probes the mock's health once a minute.
Slate's Try it live
The Slate preview has its own Try it live console on endpoint pages. It issues a real request from the browser to the API base URL — nothing is mocked or proxied — and is a different tool from the workspace console.