Authentication

The Aryna API uses API keys to authenticate requests. All API requests must include a valid API key.

Getting Your API Key

1
Navigate to Settings
In your Aryna dashboard, go to Settings → API Keys
2
Create New Key
Click "Create API Key", give it a descriptive name, and select the scopes you need
3
Save Securely
Copy your API key immediately - you won't be able to see it again!

Include your API key in the Authorization header of every request using the Bearer token format:

Authorization: Bearer aryna_pk_prod_abc123...

cURL

curl https://api.aryna.ai/v1/communities \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

When creating an API key, you must select which scopes (permissions) the key should have. This allows you to limit what actions the key can perform.

users:read

View user information and list users

users:write

Create, update, and invite users

communities:read

View community information and list communities

communities:write

Create, update, and delete communities

Never commit API keys to version control
Use environment variables and keep keys out of your codebase
Use the principle of least privilege
Only grant the minimum scopes needed for each integration
Rotate keys regularly
Create new keys and revoke old ones periodically
Monitor API key usage
Review the usage dashboard to detect unusual activity

Aryna API keys follow a structured format for easy identification:

aryna_pk_prod_abc123def456...

aryna_pkPrefix indicating Aryna API key

prod/testEnvironment (production or test)

abc123...Unique key identifier (64 characters)

Test authenticated API requests directly in your browser with our interactive OpenAPI documentation.