POSThttps://api.rankparse.com/v1/keysFreeAPI key

Creates a new API key in the workspace of the calling key, attributed to the person the calling key acts as. The raw key is returned once and cannot be retrieved again. Store it immediately.

Body parameters

namestringdefault Default

Label for the key. A missing or empty value, or a body that is not JSON, uses Default.

Response

Responds 201 Created.

idstring

Key identifier (the SHA-256 hash of the key), as returned by List API keys.

keystring

The raw key: rp_ followed by 32 random characters. Shown only in this response.

namestring

The label.

created_atinteger

Creation time, Unix milliseconds.

Behavior

RankParse stores only the hash and the last four characters.
A notification email goes to the creator's account email.

Errors

HTTP	Code	When
401	`invalid_api_key`	Missing, invalid or revoked API key.
403	`capability_missing`	Client roles may not manage keys.

List API keys

Active keys, masked.

Authentication

How keys authenticate requests.

curl -X POST "https://api.rankparse.com/v1/keys" \
  -H "X-API-Key: rp_your_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "CI pipeline"}'

Response

{
  "id": "9f2c1e5a7b3d4e8f0a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4e5fc4d8",
  "key": "rp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "name": "CI pipeline",
  "created_at": 1760000000000
}

Create an API key

Body parametersCopy Anchor Link

ResponseCopy Anchor Link

BehaviorCopy Anchor Link

ErrorsCopy Anchor Link

RelatedCopy Anchor Link

List API keys

Authentication

Body parameters

Response

Behavior

Errors

Related