> For the complete documentation index, see [llms.txt](https://cognitia-api-documentation.gitbook.io/bgallais/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cognitia-api-documentation.gitbook.io/bgallais/cognitia-api.md).

# Cognitia API

> ⚠️ This documentation is part of a **fictional portfolio project** created by Berangere Gallais, freelance technical writer & documentation engineer.\
> It is not affiliated with a real product or company.

***

## 🧭 Table of Contents

* [What is Cognitia?](#what-is-cognitia)
* [Features](#features)
* [Quick Start](#quick-start)
* [Available Endpoints](#available-endpoints)
* [Tools & Format](#tools-and-format)
* [Postman & Testing](#postman-and-testing)
* [FAQ](#faq)
* [Support](#support)
* [About](#about)

***

## 🤖 What is Cognitia?

Cognitia is a REST API that processes raw text and returns actionable insights in JSON format.\
It’s designed for developers and teams building tools that need **language understanding**.

You send us text. We send you back meaning.

***

## ✨ Features

* 🔍 **Sentiment Analysis** — Classify tone as positive, neutral, or negative
* 🧠 **Summarization** — Condense long text into clear, concise summaries
* 🚨 **Bias Detection** — Detect potential stereotypes or harmful language

Supports **English and French** (except Bias → English only).

***

## 🚀 Quick Start

👉 Get started in 3 minutes

```bash
curl -X POST https://api.cognitia.ai/v1/analyze-sentiment \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text": "I love using Cognitia — it saves me hours!"}'
```

***

## 📚 Available Endpoints

| Feature            | Endpoint                  | Docs                                               |
| ------------------ | ------------------------- | -------------------------------------------------- |
| Sentiment Analysis | `POST /analyze-sentiment` | [Read the docs →](/bgallais/sentiment-analysis.md) |
| Summarization      | `POST /summarize`         | [Read the docs →](/bgallais/summarize-text.md)     |
| Bias Detection     | `POST /detect-bias`       | [Read the docs →](/bgallais/detect-bias.md)        |

***

## 🛠 Tools & Format

* REST over HTTPS
* JSON request/response
* OpenAPI spec available (for import in Postman)

***

## 🧰 Postman & Testing

You can import the [OpenAPI JSON spec](https://openapi.gitbook.com/o/kkBINegCYOuUdL26NVt2/spec/cognitia-api-documentation-api) into [Postman](https://www.postman.com) or [Insomnia](https://insomnia.rest/) for a GUI-based exploration of all endpoints.

***

## ❓ FAQ

Check out the [FAQ page](/bgallais/frequently-asked-questions-faq.md) for answers to common questions.

***

## 💬 Support

* Contact: <support@cognitia.ai>
* FAQ: [See common issues](/bgallais/frequently-asked-questions-faq.md)
* Status page: [status.cognitia.ai](https://status.cognitia.ai)

***

## 🧠 About

Cognitia is built for modern teams who care about ethical, usable, and smart language tools. It’s your shortcut to deeper understanding — in content, comments, emails, reviews, and more.&#x20;

Cognitia is a fictional AI product designed to demonstrate technical documentation skills. Made with ❤️ by Berangere Gallais — technical writer & documentation engineer).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://cognitia-api-documentation.gitbook.io/bgallais/cognitia-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.