# Quickstart

> Create an API key and read your brand's visibility in a few minutes.

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

---

<Steps>
  <Step>
    ### Create an API key [#create-an-api-key]

    In the Gensiv app, open **Settings → API keys** and select **Create key**. Give the key a name that says where it will be used, such as `Reporting dashboard`.

    Copy the key when it is shown. For your security, Gensiv only shows the full key once.

    <Callout>
      Only workspace owners and admins can create keys, and the workspace needs an active Pro or Enterprise plan.
    </Callout>
  </Step>

  <Step>
    ### Store the key as an environment variable [#store-the-key-as-an-environment-variable]

    Keep the key out of your source code:

    ```bash
    export GENSIV_API_KEY="gsk_..."
    ```
  </Step>

  <Step>
    ### List your brands [#list-your-brands]

    Every request sends the key in the `Authorization` header:

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

    The response lists every brand in your workspace:

    ```json
    {
      "data": [
        {
          "id": "6bfcc8d1-f4ca-4227-83f4-9ee3924f82dd",
          "name": "Acme",
          "websiteUrl": "https://acme.com",
          "engines": ["chatgpt", "perplexity"],
          "createdAt": "2026-07-14T09:21:07.000Z"
        }
      ]
    }
    ```
  </Step>

  <Step>
    ### Get visibility metrics [#get-visibility-metrics]

    Use a brand `id` to get visibility, share of voice, average position and sentiment for the last 30 days:

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

    ```json
    {
      "from": "2026-08-30",
      "to": "2026-09-28",
      "responses": 480,
      "data": [
        {
          "entityType": "brand",
          "competitorId": null,
          "name": "Acme",
          "visibility": 42.5,
          "shareOfVoice": 31.2,
          "avgPosition": 2.4,
          "sentiment": 71
        },
        {
          "entityType": "competitor",
          "competitorId": "2883cac2-e9f2-4d26-9fba-cbf7a792c54b",
          "name": "Globex",
          "visibility": 55.1,
          "shareOfVoice": 40.4,
          "avgPosition": 1.9,
          "sentiment": 64
        }
      ]
    }
    ```

    Add `from`, `to` and `engine` to narrow the results:

    ```bash
    curl "https://api.gensiv.com/v1/brands/$BRAND_ID/metrics?from=2026-09-01&to=2026-09-28&engine=chatgpt" \
      -H "Authorization: Bearer $GENSIV_API_KEY"
    ```
  </Step>
</Steps>

## Next steps [#next-steps]

<Cards>
  <Card title="Metrics" href="/docs/metrics">
    What each number means and how it is calculated.
  </Card>

  <Card title="API reference" href="/docs/api-reference">
    Every endpoint, parameter and response field.
  </Card>
</Cards>