Skip to navigation

Domains

View as Markdown

platform.domains

  • Endpoint: /platform/domains | Methods: GET, PATCH, POST
  • Request shape: fields go at the top level of the JSON body, with no resource wrapper. The item’s id goes in the URL for reads and updates, not in the body.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/platform/domainsList domains
POST/platform/domainsCreate domain
GET/platform/domains/{id}Get domain
PATCH/platform/domains/{id}Update domain

Fields

FieldTypeRequiredNotes
idstringread-onlyUnique identifier of the domain, assigned by the server. Cannot be changed.
namestring✅Name of the domain, for example Manufacturing. Must match a Smart Handoff category key (case insensitive) and be unique. Cannot be changed after creation.
descriptionstring✅Description of the domain, used to decide when a request belongs to it. Required.
positive_examplesarray<string>✅Example user requests that belong to this domain and boost its signal. 1 to 500 examples, each up to 250 characters.
negative_examplesarray<string>Example user requests that do not belong to this domain and reduce its signal. Up to 100 examples, each up to 250 characters.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersion✅Document version. On update, send back the num from your last read.

Example create body

{
"name": "example-name",
"description": "What this is for",
"positive_examples": [
"<string>"
],
"negative_examples": [
"<string>"
],
"version": {
"change_description": "Create domain"
}
}