QuantaAPI
Dashboard
Getting started

Quickstart

Create a collection, add an endpoint, shape the response, and call it from your application.

5 min read
cURL, JavaScript, Python

This walkthrough uses the labels you see in the dashboard. Every step after the first two is optional — a new endpoint already works with its defaults.

  1. 01
    Create a collectionOn the dashboard, use the add button in the Collections section of the sidebar. Give it a name; the description is optional.
  2. 02
    Copy the collection keyOpen the collection and copy the key from the API Key card. This is the only credential consumers need.
  3. 03
    Create an endpointClick Create Endpoint. Enter a path such as /users and choose a method — for example POST. The type is REST.
    POST /users
  4. 04
    Set the method and behaviorOpen the Configuration tab. The method must match the one you used when creating the endpoint. Adjust latency and, if you want, error simulation.
    POST · 800 ms latency · 0% errors
  5. 05
    Declare request requirements (optional)Open Data requirement and add the headers and body fields your endpoint expects. Requests that do not comply are rejected with 400.
  6. 06
    Write the responseOpen the Response tab and edit the JSON. Template variables such as {{message}} are replaced on every request.
    {
      "ok": true,
      "message": "{{message}}",
      "user": { "name": "Ada" }
    }
  7. 07
    Send a test requestOpen Test endpoint, fill in the body and headers, and click Send Request. The collection key is attached for you.
  8. 08
    Call it from your applicationUse /endpoints/fetch followed by the endpoint path. Send the collection key as a header and the JSON body as-is.
    curl -X POST https://quanta-api-backend.vercel.app/endpoints/fetch/users \
      -H "Content-Type: application/json" \
      -H "x-collection-api-key: YOUR_COLLECTION_KEY" \
      -d '{"name":"Ada"}'
Defaults on a new endpointA new endpoint starts with POST, 20 ms latency, no simulated errors, the four built-in pool entries, and the response body { "message": "{{message}}", "statusCode": 200 }.

Requests appear in the Usage tab as soon as they complete, including requests sent from the Test endpoint tab.