Get FAQ Sample

GET FAQ sample template

curl --request GET \
  --url https://api.inya.ai/platform/v1/agents/faqs/sample \
  --header 'x-api-key: <api-key>'

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": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

GET

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>'

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": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

Overview

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.

Required Permission

agents

Example cURL

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:

{
  "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 for this FAQ entry (e.g. `english`, `hindi`).

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 Inya support to trace a specific request.

Authorizations

x-api-key

string

header

required

API key with 'agents' permission

Response

CSV file download

The response is of type file.

Getting Started

Agents API

Conversations API

Agent Config API

Agent FAQ API

Chat SDK API

Reference

Overview

Required Permission

Example cURL

Response

Success (200)

Response Fields

Use Cases

Authorizations

Response

​Overview

​Required Permission

​Example cURL

​Response

​Success (200)

​Response Fields

​Use Cases

Authorizations

Response

Overview

Required Permission

Example cURL

Response

Success (200)

Response Fields

Use Cases