Skip to content

Deprecate Authored Knowledge

POST
/knowledge/authored/{concept_id}/deprecate

Retire a concept so the brain stops answering from it.

The record and its history survive - this removes it from retrieval, it does not delete it. reason is required and is kept on the record, which is the point: a retired concept with no stated reason is indistinguishable from one retired by mistake. Name superseded_by when something replaces it.

Spends nothing.

Authorizations

Parameters

Path Parameters

concept_id
required

Concept id.

string
>= 1 characters <= 255 characters

Concept id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Retire a concept. reason is required and is kept on the record.

object
reason
required
string
>= 1 characters <= 2000 characters
superseded_by
Any of:
string
<= 255 characters

Responses

200

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

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