# 13. Appendices

The appendices provide supplementary information, resources, and reference materials to enhance the understanding and use of the Ferdy Framework. This section includes technical specifications, additional resources, and contact information.

### **13.1 Glossary of Terms**

| Term    | Definition                                                                                 |
| ------- | ------------------------------------------------------------------------------------------ |
| AIAHH   | AI Agents with Human Handover, enabling seamless transitions from AI to human support.     |
| ASR     | Automatic Speech Recognition, used to convert spoken language into text.                   |
| TTS     | Text-to-Speech, used to convert text into synthesized voice output.                        |
| NLP     | Natural Language Processing, enabling AI to understand and generate human-like text.       |
| SDK     | Software Development Kit, providing tools and libraries for developers to integrate Ferdy. |
| GraphQL | A query language for APIs allowing flexible data retrieval.                                |

***

### **13.2 API Status Codes**

| Status Code | Meaning               | Action Required                                           |
| ----------- | --------------------- | --------------------------------------------------------- |
| 200         | OK                    | Request was successful.                                   |
| 201         | Created               | Resource was successfully created.                        |
| 400         | Bad Request           | Check request parameters and body for errors.             |
| 401         | Unauthorized          | Verify API key or authentication token.                   |
| 403         | Forbidden             | Ensure proper permissions for the requested operation.    |
| 404         | Not Found             | Ensure the endpoint or resource exists.                   |
| 500         | Internal Server Error | Retry the request; contact support if the issue persists. |

***

### **13.3 Supported Languages**

| Language   | Text Support | Voice Support | Additional Notes                          |
| ---------- | ------------ | ------------- | ----------------------------------------- |
| English    | ✔            | ✔             | Default language.                         |
| Spanish    | ✔            | ✔             | Full support for regional dialects.       |
| Portuguese | ✔            | ✔             | Includes European and Brazilian variants. |
| French     | ✔            | ✔             | Natural language understanding optimized. |
| Swedish    | ✔            | ✔             | Focused on conversational accuracy.       |
| Italian    | ✔            | ✔             | Full voice and text interaction.          |

***

### **13.4 Sample Configuration Files**

**Environment File (.env):**

`API_KEY=your-api-key`

`DATABASE_URL=postgresql://user:password@localhost:5432/ferdy`

`DEBUG=true`

`REGION=us-east-1`

<br>

**Workflow Definition (workflow\.json):**

`{`

&#x20; `"workflow_name": "custom_email_task",`

&#x20;`"steps": [`

&#x20;   `{`

&#x20;     `"type": "SEND_EMAIL",`

&#x20;     `"parameters": {`

&#x20;       `"to": "user@example.com",`

&#x20;       `"subject": "Welcome to Ferdy",`

&#x20;       `"body": "Thank you for signing up!"`

&#x20;     `}`

&#x20;   `}`

&#x20; `]`

`}`

<br>

***

### **13.5 Sample API Request**

**Endpoint: POST /tasks/execute**<br>

`POST /tasks/execute`

`Authorization: Bearer YOUR_API_KEY`

`Content-Type: application/json`

<br>

**Body: json**

`{`

&#x20; `"task_type": "email",`

&#x20; `"parameters": {`

&#x20;   `"to": "recipient@example.com",`

&#x20;   `"subject": "Meeting Reminder",`

&#x20;   `"body": "Don't forget our meeting at 3 PM."`

&#x20; `}`

`}`

**Response: json**

`{`

&#x20; `"task_id": "123abc",`

&#x20; `"status": "scheduled",`

&#x20; `"timestamp": "2024-12-14T10:00:00Z"`

`}`

***

### **13.6 Resources**

* Ferdy Developer Portal: developer.ferdy.ai
* API Documentation: docs.ferdy.ai
* Community Forum: community.ferdy.ai
* Support Email: <support@ferdy.ai>

***

### **13.7 Contact Information**

* General Inquiries: <info@feeda.com>
* Sales Team: <sales@feeda.com>
* Technical Support: <support@feeda.com>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://feeda.gitbook.io/ferdy-framework/13.-appendices.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
