Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs-relytone.data.cloud/llms.txt

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

API keys authenticate your requests to the RelytONE API. Each key is a randomly-generated token that remains valid until revoked.

​
API Key Types

RelytONE currently supports Personal API Keys:
Key TypeScopeValidity
Personal KeyAll organization projects where the user is a memberValid until revoked; access ends if user leaves organization

​
Create an API Key

​
Via Console

Navigate to Organization Settings > API Keys in the RelytONE Console.
Create your first API key from the Console, then use it to manage additional keys via API.
Frame21 Jp

​
Via API

Use an existing API key to create new keys programmatically: 
curl --request POST \
  --url https://relytone.data.cloud/api/v1/user/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>"
}'
Response: 
{
  "id": "<string>",
  "key": "<string>",
  "fullKey": "<string>",
  "name": "<string>",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "consumerId": "<string>",
  "consumerUsername": "<string>"
}

​
Additional Operations

For more API key management operations, see: