Skip to main content

API Testing

The API Testing page lets you send a live request to the Custodian Labs API directly from your browser — no terminal or external tools needed.

Access the tester

  1. Log in and go to your dashboard.
  2. Click API Testing in the sidebar.

How to run a test

  1. Select your API key from the dropdown (populated from your active keys).
  2. Enter an endpoint URL — the default from your plan is pre-filled.
  3. Click Send Request.
  4. The response is shown below — including status code, response body, and any error details.

What it tests

The tester sends a request to the Custodian Labs API using your selected key in the Authorization: Bearer header. This confirms:

  • Your key is valid and active.
  • You have sufficient character credits.
  • The API endpoint is reachable.

Understanding the response

ResponseMeaning
200 OK with a resultEverything is working correctly
401 UnauthorizedKey is invalid or not being sent correctly
403 character_limit_reachedYour credits are exhausted
403 expiredYour key has expired — renew your subscription
500 Server ErrorSomething went wrong on the API side

Using the tester for development

The API tester is a quick way to verify your key works before wiring it into your project. If the test succeeds here, the same key will work in your application using the same Authorization: Bearer header.

tip

Credits are consumed by test requests just like production requests. Use short test strings to minimize credit usage during development.