API Overview

Base URLs, authentication and error handling for the CredibleMind REST API.

The CredibleMind API returns CredibleMind content (topics, resource lists, search results) as JSON so you can build your own UI and link users to the full experience on your CredibleMind site or embedded component.

Base URLs

EnvironmentBase URL
Productionhttps://api.crediblemind.com
Developmenthttps://api-dev.crediblemind.com

All endpoints use GET and return JSON.

Authentication

Send your API key in the x-api-key header on every request. Your client success representative provides your key and your client identifier (for example acme). The key is tied to that identifier:

  • Endpoints with the client in the path (/{client}/...) check the key for that client.
  • Endpoints with a brand query parameter check the key for the part of brand before the first -. For brand=acme-east, the key for acme is used.
curl "https://api.crediblemind.com/acme/topics/count" \
  -H "x-api-key: YOUR_API_KEY"

A missing or wrong key returns 401:

{ "error": "Invalid API Client or Key" }

Call the API from your server

The API does not allow the x-api-key header in cross-origin browser requests, so calls made directly from a web page fail. Call it from your backend and keep your API key out of client-side code.

Paths in responses

Most results include a path such as /topics/anxiety. Build a link to the resource by appending it to your CredibleMind site, for example https://acme.crediblemind.com/topics/anxiety, or pass it as the page to open in an embedded component.

Errors

Error bodies are not uniform yet. Check the HTTP status first, then read the body. Each endpoint page lists the exact bodies it returns. There are three shapes:

  • error string: authentication failures and most endpoint errors.
  • Validation envelope: invalid path parameters on Resource Details.
  • message string: unknown routes (404) and unexpected server errors (500).
{ "error": "brand parameter is required" }

Empty results

If your API key is valid but your client identifier does not match a configured CredibleMind client, most endpoints return 200 with empty results instead of an error. If you always get empty results, confirm your client identifier with your client success representative.

Endpoints

On this page