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

# API key

> How to view, copy, and regenerate your key on Project Management → API Key.

**Where:** sidebar **Project Management** → **API Key** tab

One API key is issued automatically when you create a project. There is one key per project, and you view and regenerate it here.

<Frame caption="The API Key tab — the key is masked, with view, copy, and regenerate controls.">
  <img src="https://mintcdn.com/argosidentity/OPYUfjaSdQpOBnpM/images/omni/en/project-api-key.png?fit=max&auto=format&n=OPYUfjaSdQpOBnpM&q=85&s=1734055700199e2e67a2968d10b7e8b9" alt="API Key tab" width="3736" height="1977" data-path="images/omni/en/project-api-key.png" />
</Frame>

## What is on the screen

| Element        | Description                                                         |
| -------------- | ------------------------------------------------------------------- |
| API key        | Starts with `sk_live_…`, with the rest masked                       |
| 👁 (eye icon)  | Reveals the full value, or masks it again                           |
| 📋 (copy icon) | Copies it to the clipboard. Briefly changes to "Copied!" on success |
| Created        | Shown under the field as `Created: 2026-09-10 13:23:56`             |
| Regenerate     | Revokes the current key and issues a new one                        |

**The last-used time is not on this screen.** Only the creation time is shown.

Below that, the screen shows a **Keep your API key safe** notice — "Do not share your API key anywhere publicly accessible", "Regenerate immediately if you suspect the key has been exposed".

## Regenerating

Selecting **Regenerate** opens a confirmation dialog. Confirming **invalidates the current key** immediately and replaces it with a new one, and it cannot be undone. Requests sent with the old key receive `401` `OMNI_4005`.

Because there is only one key per project, **there is no window where the new key and the old key are both valid.** API calls fail from the moment you regenerate until you finish the rollout, so plan the order before you start.

<Steps>
  <Step title="List what needs the new key first">
    Write down every server, batch job, and CI pipeline that uses this key. Anything you miss becomes an outage the moment you regenerate.
  </Step>

  <Step title="Regenerate and copy the new key">
    Confirming in the dialog switches to the new key immediately. Copy it before you leave the screen.
  </Step>

  <Step title="Update your secrets and redeploy">
    Replace the value in your environment variables or secret manager and redeploy everything. Until this step is done, calls receive `401`.
  </Step>
</Steps>

<Warning>
  If you suspect the key has been exposed in a public repository, a log, or client-side code, **regenerate it immediately.** A single leaked key can read and write every profile, document, and analysis result in that project. There is no narrower, read-only key.
</Warning>

## Handling the key

| Do not                                             | Instead                                                        |
| -------------------------------------------------- | -------------------------------------------------------------- |
| Hardcode the key in your code                      | Use environment variables or a secret manager                  |
| Commit the key to a repository, public or private  | Exclude it with `.gitignore` and inject it into CI as a secret |
| Call the API directly from a browser or mobile app | Call through your own server. Never ship the key to a client   |
| Log whole request headers in logs or error reports | Mask the `x-api-key` header                                    |
| Share the key over chat, email, or a document      | Share access through your secret manager instead               |

## Related pages

* [Authentication](/en/omni/getting-started/authentication) — using the `x-api-key` header and authentication errors
* [Admin settings](/en/omni/dashboard/project/members) — adding and removing administrators
* [API overview](/en/omni/api-reference/overview) — base URL and shared conventions