List an article's retrieval chunks
curl --request GET \
--url https://api.awardee.com/v1/articles/{id}/chunks \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.awardee.com/v1/articles/{id}/chunks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.awardee.com/v1/articles/{id}/chunks"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"article_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "<string>",
"indexing_status": "<string>",
"indexed_at": "<string>",
"in_sync": true,
"chunk_count": 0,
"chunks": [
{
"index": 0,
"text": "<string>",
"char_count": 0,
"char_start": 0,
"char_end": 0,
"overlap_chars": 0,
"section_heading": "<string>",
"section_path": "<string>",
"section_anchor": "<string>"
}
]
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}Endpoints
List an article's retrieval chunks
The chunks stored for one language of the article — the pieces the chatbot’s search retrieves. in_sync is false when the article changed since they were stored; section_path, overlap_chars and the character range are then null on chunks that changed.
GET
/
articles
/
{id}
/
chunks
List an article's retrieval chunks
curl --request GET \
--url https://api.awardee.com/v1/articles/{id}/chunks \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.awardee.com/v1/articles/{id}/chunks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.awardee.com/v1/articles/{id}/chunks"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"article_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "<string>",
"indexing_status": "<string>",
"indexed_at": "<string>",
"in_sync": true,
"chunk_count": 0,
"chunks": [
{
"index": 0,
"text": "<string>",
"char_count": 0,
"char_start": 0,
"char_end": 0,
"overlap_chars": 0,
"section_heading": "<string>",
"section_path": "<string>",
"section_anchor": "<string>"
}
]
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}Authorizations
Send your API key as Authorization: Bearer aw_live_…. Manage keys in the dashboard under Settings → API Keys.
Path Parameters
Query Parameters
Required string length:
2 - 16
