List FAQ entries
curl --request GET \
--url https://api.inya.ai/platform/v1/agents/{botId}/faqs \
--header 'x-api-key: <api-key>'import requests
url = "https://api.inya.ai/platform/v1/agents/{botId}/faqs"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.inya.ai/platform/v1/agents/{botId}/faqs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"message": "FAQs retrieved successfully",
"response": {
"faqs": [
{
"faqId": "faq_xyz001",
"questions": [
"What are your business hours?",
"When are you open?"
],
"answer": "We are open Monday to Friday, 9am to 6pm IST.",
"language": "en-IN",
"signal": null
}
],
"totalCount": 1
}
}{
"status": "failure",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"message": "<string>"
}{
"status": "failure",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"message": "<string>"
}Agent FAQ API
List FAQs
Retrieve all FAQ entries for a specific agent
GET
/
v1
/
agents
/
{botId}
/
faqs
List FAQ entries
curl --request GET \
--url https://api.inya.ai/platform/v1/agents/{botId}/faqs \
--header 'x-api-key: <api-key>'import requests
url = "https://api.inya.ai/platform/v1/agents/{botId}/faqs"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.inya.ai/platform/v1/agents/{botId}/faqs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"message": "FAQs retrieved successfully",
"response": {
"faqs": [
{
"faqId": "faq_xyz001",
"questions": [
"What are your business hours?",
"When are you open?"
],
"answer": "We are open Monday to Friday, 9am to 6pm IST.",
"language": "en-IN",
"signal": null
}
],
"totalCount": 1
}
}{
"status": "failure",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"message": "<string>"
}{
"status": "failure",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"message": "<string>"
}What it does: Retrieve all FAQ entries currently stored for the specified agent and environment. Use the returned
faqId values to update or delete individual entries.
Required Permission
agents
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
botId | string | Yes | Unique agent identifier. |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
environment | string | No | Filter by environment: development, staging, or production. Default: development. |
Minimum working example
curl "https://api.inya.ai/platform/v1/agents/fb79920229d144608ebf665a10e50275/faqs?environment=development" \
-H "x-api-key: <your_api_key>"
Response
Success (200)
{
"status": "success",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"message": "FAQs retrieved successfully",
"response": {
"faqs": [
{
"faqId": "faq_xyz001",
"questions": ["What are your business hours?", "When are you open?"],
"answer": "We are open Monday to Friday, 9am to 6pm IST.",
"language": "en-IN",
"signal": null
},
{
"faqId": "faq_xyz002",
"questions": ["How do I cancel my subscription?"],
"answer": "To cancel, visit our website or contact billing@example.com.",
"language": "en-IN",
"signal": "CANCELLATION_INTENT"
}
],
"totalCount": 2
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
faqs[].faqId | string | Unique FAQ identifier. Use this when updating or deleting the entry. |
faqs[].questions | string[] | Question phrasings that trigger this FAQ. |
faqs[].answer | string | The spoken answer returned when a match is detected. |
faqs[].language | string | BCP-47 language code for this entry. |
faqs[].signal | string | Optional analytics label. null if not set. |
totalCount | integer | Total FAQ entries for this agent in the specified environment. |
Errors
404 Not Found - Agent not found{
"status": "failure",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"message": "Agent not found"
}
Use Cases
- Reviewing existing FAQ content before making updates
- Retrieving
faqIdvalues needed for Update FAQ or Delete FAQs - Auditing FAQ coverage across languages and environments
Always list FAQs first to get the
faqId values before calling Update FAQ or Delete FAQs.Save the
requestId from every response. You will need it if you contact Gnani support to trace a specific request.Authorizations
API key with 'agents' permission
Path Parameters
Unique identifier of the agent
Query Parameters
Filter by environment. Default is development.
Available options:
development, staging, production Was this page helpful?