Debugging / Start here

Debug Toolkit

Pick the symptom you are seeing and get the one instrument that answers it. Everything here is available on a normal response — no extra setup.

Router

Start from the symptom

Use this

The response body and status code

Read the status first, then the detail in the body. Keep the X-Request-ID from the response headers — it identifies that exact request in a support ticket.

Common Errors →

Always available

The instruments you always have

X-Request-ID: Returned on every response. If you send your own, it is echoed back, so your logs and a support ticket can reference the same request.
X-Trace-ID: Returned on every response. Send your existing trace id and it is reused, which links your traces to the request.
Status and body: The status code plus the detail in the body describe what went wrong without needing extra tooling.
GET /health: Unauthenticated platform status, rate limited per IP, suitable for your own dashboards.
Dashboard logs: API request history and the audit trail for actions taken on your organization.

# capture the identifiers your support ticket will need
curl --include --request POST https://api.memorysync.io/memory/query \
  --header "X-API-Key: $MEMORYSYNC_API_KEY" \
  --header "X-End-User-ID: user_42" \
  --header "Content-Type: application/json" \
  --data '{"query":"test","k":1}' | grep -i -E "x-request-id|x-trace-id"

Was this page helpful?

← Previous

Incident Response

Common Errors