Search the docs
Search the public product docs and return the best-matching sections, each with its title, its docs link and its text. Use it to answer how the platform works (a setting, a channel, a limit, billing, what an error means) instead of guessing, and give the user the link. It reads only the published docs; it knows nothing about this agent's own config, which get_agent returns.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Header Parameters
A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/operations/search_docs" \ -H "Content-Type: application/json" \ -d '{ "query": "string" }'{
"results": [
{
"title": "string",
"url": "string",
"excerpt": "string",
"property1": null,
"property2": null
}
],
"property1": null,
"property2": null
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}Save call view POST
Save a reusable Calls-list preset (columns + filters + sort) so the operator can recall a slice of calls in one click. Use this after the operator describes a recurring view they want ("show me failed booking calls from this week"). Scope it 'workspace' (visible across all agents, the default) or 'agent' (pinned to the current agent). The filters object mirrors the Calls filter bar (search, sentiment, outcome, channel, dateFrom/To, includeTests).
Set channels POST
Declare which channels the agent serves: 'voice' (phone numbers and the website call pill, billed per minute) and/or 'text' (the website chat widget and share link, billed per reply). At least one. Turning 'text' off switches the chat widget off and turning it on switches it on; turning 'voice' off switches the call pill off. Voice settings stay stored on a chat-only agent, hidden in the editor. A chat agent must run on a model priced per reply (validate_agent reports it).