Overview
The setup diagnostics endpoint verifies that your Trix API configuration is working correctly. It checks API connectivity, authentication, and optionally runs a full round-trip test that stores, searches, and deletes a test memory.
Run this after initial setup or when debugging connectivity issues. The round-trip test confirms that store, search, and delete all work end-to-end.
What It Checks
- API connectivity — can the client reach the Trix API
- Authentication — is the API key valid and authorized
- Space access — can the key access the configured space
- Round-trip test (optional) — stores a test memory, searches for it, then deletes it to confirm the full pipeline works
API Endpoint
Request
POST /v1/system/check-setup
{
"round_trip": true
}SDK Examples
import { Trix } from '@trixdb/client';
const trix = new Trix({ apiKey: process.env.TRIX_API_KEY });
// Verify connectivity by listing spaces
const spaces = await trix.spaces.list();
console.log(`Connected. Spaces: ${spaces.data.length}`);
// For a full setup check, use the CLI or REST API:
// trix check-setup --round-trip
// curl -H "Authorization: Bearer $TRIX_API_KEY" \
// https://api.trixdb.com/v1/check-setup?roundTrip=trueTroubleshooting
If a check fails, the response includes an error message with details:
- API connectivity failed — check your network connection and
that
TRIX_API_URLis correct - Authentication failed — verify your API key is valid and not expired
- Space access failed — ensure the API key has access to the configured space