API Access

Query the database directly

The hosted site exposes read-only JSON endpoints alongside the visual interface. Use structured filters when you want predictable programmatic access, or send a natural-language prompt when you want the site to translate a question into database filters for you.

Endpoints

GET /api/items searches items by text, type, mechanism, technique, family, maturity, status, and validation flags.

GET /api/items/[slug] returns one full item record with citations, validations, and score rollups.

GET /api/workflows searches workflow templates by text and workflow family.

POST /api/query accepts either structured filters or a prompt and returns matching items and workflows.

How It Works

Structured mode is best for apps, scripts, and dashboards that need predictable filters and stable payloads.

Prompt mode is best when you want to ask a direct question in plain language and let the service translate it into the available database filters.

Both modes use the same evidence-first data model surfaced in the UI, including citations, validation context, and workflow metadata.

Authentication And Limits

The server uses its own upstream provider key to interpret prompt queries. End users do not need that provider key.

If the hosted deployment sets TOOL_DB_QUERY_CLIENT_API_KEY, clients should send x-api-key or Authorization: Bearer ... with requests to /api/query.

That prompt endpoint can also be rate-limited to protect the lower-cost public LLM key. When the limit is exceeded, the service returns 429 plus Retry-After and X-RateLimit-* headers.

If no dedicated prompt-query LLM key is configured, /api/query falls back to plain text search over items and workflows instead of failing.

Structured Query Example

Add x-api-key: YOUR_SITE_KEY only if this deployment requires a client key.

curl -X POST https://your-host/api/query \
  -H "Content-Type: application/json" \
  -d '{
    "item_filters": {
      "mechanism": ["photocleavage"],
      "has_mouse_in_vivo_validation": true,
      "limit": 5
    }
  }'

Prompt Query Example

Add x-api-key: YOUR_SITE_KEY only if this deployment requires a client key.

curl -X POST https://your-host/api/query \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Which tools have mouse validation and independent replication?"
  }'

Explore the dataset visually in the collection browser and review DBTL templates in workflow views.