GET FAQ sample template
curl --request GET \
--url https://api.inya.ai/platform/v1/agents/faqs/sample \
--header 'x-api-key: <api-key>'import requests
url = "https://api.inya.ai/platform/v1/agents/faqs/sample"
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/faqs/sample', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));"<string>"{
"status": "failure",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"message": "<string>"
}Agent FAQ API
Get FAQ Sample
Download a sample FAQ template showing the expected import format
GET
/
v1
/
agents
/
faqs
/
sample
GET FAQ sample template
curl --request GET \
--url https://api.inya.ai/platform/v1/agents/faqs/sample \
--header 'x-api-key: <api-key>'import requests
url = "https://api.inya.ai/platform/v1/agents/faqs/sample"
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/faqs/sample', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));"<string>"{
"status": "failure",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"message": "<string>"
}What it does: Download a sample FAQ template that shows the expected JSON structure for a bulk import request. Use this as a starting point when preparing your FAQ dataset before calling Import FAQs.
500 Internal Server Error - Template unavailable
See Error Reference for other status codes.
Required Permission
agents
Minimum working example
curl "https://api.inya.ai/platform/v1/agents/faqs/sample" \
-H "x-api-key: <your_api_key>"
Response
Success (200)
Returns a JSON response with a sample FAQ structure. The sample uses display names (english, hindi); when calling Add FAQs or Import FAQs, use BCP-47 codes from Get Languages (e.g. en-IN, hi-IN).
{
"status": "success",
"message": "FAQ sample retrieved successfully",
"response": {
"faq": [
{
"questions": [
"What are your business hours?",
"When are you open?"
],
"answer": "We are open Monday to Friday, 9am to 6pm IST.",
"language": "english"
}
]
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
faq[].questions | string[] | Sample question phrasings. Replace with your own questions. |
faq[].answer | string | Sample answer text. Replace with your actual answer. |
faq[].language | string | Language label in the sample (english, hindi). Replace with BCP-47 codes (e.g. en-IN, hi-IN) in Add/Import requests. |
Errors
401 Unauthorized - Invalid or missing API key{
"status": "failure",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"message": "Invalid API key"
}
{
"status": "failure",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"message": "Internal server error"
}
Use Cases
- Understanding the expected JSON structure before building a large FAQ dataset
- Sharing the template with content teams who will populate the entries
- Validating that your export tooling produces the correct format before running a bulk import
Populate the
faq array with your entries and submit it to Import FAQs to load your FAQ knowledge base in bulk.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
Response
CSV file download
The response is of type file.
Was this page helpful?