# API reference

> Every endpoint in the Gensiv API, with parameters, responses and examples.

Canonical URL: https://gensiv.com/docs/api-reference
Product: Gensiv — Become the brand AI recommends

---

The Gensiv API is a read-only REST API. It returns JSON and uses standard HTTP status codes.

```txt
https://api.gensiv.com/v1
```

Authenticate every request with an API key in the `Authorization` header. See [Authentication](/docs/authentication).

```bash
curl https://api.gensiv.com/v1/brands \
  -H "Authorization: Bearer $GENSIV_API_KEY"
```

## Endpoints [#endpoints]

| Endpoint                                                                                           | Description                                                  |
| -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| [`GET /engines`](/docs/api-reference/engines/listEngines)                                          | AI engines and their slugs                                   |
| [`GET /brands`](/docs/api-reference/brands/listBrands)                                             | Brands in the workspace                                      |
| [`GET /brands/{brandId}`](/docs/api-reference/brands/getBrand)                                     | One brand                                                    |
| [`GET /brands/{brandId}/competitors`](/docs/api-reference/brands/listCompetitors)                  | Tracked competitors                                          |
| [`GET /brands/{brandId}/prompts`](/docs/api-reference/brands/listPrompts)                          | Tracked prompts                                              |
| [`GET /brands/{brandId}/metrics`](/docs/api-reference/metrics/getMetrics)                          | Visibility metrics for a date range                          |
| [`GET /brands/{brandId}/metrics/daily`](/docs/api-reference/metrics/getDailyMetrics)               | Metrics per day, engine and company                          |
| [`GET /brands/{brandId}/metrics/prompts`](/docs/api-reference/metrics/getPromptMetrics)            | Metrics per prompt, lowest visibility first                  |
| [`GET /brands/{brandId}/sources/domains`](/docs/api-reference/sources/listSourceDomains)           | Most cited domains                                           |
| [`GET /brands/{brandId}/sources/urls`](/docs/api-reference/sources/listSourceUrls)                 | Most cited pages                                             |
| [`GET /brands/{brandId}/responses`](/docs/api-reference/responses/listResponses)                   | Individual AI responses                                      |
| [`GET /brands/{brandId}/alerts`](/docs/api-reference/alerts/listAlerts)                            | Visibility drops, competitor overtakes and new rival sources |
| [`GET /brands/{brandId}/action-plans`](/docs/api-reference/action-plans/listActionPlans)           | Prompts lost to competitors, with action plans               |
| [`GET /brands/{brandId}/articles`](/docs/api-reference/articles/listArticles)                      | AI-written articles                                          |
| [`GET /brands/{brandId}/articles/{articleId}`](/docs/api-reference/articles/getArticle)            | One article with Markdown, HTML, sources and JSON-LD         |
| [`GET /credits`](/docs/api-reference/credits/getCreditBalance)                                     | AI writing credits left                                      |
| [`GET /brands/{brandId}/reddit/opportunities`](/docs/api-reference/reddit/listRedditOpportunities) | Reddit threads                                               |

## OpenAPI [#openapi]

The full OpenAPI 3 specification is available at [`https://api.gensiv.com/v1/openapi.json`](https://api.gensiv.com/v1/openapi.json). Import it into Postman, Insomnia or a code generator to get a client for your language.