Skip to Content
API ReferenceResourcesTopics

Topics API Documentation

The Topics API is designed to retrieve all available topic resources for a specific client.

API Overview

Endpoint URL

https://api.crediblemind.com/[client]/resources/topics

Method

GET

Authentication

Requests to the Topics API require a valid API key provided in the request header:

Ask your client success representative for your API key
GET /[client]/resources/topics HTTP/1.1
Host: api.crediblemind.com
x-api-key: YOUR_API_KEY

Request Parameters

Path Parameters

  • [client]: A unique identifier for each CredibleMind client.

Example Request

curl -X GET "https://api.crediblemind.com/benovo/resources/topics" \
 -H "x-api-key: YOUR_API_KEY"

Response Format

The response will be in JSON format, structured as follows:

{
  "numResults": 5,
  "results": [
    {
      "title": "Anxiety",
      "path": "topics/anxiety",
      "description": "About anxiety",
      "imageUrl": "https://placehold.co/600x400"
    },
    {
      "title": "Anxiety in Teens",
      "path": "topics/anxiety-in-teens",
      "description": "About anxiety in teens",
      "imageUrl": "https://placehold.co/600x400"
    }
  ]
}

Response Definitions

  • numResults (int): The total number of results.
  • results (array): An array of all results. Each entry contains:
    • title (string): The result name or title.
    • path (string): A URL path for the result, to be programmatically appended to the CredibleMind content source URL.
    • description (string): A brief description of the topic.
    • imageUrl (string): The URL of an image associated with the topic.

Success Response

  • Code: 200 OK
  • Content:
{
  "numResults": 5,
  "results": [
    {
      "title": "keyword1",
      "path": "/topics/keyword1",
      "description": "About keyword1",
      "imageUrl": "https://placehold.co/600x400"
    },
    {
      "title": "keyword2",
      "path": "/topics/keyword2",
      "description": "About keyword1",
      "imageUrl": "https://placehold.co/600x400"
    }
  ]
}

Error Response

  • Code: 401 Unauthorized
  • Content:
{
  "error": "Invalid API Key"
}
Last updated on
ListsResource Details