curl --request PATCH \
--url https://ndi-api.nace.ai/v1/domains/{domain_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{}'{
"domain": {
"class_count": 123,
"display_name": "<string>",
"domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner": "platform",
"selectable": true,
"slug": "<string>",
"status": "draft",
"taxonomy": {
"allow_other": true,
"classes": [
{
"description": "<string>",
"group": "<string>",
"subgroup": "<string>",
"aliases": [
"<string>"
]
}
]
},
"version": 123,
"parent_slug": "<string>",
"published_at": "2023-11-07T05:31:56Z"
},
"validation": {
"effective_class_count": 123,
"valid": true,
"errors": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}update_domain
Edit a draft, or spin a published version into the next draft. Cost class: fast.
Editing a draft mutates it. Editing a published domain creates version
n+1 and leaves version n untouched. Existing workspaces remain pinned to
the version selected at creation; the new version is available only to future
workspaces.
curl --request PATCH \
--url https://ndi-api.nace.ai/v1/domains/{domain_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{}'{
"domain": {
"class_count": 123,
"display_name": "<string>",
"domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner": "platform",
"selectable": true,
"slug": "<string>",
"status": "draft",
"taxonomy": {
"allow_other": true,
"classes": [
{
"description": "<string>",
"group": "<string>",
"subgroup": "<string>",
"aliases": [
"<string>"
]
}
]
},
"version": 123,
"parent_slug": "<string>",
"published_at": "2023-11-07T05:31:56Z"
},
"validation": {
"effective_class_count": 123,
"valid": true,
"errors": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>"
}
]
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}{
"error": {
"code": "invalid_request",
"detail": null,
"message": "Request body has extra fields that this operation does not accept.",
"request_id": "req-01j9k2n3p4q5r6s7t8v9",
"retryable": false
}
}Authorizations
Path Parameters
Domain version identifier.
Body
Any subset of the create request.
Editing a draft mutates it. Editing a published domain creates
version n+1 as a new draft and leaves version n untouched — there is no
way to change the vocabulary under a live corpus, because a workspace that
could not explain its own folder structure is worse than one with an old
vocabulary.
Response
Successful Response
A domain with its effective taxonomy already resolved.
A caller reading a domain wants the taxonomy that will actually be applied, not a delta they have to merge themselves.
Show child attributes
Show child attributes
Returned on every domain write, so a caller never has to guess whether a publish will succeed.
Show child attributes
Show child attributes