Topics

Search A.I. trained topics by name

get/topics

Request

Base URL
https://api.signal-ai.com
Auth
OAuth 2
Client credentials
Token URLhttps://api.signal-ai.com/auth/token
Scopesdefault
TypeScript
https://skmtc.dev/signal-ai/apis/signal-ai-api/docs/topics/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

namestring

Any topic whose name contains this search term will match

sizeinteger

privateboolean

Only return topics which are private to your organisation

Response

Returns the list of trained topics matching the search term. If no search term is provided, a list containing all topics accessible to the organisation will be returned.

Example response

{
  "topics": [
    {
      "id": "aaca73a5-f4d6-4e40-85c4-8258d4bc63a8",
      "name": "3D Printing",
      "description": "3D Printing is a manufacturing process that ..."
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.