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
}Search across all training scenarios and knowledge base items using natural language. Returns results ranked by semantic relevance with a 0-100 relevance score. Use this to find existing content before creating new training scenarios.
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
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
2 - 5001 <= x <= 50internal, public custom_training, help_center, integration, website confluence, notion, zendesk_support, shopify, gitbook, intercom, front, freshdesk, ai_instructions, custom_training, website relevance, handoffs Include the full content field in results. Set to false to reduce response size.
Was this page helpful?