Get the current key

GET

api

api-key

curl --fail-with-body -sS \
  -H "Authorization: Bearer $PEEPS_API_KEY" \
  "https://app.peepsai.com/api/v1/api-key"

{
  "name": "Nightly CI",
  "organization": "Acme",
  "can": ["results:write"],
  "projects": ["WEB"],
  "expiresAt": "2027-10-20T14:03:11.000Z"
}

Describes the key you sent, so your harness can check its setup before it sends a file.

string

required

Bearer followed by the API key to describe.

Response

string

The key’s name.

string

Your organization’s name.

string[]

What the key can do: ["results:write"], send results and check the uploads it sent.

string[] | string

The acronyms of the projects the key can send to, or "all_web" for every web project.

string | null

When the key expires, as an ISO 8601 timestamp, or null if it never expires.

Checking a key can return 401, 429 and 500. See the errors table.

curl --fail-with-body -sS \
  -H "Authorization: Bearer $PEEPS_API_KEY" \
  "https://app.peepsai.com/api/v1/api-key"

{
  "name": "Nightly CI",
  "organization": "Acme",
  "can": ["results:write"],
  "projects": ["WEB"],
  "expiresAt": "2027-10-20T14:03:11.000Z"
}

curl --fail-with-body -sS \
  -H "Authorization: Bearer $PEEPS_API_KEY" \
  "https://app.peepsai.com/api/v1/api-key"

{
  "name": "Nightly CI",
  "organization": "Acme",
  "can": ["results:write"],
  "projects": ["WEB"],
  "expiresAt": "2027-10-20T14:03:11.000Z"
}