List suggested help articles
curl --request GET \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}/help_articles \
--header 'api_access_token: <api-key>'const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}/help_articles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}/help_articles"
headers = {"api_access_token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"articles": [
{}
]
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}Requirements
List suggested help articles
Help-center articles that read like this report. Empty when the requirements_ai_kb flag is off or nothing matches.
GET
/
api
/
v1
/
accounts
/
{account_id}
/
requirements
/
{id}
/
help_articles
List suggested help articles
curl --request GET \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}/help_articles \
--header 'api_access_token: <api-key>'const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}/help_articles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/requirements/{id}/help_articles"
headers = {"api_access_token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"articles": [
{}
]
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}Was this page helpful?