Reference

English

日本語

English

日本語

Appearance

PLaMo API Console Manual ​

To utilize PLaMo's API functionality, you must create a tenant and obtain an API key. Using the API key enables access to PLaMo's features through HTTP requests. This manual provides detailed explanations of the tenant console's fundamental concepts, specific operational procedures, and API usage restrictions.

Concepts ​

The following three concepts are essential for using the console:

Tenant ​

A tenant represents the top-level management unit for utilizing the PLaMo platform and has the following characteristics:

Organizational Characteristics:

  • Only one tenant is created for each billing account of the PLaMo API.
  • Within a tenant, you can create and manage multiple projects.
  • For example, an entire company can have one tenant, and within it, create projects based on departments or service units.

Billing Management:

  • The tenant serves as the fundamental billing unit.
  • Usage amount (API calls, processing time, etc.) across all projects within the tenant is aggregated and billed collectively, facilitating organization-wide usage monitoring and cost management.

Project ​

Projects function as units for managing API keys and budgets within a tenant.

Project Characteristics:

  • Multiple projects can be created as needed.
  • One member can belong to multiple projects, and each project can have multiple participating members.

API Key Management:

  • Each project can create API keys associated with the project.
  • When API keys linked to the project are used, the token usage is aggregated for that project.
  • Unlike personal API keys, multiple members belonging to the project can manage them.

Budget Management:

  • For each project, you can check the token usage and usage amount on a daily and monthly basis.
  • You can set usage limits and alerts for usage amounts independently for each project.
  • This makes it easy to manage the budget and visualize costs for each project.

Operational Tips:

We recommend creating projects to align with actual business projects or departments. For example, establishing projects at the following levels can help with budget allocation and setting project-specific usage limits:

  • Product Development Team Units
  • Service Units
  • Research and Development Departments

Default Project: A special project named Default is provided initially. All tenant members automatically belong to this project. Please utilize it for basic operations and verification work.

Role ​

PLaMo API console provides the following three roles:

  • Tenant Administrator
  • Project Administrator
  • Member

Tenant Administrator:

  • Has access to all projects and resources within the tenant.
  • Can create and delete projects, set usage limits, and configure usage alerts for each project.
  • Can invite and remove members from the tenant and manage their permissions.

Project Administrator:

  • Can create, delete, and re-generate API keys within their projects.
  • Can add and remove members from the project and manage permissions. However, it is not allowed to add members not joined the tenant yet.
  • Can check the token usage and usage amounts of the projects.

Member:

  • Can check the usage amounts of the projects they belong to.
  • Cannot create, delete, or re-generate API keys.

Features ​

User Invitation ​

In order for a user to access the tenant, an invitation from an existing tenant administrator is required. Upon receiving an invitation, the user can access the tenant by accepting the invitation.

When inviting to the tenant, you can choose between Tenant Administrator and Regular User as the roles. If you want to invite someone as a Project Administrator or Member, please select Regular User.

After accepting the invitation and logging in, the user can gain access to the project by being added as a member to the project. Either the Tenant Administrator or the Project Administrator can add members to the project.

API Key Management ​

API keys are used for authentication when accessing PLaMo's API services. API keys must be strictly managed and should not be shared with others.

There are two types of API keys: Personal API keys and Project API keys.

Personal API Keys:

  • Each member can create one personal API key from the profile page.
  • If a member is removed from the tenant, the API key associated with the member is immediately invalidated.
  • When a personal API key is used, the token usage are aggregated only in the total token usage of the entire tenant.

Project API Keys:

  • Project administrators can create multiple project API keys.
  • Project API keys are not invalidated even if project members are removed.
  • When a project API key is used, the tokens used are aggregated in both the project's token usage and the total token usage of the entire tenant.

Re-generate API Key ​

If you are concerned that your API key has been compromised or misused, please re-generate or delete your API key.

If you re-generate an API key, the old API key will be invalidated immediately. If your API key is embedded in a running service, please create a different API key in advance and replace it with the new one before re-generating to avoid affecting the service.

Billing Limit Settings ​

Billing restrictions can be set at three levels:

Tenant-Level Quota:

  • Restricts total tenant usage, with initial limitations to prevent unexpected high charges
  • Currently, quota increases require form submissions when needed
  • API requests are blocked when the usage reaches the quota

Tenant-Level Billing Limits:

  • Configurable maximum billing amount for the entire tenant
  • Freely adjustable within quota limits
  • Can be set monthly, automatically restricting API usage upon reaching the set amount
  • Alert notifications available, notifying administrators when specific thresholds are reached

Project-Level Billing Limits:

  • Individual billing limits configurable for each project
  • Useful for project budget management
  • Can be set monthly, API usage restrictions apply only to projects reaching their limits
  • Alert notifications available similar to tenant-level settings

Regarding Usage Amount and Alert Threshold Reductions

For tenant and project-level restrictions, reducing limits below amounts already reached in the current month does not affect confirmed charges. Similarly, alerts will not trigger for thresholds set below current usage levels. These features are effectual only when API usage increases and reaches limit already defined, triggering alerts or usage restrictions.

Console Usage ​

Basic Screen Layout: Switch between tenant and project setting modes by selecting either tenant or project in the header's right side:

Tenant Settings ​

In tenant mode, access six main functions from the left sidebar:

Project Management:

  • Create new projects
  • Modify existing project settings
  • Delete existing projects

User Management:

  • Configure tenant member permissions
  • Remove members
  • Invite new members

Usage Status:

  • Monitor tenant-wide billing amounts
  • Check daily token usage
  • View usage trend graphs

Usage Limit Settings:

  • Configure tenant-wide usage limits
  • Set project-specific usage limits
  • Configure alert thresholds

Tenant Settings:

  • Modify tenant name
  • Enable Multi-Factor Authentication (MFA)
  • View tenant basic information

Billing Management:

  • Access external billing management site
  • View billing history
  • Register or modify payment methods

Project Settings ​

In project mode, access four main functions from the left sidebar:

API Key Management:

  • Issue new API keys
  • Delete existing API keys
  • Reissue API keys

Member Management:

  • Add project members
  • Configure member permissions
  • Remove members

Usage Status:

  • Monitor project-specific billing amounts
  • Check daily token usage
  • View project-specific usage graphs

Project Information:

  • View and modify project name
  • Confirm project ID
  • Manage project basic settings

© 2024 Preferred Networks, Inc.