Reference

API Reference

Every route the app uses internally, grouped by resource. All routes are relative to the app's origin, accept and return JSON, and require no authentication.

Base URL

In the preview, that's https://preview.devx-ai.xyz. Locally it's whatever host your dev server runs on (typically http://localhost:3000).

Resources

ResourceCovers
DatasetsGolden test case collections.
EvaluationsRuns, comparisons, and the real scoring engine.
TracesLogged LLM calls with spans and metadata.
PromptsVersioned prompt templates.
AnnotationsHuman ratings on traces and results.
AlertsThreshold rules and triggered events.
PlaygroundInteractive prompt runs.

Conventions

  • Successful reads return 200 with the resource wrapped in a named key, e.g. { "dataset": {...} }.
  • Successful creates return 201 with the created resource.
  • Nothing is ever paginated — every list route returns the full collection, since datasets are small and mock.
  • Dynamic segments (:datasetId, :runId, etc.) are the resource's id field.

Errors

Errors return a JSON body with a single error string and an appropriate status code:

StatusMeaningExample cause
400Bad requestMissing a required field, or an empty dataset.
404Not foundThe id in the URL doesn't match any resource.
500Server errorUnexpected failure — check server logs.
{ "error": "Dataset not found" }
No auth, no rate limits
This is a demo workspace over an in-memory store — there's no API key, no session, and no throttling. See About for what that means for persistence.

Try it now

New to the API? Start with the Quickstart, which walks through triggering a real evaluation run with a single curl command.