Skip to navigation

Get domain

View as Markdown

Returns one domain by its id.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Path parameters

idstringRequired

The id of the domain, as returned when it was created or listed.

Response

The domain
idstringOptionalRead-only
Unique identifier of the domain, assigned by the server. Cannot be changed.
namestringOptional>=1 character

Name of the domain, for example Manufacturing. Must match a Smart Handoff category key (case insensitive) and be unique. Cannot be changed after creation.

descriptionstringOptional>=1 character
Description of the domain, used to decide when a request belongs to it. Required.
positive_exampleslist of stringsOptional
Example user requests that belong to this domain and boost its signal. 1 to 500 examples, each up to 250 characters.
negative_exampleslist of stringsOptional
Example user requests that do not belong to this domain and reduce its signal. Up to 100 examples, each up to 250 characters.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error