You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit abbfca5
Browse filesBrowse the repository at this point in the historyBrowse files
Address review feedback on Knowledge endpoint docs
Narrow the tag applied_at/applied_by null case to content removals, say that
the detach admin_id is checked but not recorded, document the missing internal
article errors, add the content search 401 scope example, note values returned
as strings, and add request_id and per_page to a few examples.
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Requires the `read_articles_scope` or `read_write_articles_scope` OAuth scope.
5737
5737
responses:
5738
5738
'200':
5739
-
description: successful
5739
+
description: successful. `pages.page` and `pages.per_page` are returned as strings when you send `page` and `per_page` in the request, and as integers otherwise.
5740
5740
content:
5741
5741
application/json:
5742
5742
examples:
@@ -5817,7 +5817,26 @@ paths:
5817
5817
schema:
5818
5818
"$ref": "#/components/schemas/internal_article"
5819
5819
'400':
5820
-
description: Bad request. The request body is empty.
5820
+
description: Bad request. The request body is empty, in which case the response has no body, or `audience_ids` is not an array of integers
5821
+
content:
5822
+
application/json:
5823
+
examples:
5824
+
audience_ids is not an array:
5825
+
value:
5826
+
type: error.list
5827
+
request_id: null
5828
+
errors:
5829
+
- code: data_invalid
5830
+
message: audience_ids must be an array
5831
+
audience_ids contains a non-integer:
5832
+
value:
5833
+
type: error.list
5834
+
request_id: null
5835
+
errors:
5836
+
- code: data_invalid
5837
+
message: audience_ids must contain only integer values
5838
+
schema:
5839
+
"$ref": "#/components/schemas/error"
5821
5840
'404':
5822
5841
description: Teammate, folder or audience ID not found
5823
5842
content:
@@ -5847,7 +5866,7 @@ paths:
5847
5866
schema:
5848
5867
"$ref": "#/components/schemas/error"
5849
5868
'422':
5850
-
description: Missing required parameters, or body_markdown sent with body or json_blocks
5869
+
description: Missing required parameters, body_markdown sent with body or json_blocks, or an ai_*_availability value that is not a boolean
5851
5870
content:
5852
5871
application/json:
5853
5872
examples:
@@ -5865,6 +5884,13 @@ paths:
5865
5884
errors:
5866
5885
- code: parameter_invalid
5867
5886
message: body_markdown is mutually exclusive with body and json_blocks - please provide only one
5887
+
Non-boolean availability flag:
5888
+
value:
5889
+
type: error.list
5890
+
request_id: null
5891
+
errors:
5892
+
- code: parameter_invalid
5893
+
message: ai_chatbot_availability must be a boolean (true or false)
5868
5894
schema:
5869
5895
"$ref": "#/components/schemas/error"
5870
5896
'401':
@@ -6042,9 +6068,28 @@ paths:
6042
6068
schema:
6043
6069
"$ref": "#/components/schemas/internal_article"
6044
6070
'400':
6045
-
description: Bad request. The request body is empty.
6071
+
description: Bad request. The request body is empty, in which case the response has no body, or `audience_ids` is not an array of integers
6072
+
content:
6073
+
application/json:
6074
+
examples:
6075
+
audience_ids is not an array:
6076
+
value:
6077
+
type: error.list
6078
+
request_id: null
6079
+
errors:
6080
+
- code: data_invalid
6081
+
message: audience_ids must be an array
6082
+
audience_ids contains a non-integer:
6083
+
value:
6084
+
type: error.list
6085
+
request_id: null
6086
+
errors:
6087
+
- code: data_invalid
6088
+
message: audience_ids must contain only integer values
6089
+
schema:
6090
+
"$ref": "#/components/schemas/error"
6046
6091
'404':
6047
-
description: Internal article, folder or audience ID not found
6092
+
description: Internal article, teammate, folder or audience ID not found
6048
6093
content:
6049
6094
application/json:
6050
6095
examples:
@@ -6055,6 +6100,13 @@ paths:
6055
6100
errors:
6056
6101
- code: not_found
6057
6102
message: Resource not found
6103
+
Teammate not found:
6104
+
value:
6105
+
type: error.list
6106
+
request_id: null
6107
+
errors:
6108
+
- code: parameter_invalid
6109
+
message: Admin with ID 999999 not found
6058
6110
Folder not found:
6059
6111
value:
6060
6112
type: error.list
@@ -6072,7 +6124,7 @@ paths:
6072
6124
schema:
6073
6125
"$ref": "#/components/schemas/error"
6074
6126
'422':
6075
-
description: body_markdown sent with body or json_blocks, or the article is in a release running a live experiment
6127
+
description: body_markdown sent with body or json_blocks, an ai_*_availability value that is not a boolean, or the article is in a release running a live experiment
6076
6128
content:
6077
6129
application/json:
6078
6130
examples:
@@ -6083,6 +6135,13 @@ paths:
6083
6135
errors:
6084
6136
- code: parameter_invalid
6085
6137
message: body_markdown is mutually exclusive with body and json_blocks - please provide only one
6138
+
Non-boolean availability flag:
6139
+
value:
6140
+
type: error.list
6141
+
request_id: null
6142
+
errors:
6143
+
- code: parameter_invalid
6144
+
message: ai_chatbot_availability must be a boolean (true or false)
6086
6145
Release live experiment conflict:
6087
6146
value:
6088
6147
type: error.list
@@ -6350,8 +6409,9 @@ paths:
6350
6409
- name: admin_id
6351
6410
in: query
6352
6411
required: false
6353
-
description: Optional id of the teammate to attribute the removal to. Defaults
6354
-
to the authenticating teammate.
6412
+
description: Optional id of a teammate. The id is checked, and an unknown
6413
+
teammate returns a 404 `admin_not_found` error, but the removal is not
6414
+
recorded against the teammate.
6355
6415
example: '1234'
6356
6416
schema:
6357
6417
type: string
@@ -6567,7 +6627,7 @@ paths:
6567
6627
Requires the `read_articles_scope` or `read_write_articles_scope` OAuth scope.
6568
6628
responses:
6569
6629
'200':
6570
-
description: successful
6630
+
description: successful. `pages.page` and `pages.per_page` are returned as strings when you send `page` and `per_page` in the request, and as integers otherwise.
6571
6631
content:
6572
6632
application/json:
6573
6633
example:
@@ -14428,7 +14488,26 @@ paths:
14428
14488
schema:
14429
14489
"$ref": "#/components/schemas/error"
14430
14490
'401':
14431
-
$ref: "#/components/responses/Unauthorized"
14491
+
description: Unauthorized. The token is invalid or is missing the `read_content` OAuth scope
14492
+
content:
14493
+
application/json:
14494
+
examples:
14495
+
Unauthorized:
14496
+
value:
14497
+
type: error.list
14498
+
request_id: 12a938a3-314e-4939-b773-5cd45738bd21
14499
+
errors:
14500
+
- code: unauthorized
14501
+
message: Access Token Invalid
14502
+
Token lacks required scope:
14503
+
value:
14504
+
type: error.list
14505
+
request_id: a3e5b8e2-1234-5678-9abc-def012345678
14506
+
errors:
14507
+
- code: token_unauthorized
14508
+
message: Not authorized to access resource
14509
+
schema:
14510
+
"$ref": "#/components/schemas/error"
14432
14511
'422':
14433
14512
description: Invalid filter value
14434
14513
content:
@@ -14601,12 +14680,14 @@ paths:
14601
14680
Invalid availability flag:
14602
14681
value:
14603
14682
type: error.list
14683
+
request_id: 7c1d9e2a-3b4f-4a56-8d70-1e2f3a4b5c6d
14604
14684
errors:
14605
14685
- code: parameter_invalid
14606
14686
message: ai_chatbot_availability must be a boolean
0 commit comments