Skip to main content
POST
/
training
/
search
Semantic search across training and knowledge base
curl --request POST \
  --url https://api.open.cx/training/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "limit": 10,
  "visibility": [
    "internal"
  ],
  "sourceTypes": [
    "custom_training"
  ],
  "dataSources": [
    "confluence"
  ],
  "sortBy": "relevance",
  "include_content": true
}
'
{
  "results": [
    {
      "id": "<string>",
      "title": "<string>",
      "visibility": "internal",
      "source_type": "custom_training",
      "source_url": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "data_source": "confluence",
      "stream": "<string>",
      "relevance_score": 50,
      "directory_id": "<string>",
      "directory_name": "<string>",
      "usage_count": 0,
      "content_preview": "<string>",
      "content": "<string>",
      "is_draft": true
    }
  ],
  "total_count": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.open.cx/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
query
string
required
Required string length: 2 - 500
​
limit
number
default:10
Required range: 1 <= x <= 50
​
visibility
enum<string>[]
Available options:
internal,
public
​
sourceTypes
enum<string>[]
Available options:
custom_training,
help_center,
integration,
website
​
dataSources
enum<string>[]
Available options:
confluence,
notion,
zendesk_support,
shopify,
gitbook,
intercom,
front,
freshdesk,
ai_instructions,
custom_training,
website
​
sortBy
enum<string>
default:relevance
Available options:
relevance,
handoffs
​
include_content
boolean
default:true

Include the full content field in results. Set to false to reduce response size.

Response

Default Response

​
results
object[]
required
​
total_count
number
required