> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gnani.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get FAQ Sample

> Download a sample FAQ template showing the expected import format

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

```bash theme={null}
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:

```json theme={null}
{
  "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

<Tip>
  Populate the `faq` array with your entries and submit it to **Import FAQs** to load your FAQ knowledge base in bulk.
</Tip>

<Note>
  Save the `requestId` from every response. You will need it if you contact Inya support to trace a specific request.
</Note>


## OpenAPI

````yaml GET /v1/agents/faqs/sample
openapi: 3.0.3
info:
  title: Platform Agents API
  description: API endpoints for creating, managing, and interacting with voice agents
  version: 2.1.0
servers:
  - url: https://api.inya.ai/platform
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Agents
    description: Agent management operations
  - name: AgentFAQ
    description: Agent FAQ management
  - name: AgentCallTriggers
    description: Outbound call triggers
  - name: ChatSDK
    description: Chat Widget configuration
  - name: Conversations
    description: Conversation logs, statistics, and audio
paths:
  /v1/agents/faqs/sample:
    get:
      tags:
        - AgentFAQ
      summary: GET FAQ sample template
      description: Download a sample FAQ template file in CSV format.
      operationId: getFaqSample
      responses:
        '200':
          description: CSV file download
          content:
            text/csv:
              schema:
                type: string
                format: binary
        '500':
          $ref: '#/components/responses/ServerError'
components:
  responses:
    ServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          example: error
        requestId:
          type: string
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        message:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key with 'agents' permission

````