REST API v1
Knowledge
Base URL https://your-site.com/wp-json/cliedesk-api/v1. See the overview for keys, scopes and errors.
Search articles (keyword; mode=semantic searches by meaning with Pro AI)
GET /articles/search
Scope articles:read · Cost 5
Parameters
| Name | Type | Description |
|---|---|---|
q required | query · string | |
audience | query · string | One of: agent, customer |
lang | query · string | |
mode | query · string | keyword (default) or semantic. Semantic search needs Cliedesk Pro with AI on; without it the answer is 409 MODE_UNAVAILABLE. One of: keyword, semantic |
Get an article
GET /articles/{id}
Scope articles:read · Cost 1
Parameters
| Name | Type | Description |
|---|---|---|
id required | path · integer | |
lang | query · string |