Skip to documentation
SmartLinks Help Center
Step-by-step product guides Read as Markdown ↗
Free to read. Private to operate. These guides never display account data or keys. Using a feature requires your own account, permissions and applicable plan. YOUR_API_KEY is only a placeholder.

API Explorer, REST and MCP

API Explorer displays the current app API catalog and lets an authorized user prepare or execute requests.

Before you start

Obtain feature access and a key with only the required permissions. Requests can read or change real app data; start with a read-only endpoint.

Step by step: a REST request

  1. Open API Explorer for the intended app.
  2. Select one of that app's keys or enter your own authorized key in the private form.
  3. Select an endpoint group and inspect its HTTP method, path, parameters and description.
  4. Fill required path values using the intended record. Review query parameters and JSON body.
  5. If the selected key covers multiple apps, supply the app selector/header requested by the explorer. Verify the displayed app scope.
  6. Inspect Copy curl before sharing it: copied requests can include your credential. Replace it with YOUR_API_KEY in any public example.
  7. Execute only after understanding the endpoint's effects. Inspect response status and body, then verify the result in the appropriate dashboard/provider.

Step by step: connect an MCP assistant

  1. Open Connect via MCP and choose the configuration for your client.
  2. Review the server URL and authentication settings in the private snippet.
  3. Configure the client in a private local environment with a narrowly scoped credential.
  4. Start with a read-only request against your own test app.
  5. Review the assistant's proposed tool operation before allowing publishing, deletion, price changes or other writes.

Confirm it worked

The request reaches the intended app with the expected permission boundary. A connected MCP client does not imply every tool is safe to run automatically.

Troubleshooting

Check the method, required fields, app scope and response error before retrying. Do not repeatedly replay a write after a timeout without checking whether it already succeeded. Never paste live curl headers or MCP credentials into public support.

Related: API keys, AI Gateway.

Browse all product guides → · SDK installation guides