List FAQs

List FAQ entries

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

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

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

GET

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

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

{
  "status": "error",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "<string>"
}

Overview

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`.

Example cURL

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.

Error Responses

404 Not Found - Agent does not exist

{
  "status": "failure",
  "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message": "Agent not found"
}

Use Cases

Reviewing existing FAQ content before making updates
Retrieving faqId values 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 Inya support to trace a specific request.

Authorizations

x-api-key

string

header

required

API key with 'agents' permission

Path Parameters

botId

string

required

Unique identifier of the agent

Query Parameters

environment

enum<string>

default:development

Filter by environment. Default is development.

Available options:

development,

staging,

production

Response

FAQs retrieved successfully

status

string

Example:

"success"

requestId

string

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

message

string

response

object

Getting Started

Agents API

Conversations API

Agent Config API

Agent FAQ API

Chat SDK API

Reference

Overview

Required Permission

Path Parameters

Query Parameters

Example cURL

Response

Success (200)

Response Fields

Error Responses

Use Cases

Authorizations

Path Parameters

Query Parameters

Response

​Overview

​Required Permission

​Path Parameters

​Query Parameters

​Example cURL

​Response

​Success (200)

​Response Fields

​Error Responses

​Use Cases

Authorizations

Path Parameters

Query Parameters

Response

Overview

Required Permission

Path Parameters

Query Parameters

Example cURL

Response

Success (200)

Response Fields

Error Responses

Use Cases