Skip to main content
GET
/
credential-kinds
curl -X GET "https://nunu.ai/api/v1/credential-kinds?page=0&page_size=25" \
  -H "X-Api-Key: YOUR_API_TOKEN"
{
  "data": [
    {
      "id": "ck_steam_account",
      "name": "Steam Account",
      "description": "Steam credentials",
      "exclusive": true
    }
  ],
  "pagination": {
    "page": 0,
    "page_size": 25,
    "total_count": 1,
    "total_pages": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.nunu.ai/llms.txt

Use this file to discover all available pages before exploring further.

Permission Required: project:view-configs
Retrieve a paginated list of credential kinds for your project. The returned id matches the credential_kind_id field on test player credentials, so this endpoint is useful when constructing tests that reference credentials.

Query Parameters

page
integer
default:"0"
Page number (0-indexed)
page_size
integer
default:"25"
Results per page (1-100)

Response

data
CredentialKind[]
required
Array of credential kind objects
pagination
object
required
Pagination metadata (page, page_size, total_count, total_pages)

CredentialKind Object

id
string
required
Credential kind ID (use as credential_kind_id on test player credentials)
name
string
required
Credential kind name
description
string
Optional description
exclusive
boolean
required
Whether each credential of this kind can be used by at most one concurrent run
curl -X GET "https://nunu.ai/api/v1/credential-kinds?page=0&page_size=25" \
  -H "X-Api-Key: YOUR_API_TOKEN"
{
  "data": [
    {
      "id": "ck_steam_account",
      "name": "Steam Account",
      "description": "Steam credentials",
      "exclusive": true
    }
  ],
  "pagination": {
    "page": 0,
    "page_size": 25,
    "total_count": 1,
    "total_pages": 1
  }
}

Authorizations

X-Api-Key
string
header
required

API key for authentication

Query Parameters

page
integer
default:0

Page number (0-indexed)

page_size
integer
default:25

Results per page (1-100)

Required range: 1 <= x <= 100

Response

Successful response

data
object[]
pagination
object