oib/aitbc

Files

oib 15427c96c0 chore: update file permissions to executable across repository

- Change file mode from 644 to 755 for all project files
- Add chain_id parameter to get_balance RPC endpoint with default "ait-devnet"
- Rename Miner.extra_meta_data to extra_metadata for consistency

2026-03-06 22:17:54 +01:00

1.6 KiB

Executable File

Raw Blame History

title, description

title	description
API Authentication	Understanding and implementing API authentication

API Authentication

All AITBC API endpoints require authentication using API keys.

Getting API Keys

Production

Visit the AITBC Dashboard
Create an account or sign in
Navigate to API Keys section
Generate a new API key

Testing/Development

For integration tests and development, these test keys are available:

${CLIENT_API_KEY} - For client API access
${MINER_API_KEY} - For miner registration
test-tenant - Default tenant ID for testing

Using API Keys

HTTP Header

X-API-Key: your_api_key_here
X-Tenant-ID: your_tenant_id  # Optional for multi-tenant

Environment Variable

export AITBC_API_KEY="your_api_key_here"

SDK Configuration

from aitbc import AITBCClient

client = AITBCClient(api_key="your_api_key")

Security Best Practices

Never commit API keys to version control
Use environment variables in production
Rotate keys regularly
Use different keys for different environments
Monitor API key usage

Rate Limits

API requests are rate-limited based on your plan:

Free: 60 requests/minute
Pro: 600 requests/minute
Enterprise: 6000 requests/minute

Error Handling

from aitbc.exceptions import AuthenticationError

try:
    client.jobs.create({...})
except AuthenticationError:
    print("Invalid API key")

Key Management

View Your Keys

aitbc api-keys list

Revoke a Key

aitbc api-keys revoke <key_id>

Regenerate a Key

aitbc api-keys regenerate <key_id>

1.6 KiB Executable File Raw Blame History