Skip to content

Classify URLs into intent topics

POST
/voice/topics/classify

THIS COSTS CREDITS, per URL. Returns the five most probable topics each.

The same topic vocabulary the intent surface uses, applied to pages you name rather than pages visitors were seen on.

Authorizations

Parameters

Query Parameters

run_async

Defaults TRUE here, matching voice: a batch of URLs is slow enough that a synchronous call usually times out. Poll GET /voice/jobs/{job_id}.

boolean
default: true

Defaults TRUE here, matching voice: a batch of URLs is slow enough that a synchronous call usually times out. Poll GET /voice/jobs/{job_id}.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

The URLs to classify.

object
key
additional properties
any

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string