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

# API keys

> Create, check and revoke organization API keys, which let your own systems call the Peeps API over HTTP without a person signing in.

An API key lets your own systems call the [Peeps API](/api-reference/introduction) over plain HTTP. Nobody signs in and no coding agent runs. You create keys for your organization, choose which projects each one reaches, and revoke a key when you no longer need it.

## What a key can do

* **It belongs to your organization, not to a person.** What it sends is recorded as sent by the key. The key keeps working when the person who created it leaves.
* **It can only send results.** A key sends JUnit XML and pytest-html reports, and reads the status of the uploads that same key sent. It can't read test cases, reports or anything else in Peeps.
* **It reaches only the projects you choose.** You pick some web projects, or all of them. Projects whose tests live in a GitHub repository can't receive results from a key.

A key looks like `peeps_` followed by 43 characters. Treat it like a password: keep it in your CI system's secret store, never in a repository.

> [!NOTE]
>
> API keys are turned on per organization. If you don't see **API keys** in your organization's settings, contact Peeps to turn it on.

## Create a key

You need the Owner role.

**1. Open API keys**

In Peeps, open **Settings** and select **API keys** under **Organization**.

**2. Name it**

Click **Create API key** and give it a **Name**, such as `Nightly CI`. Pick a name that says where the key is used, so you know which one to revoke later.

**3. Choose its projects**

Under **Projects**, choose **Only these projects** and pick one or more web projects, or choose **All web projects, including ones created later**.

**4. Choose when it expires**

Under **Expires**, choose **30 days**, **90 days**, **1 year** or **Never**. The default is **1 year**. Peeps shows the date the key will expire.

**5. Save the key**

Click **Create key**. Peeps shows the key and an example request. **Save the key now**: Peeps shows it only once and doesn't keep a readable copy. Click **I've copied it** when you're done.

If you lose a key, you can't see it again. Revoke it and create a new one.

## Check your keys

The **API keys** page lists every key in your organization. For each one you see:

* its name and the start of the key, such as `peeps_7Hq2…`, so you can tell keys apart
* the projects it can send to
* who created it, when, and when it expires
* when it was last used, or **Never used**

When a key expires, every request with it is refused with a `401`. Peeps doesn't warn you before that happens, so check the expiry date in the list and replace the key in time.

To confirm a key works and see what it can reach, call [`GET /api-key`](/api-reference/api-key/get-the-current-key) with it.

## Revoke a key

You need the Owner role.

1. On the **API keys** page, click **Revoke** next to the key.
2. Click **Revoke key** to confirm.

The key stops working on the next request. Results it already sent stay in Peeps. A revoked key stays in the list, greyed out, with who revoked it and when. You can't restore a revoked key; create a new one instead.

If API keys are turned off for your organization, no key works, but you can still open **API keys** and revoke the keys that exist.

## Next

Send your first report file: [Send results from your harness](/results-api/send-results).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.