Create domain
Creates a domain and returns it with its server-assigned id and version.
Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required.
Authentication
AuthorizationBearer
JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.
Request
This endpoint expects an object.
name
Name of the domain, for example Manufacturing. Must match a Smart Handoff category key (case insensitive) and be unique. Cannot be changed after creation.
description
Description of the domain, used to decide when a request belongs to it. Required.
positive_examples
Example user requests that belong to this domain and boost its signal. 1 to 500 examples, each up to 250 characters.
version
Document version. On update, send back the num from your last read.
negative_examples
Example user requests that do not belong to this domain and reduce its signal. Up to 100 examples, each up to 250 characters.
Response
The created domain
id
Unique identifier of the domain, assigned by the server. Cannot be changed.
name
Name of the domain, for example Manufacturing. Must match a Smart Handoff category key (case insensitive) and be unique. Cannot be changed after creation.
description
Description of the domain, used to decide when a request belongs to it. Required.
positive_examples
Example user requests that belong to this domain and boost its signal. 1 to 500 examples, each up to 250 characters.
negative_examples
Example user requests that do not belong to this domain and reduce its signal. Up to 100 examples, each up to 250 characters.
updated_time
When the configuration was last updated.
updated_by
Who last updated the configuration.
version
Document version. On update, send back the num from your last read.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error