Search topics

Search knowledge topics by title or entry content.

GET /v0/topics/search

Search topics

cURL

curl --request GET \
  --url https://api.tryarchitect.com/v0/topics/search \
  --header 'x-api-key: <api-key>'

200

{
  "hasMore": true,
  "items": [
    {
      "topicId": "<string>",
      "title": "<string>",
      "purpose": "<string>",
      "sortOrder": 123,
      "isDefault": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "entries": [
        {
          "topicEntryId": "<string>",
          "topicId": "<string>",
          "sortOrder": 123,
          "content": {
            "type": "<string>",
            "content": "<string>"
          },
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "nextCursor": "<string>",
  "totalCount": 4503599627370495
}

Authorizations

x-api-key · string · header · required

API key authentication for the External Actor Gateway

Query Parameters

cursor · string

cursor parameter

limit · number

limit parameter

query · string

query parameter

Response

200

application/json

Successful operation

hasMore · boolean · required

items · object[] · required

Show child attributes

nextCursor · string | null · required

totalCount · integer · required

Required range: 0 <= x <= 9007199254740991