Chroma Golem API Documentation

Organizations

Organizations in Chroma Golem allow you to collaborate with team members, share API keys, centralize billing, and track usage across your game studio or development team.

Contents

Overview

Organizations provide a collaborative workspace for teams using Chroma Golem's AI API services. With organizations, you can:

Shared API Keys

Share API keys across team members with role-based permissions

Centralized Billing

Manage credits and billing in one place for your entire team

Usage Analytics

Track usage and costs across different projects and team members

Team Management

Manage team members with different permission levels

Data Export

Export detailed usage reports for analysis and record-keeping

Alert System

Receive alerts when credit balances are running low

Organizations are ideal for game studios, development teams, and collaborators who need shared access to AI resources.

Creating and Managing Organizations

Creating an Organization

To create a new organization:

1 Navigate to your Dashboard and click "Organizations" in the navigation
2 Click the "Create Organization" button
3 Enter your organization name and optional description
4 Click "Create" to set up your new organization

Note: When you create an organization, you are automatically assigned as the owner with full administrative privileges.

Editing Organization Details

Organization owners and admins can update the organization's details:

1 Go to your organization's page
2 Click the "Edit" button
3 Update the organization name and description
4 Click "Update Organization" to save changes

Pro tip: A clear organization description helps team members understand the purpose of the organization.

Roles and Permissions

Organizations have a three-tier permission system to give you fine-grained control over who can do what:

Owner

Full administrative control

Highest Access
  • Manage organization details (name, description)
  • Manage members and roles (invite, remove, change roles)
  • Manage billing and credits (purchase, view history)
  • Create and manage API keys (create, edit, delete)
  • Access all usage data and export reports
  • Delete the organization

Admin

Management capabilities

Medium Access
  • Manage members (invite, remove)
  • Manage billing and credits (purchase, view history)
  • Create and manage API keys (create, edit, delete)
  • Access all usage data and export reports
  • Cannot delete the organization

Member

Basic usage rights

Basic Access
  • View and use shared API keys
  • View organization usage data
  • Cannot manage billing or add members
  • Cannot delete or edit API keys created by others

Managing Team Members

Inviting Team Members

Invite Member

Email:
Role:

To invite new team members:

  1. 1 Go to your organization's page
  2. 2 Click "Invite Member"
  3. 3 Enter the email address of the person to invite
  4. 4 Select a role (Member, Admin, or Owner)
  5. 5 Click "Send Invitation"

Invitation links expire after 7 days. You can resend an invitation if needed.

Managing Existing Members

JD
AS

Organization owners and admins can:

Edit Role

Change a member's role between Member, Admin, and Owner to adjust their permissions

Remove Member

Remove a user from your organization when they no longer need access

Important: An organization must always have at least one owner. You cannot remove yourself if you're the last owner of the organization.

Organization API Keys

Organization API keys are shared among all members of the organization, with costs charged to the organization's credit balance.

Creating API Keys

To create an organization API key:

  1. Go to the API Keys page
  2. Select the appropriate organization in the Organization dropdown
  3. Enter a name for your API key
  4. Select your preferred AI model
  5. Click "Create API Key"

Managing Organization API Keys

Organization API keys differ from personal keys in several ways:

  • Shared Access: All organization members can view and use the organization's API keys
  • Credit Usage: Usage costs are deducted from the organization's credit balance
  • Permission-Based Management: Only owners and admins can create, edit, or delete organization API keys
  • Usage Tracking: Usage is attributed to the organization for centralized analytics

Credit System and Billing

Organization Credit Management

Organizations have their own credit balance separate from individual user credits:

  • Credit Balance: Organizations maintain a shared pool of Game Points (GP) that are consumed when using organization API keys
  • Credit Purchase: Owners and admins can purchase credits for the organization
  • Low Credit Alerts: Automatic alerts notify organization owners and admins when credits are running low
  • Credit History: Track all credit adjustments and purchases in the billing section

Credit Threshold Alerts

Organizations receive automated email alerts when credit balances fall below certain thresholds:

  • Low Balance Warning: Sent when credits fall below 10,000 GP
  • Critical Balance Warning: Sent when credits fall below 1,000 GP

These alerts are sent to all organization owners and admins. The system throttles alerts to prevent excessive notifications:

  • Low balance warnings are sent at most once every 72 hours
  • Critical balance warnings are sent at most once every 24 hours

Usage Analytics and Reporting

Organization Dashboard

The organization dashboard provides comprehensive analytics:

  • Credit Balance: Current organization credit balance
  • API Keys: Total number of organization API keys
  • Usage Statistics: Request counts, token usage, and unique clients
  • Usage Trends: Comparison of current usage to the previous period
  • Cost Efficiency Metrics: Cost per request, tokens per request, and cost per unique client

Usage Visualizations

The organization dashboard includes several visual analytics:

  • API Request Chart: Daily API usage trends over time
  • Model Distribution: Breakdown of token usage by AI model
  • API Key Performance: Comparative performance of different API keys

Data Export Capabilities

Export detailed usage data for offline analysis, reporting, or archiving:

  • CSV Export: Detailed request-level data including timestamps, models, tokens, and costs
  • PDF Reports: Formatted summary reports with key metrics and visualizations
  • Custom Date Ranges: Filter exports by specific date ranges

Pro Tip: Regular data exports are recommended for organizations that need to reconcile AI usage costs with project budgets or client billing.

Organization Switcher

The organization switcher allows you to quickly navigate between personal and organization contexts:

  • Location: Available in the main navigation of all dashboard pages
  • Functionality: Quickly switch between your personal account and any organizations you belong to
  • Context Awareness: The current organization is highlighted and shows in the header
  • Quick Access: Provides direct links to create new organizations or view all organizations

Best Practices and Tips

  • Organization Structure: Consider creating separate organizations for different projects or client engagements to keep billing and usage separate.
  • Role Assignment: Only grant Admin and Owner roles to team members who need to manage billing or team composition.
  • API Key Management: Create descriptive names for API keys to easily identify their purpose and project association.
  • Credit Management: Set internal thresholds for purchasing additional credits before automated alerts are triggered.
  • Regular Audits: Periodically review team members and their permissions, especially after project completions.

Need Help?

If you have questions about organizations or need assistance, our support team is ready to help:

Back to your dashboard
View my API keys