Interactive playground

Besides this documentation, DocSlice offers an interactive console where you can try every endpoint without writing code: the API playground.

How to use it

  1. Open the API playground. The bar at the top has a Host field (already set to https://api.docslice.app) and a Bearer Key field.
  2. Paste your API key in Bearer Key (only the key, without the word Bearer) and press Authorize Swagger. Create a key in the dashboard if you do not have one yet. Ping /health checks that the service answers.
  3. Pick an endpoint, press Try it out, fill in the fields (for Convert, choose a file and a format) and press Execute.
  4. Read the status code and the answer below the form. The console also shows the equivalent curl command.

Good first tries

  • GET /health to check the service (no key needed).
  • GET /v1/usage to see your quota.
  • POST /v1/convert with a small PDF and format=markdown.

The playground is a quick way to try a call. This reference is the source of truth: it explains every field and shows complete examples in four languages.