API Reference

Quota Management

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create a quota configuration

QuotaConfiguration quotaManagement().create(QuotaManagementCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/api/v1/beta/quota-management

Create a quota configuration for your organization, or for a single project within it.

ParametersExpand Collapse

QuotaManagementCreateParams params

String organizationId

Setting setting

The quota setting to update

ALLOW_PAY_AS_YOU_GO("allow_pay_as_you_go")

LIMIT_DAILY_USAGE_CREDITS("limit_daily_usage_credits")

LIMIT_MONTHLY_USAGE_CREDITS("limit_monthly_usage_credits")

long value

The value for the setting. For boolean settings, use 1 (enabled) or 0 (disabled). For credit limits, the number of credits allowed in the window; delete the setting to remove the limit. For limits denominated in USD cents, a whole number of dollars (a multiple of 100).

minimum0

Optional<String> projectId

Limit this project on its own. Omit to limit the organization as a whole. A project limit does not inherit from the organization limit: both apply, and whichever is reached first stops the work. Credit limits only.

formatuuid

ReturnsExpand Collapse

class QuotaConfiguration:

Full quota configuration model.

Optional<ConfigurationMetadata> configurationMetadata

The configuration metadata

ConfigurationType configurationType

The quota configuration type

One of the following:

ALLOW_PAY_AS_YOU_GO("allow_pay_as_you_go")

LIMIT_AGENT_CODER_DAILY_USAGE_USD("limit_agent_coder_daily_usage_usd")

LIMIT_AGENT_DEPLOYMENTS("limit_agent_deployments")

LIMIT_BATCH_FILES("limit_batch_files")

LIMIT_CLASSIFY_INPUT_TOKENS("limit_classify_input_tokens")

LIMIT_DAILY_USAGE_CREDITS("limit_daily_usage_credits")

LIMIT_DIRECTORIES("limit_directories")

LIMIT_DIRECTORY_FILES_PER_DIRECTORY("limit_directory_files_per_directory")

LIMIT_DIRECTORY_INGEST_DOWNLOAD_SIZE_BYTES("limit_directory_ingest_download_size_bytes")

LIMIT_DIRECTORY_INGEST_FILES("limit_directory_ingest_files")

LIMIT_DIRECTORY_SYNC_PLAN_ACTIONS("limit_directory_sync_plan_actions")

LIMIT_EMBEDDING_CHARACTER("limit_embedding_character")

LIMIT_FILES_PER_INDEX("limit_files_per_index")

LIMIT_MAX_MONTHLY_INVOICE_TOTAL_USD_CENTS("limit_max_monthly_invoice_total_usd_cents")

LIMIT_MONTHLY_USAGE_CREDITS("limit_monthly_usage_credits")

LIMIT_PROJECTS("limit_projects")

LIMIT_SPLIT_CATEGORIES("limit_split_categories")

LIMIT_TOTAL_FILE_COUNT("limit_total_file_count")

LIMIT_TOTAL_FILE_STORAGE_BYTES("limit_total_file_storage_bytes")

LIMIT_USERS("limit_users")

RATE_LIMIT_BATCH_API_CREATION("rate_limit_batch_api_creation")

RATE_LIMIT_CHAT_API_MESSAGE("rate_limit_chat_api_message")

RATE_LIMIT_CLASSIFY_API_CREATION("rate_limit_classify_api_creation")

RATE_LIMIT_CLASSIFY_API_LIST("rate_limit_classify_api_list")

RATE_LIMIT_CLASSIFY_API_QUERY("rate_limit_classify_api_query")

RATE_LIMIT_CONCURRENT_JOBS_IN_EXECUTION_DEFAULT("rate_limit_concurrent_jobs_in_execution_default")

RATE_LIMIT_CONCURRENT_JOBS_IN_EXECUTION_DOC_INGEST("rate_limit_concurrent_jobs_in_execution_doc_ingest")

RATE_LIMIT_CONCURRENT_JOBS_IN_EXECUTION_METADATA_UPDATE("rate_limit_concurrent_jobs_in_execution_metadata_update")

RATE_LIMIT_DEFAULT_API_READ("rate_limit_default_api_read")

RATE_LIMIT_DEFAULT_API_WRITE("rate_limit_default_api_write")

RATE_LIMIT_DIRECTORY_FILE_API_READ("rate_limit_directory_file_api_read")

RATE_LIMIT_DIRECTORY_FILE_API_WRITE("rate_limit_directory_file_api_write")

RATE_LIMIT_DIRECTORY_INGEST_PROJECT_JOB_CREATION("rate_limit_directory_ingest_project_job_creation")

RATE_LIMIT_EXTRACT_AGENT_CREATION("rate_limit_extract_agent_creation")

RATE_LIMIT_EXTRACT_API_CREATION("rate_limit_extract_api_creation")

RATE_LIMIT_EXTRACT_API_LIST("rate_limit_extract_api_list")

RATE_LIMIT_EXTRACT_API_QUERY("rate_limit_extract_api_query")

RATE_LIMIT_EXTRACT_CONCURRENT_DEFAULT("rate_limit_extract_concurrent_default")

RATE_LIMIT_FILE_API_READ("rate_limit_file_api_read")

RATE_LIMIT_FILE_API_WRITE("rate_limit_file_api_write")

RATE_LIMIT_INDEX_V1_PIPELINE_CONCURRENT_JOBS("rate_limit_index_v1_pipeline_concurrent_jobs")

RATE_LIMIT_PARSE_API_CREATION("rate_limit_parse_api_creation")

RATE_LIMIT_PARSE_API_LIST("rate_limit_parse_api_list")

RATE_LIMIT_PARSE_API_QUERY("rate_limit_parse_api_query")

RATE_LIMIT_PARSE_CONCURRENT_DEFAULT("rate_limit_parse_concurrent_default")

RATE_LIMIT_PARSE_CONCURRENT_PAGES_AGENTIC("rate_limit_parse_concurrent_pages_agentic")

RATE_LIMIT_PARSE_CONCURRENT_PAGES_AGENTIC_PLUS("rate_limit_parse_concurrent_pages_agentic_plus")

RATE_LIMIT_PARSE_CONCURRENT_PAGES_COST_EFFECTIVE("rate_limit_parse_concurrent_pages_cost_effective")

RATE_LIMIT_PARSE_CONCURRENT_PREMIUM("rate_limit_parse_concurrent_premium")

RATE_LIMIT_PARSE_TOKEN_BUCKET_AGENTIC("rate_limit_parse_token_bucket_agentic")

RATE_LIMIT_PARSE_TOKEN_BUCKET_AGENTIC_PLUS("rate_limit_parse_token_bucket_agentic_plus")

RATE_LIMIT_PARSE_TOKEN_BUCKET_COST_EFFECTIVE("rate_limit_parse_token_bucket_cost_effective")

RATE_LIMIT_PARSE_TOKEN_BUCKET_UNKNOWN_TIER("rate_limit_parse_token_bucket_unknown_tier")

RATE_LIMIT_PROJECT_CONCURRENT_JOBS("rate_limit_project_concurrent_jobs")

RATE_LIMIT_PROJECT_CONCURRENT_TURBO_JOBS("rate_limit_project_concurrent_turbo_jobs")

RATE_LIMIT_SPLIT_API_CREATION("rate_limit_split_api_creation")

RATE_LIMIT_SPLIT_API_QUERY("rate_limit_split_api_query")

RATE_LIMIT_SPREADSHEET_API_LIST("rate_limit_spreadsheet_api_list")

RATE_LIMIT_SPREADSHEET_API_QUERY("rate_limit_spreadsheet_api_query")

RATE_LIMIT_SPREADSHEET_CREATION("rate_limit_spreadsheet_creation")

RATE_LIMIT_USAGE_API_QUERY("rate_limit_usage_api_query")

RATE_LIMIT_VERIFY_API_CREATION("rate_limit_verify_api_creation")

RATE_LIMIT_VERIFY_API_LIST("rate_limit_verify_api_list")

RATE_LIMIT_VERIFY_API_QUERY("rate_limit_verify_api_query")

ConfigurationValue configurationValue

The quota configuration value

long numerator

The rate numerator

Optional<Long> denominator

The rate limit denominator

Optional<DenominatorUnits> denominatorUnits

The default rate limit denominator units

One of the following:

DAY("day")

HOUR("hour")

MINUTE("minute")

SECOND("second")

String sourceId

The source ID, e.g. the organization ID

SourceType sourceType

The source type, e.g. ‘organization’

One of the following:

GLOBAL("GLOBAL")

ORGANIZATION("organization")

PLAN_TIER("plan_tier")

PROJECT("project")

Status status

The status of the quota, i.e. ‘ACTIVE’ or ‘INACTIVE’

One of the following:

ACTIVE("ACTIVE")

INACTIVE("INACTIVE")

Optional<String> id

The system-generated UUID for the quota

formatuuid

Optional<LocalDateTime> createdAt

The creation date of the quota configuration in the database

formatdate-time

Optional<LocalDateTime> endedAt

The end date of the quota

formatdate-time

Optional<String> idempotencyKey

The idempotency key

Optional<LocalDateTime> startedAt

The start date of the quota

formatdate-time

Optional<LocalDateTime> updatedAt

The last updated date of the quota configuration in the database

formatdate-time

Create a quota configuration

Java

HTTP

TypeScript

Python

Go

Java

package ai.llamaindex.llamacloudadmin.example;

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import ai.llamaindex.llamacloudadmin.models.quotamanagement.QuotaConfiguration;
import ai.llamaindex.llamacloudadmin.models.quotamanagement.QuotaManagementCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.fromEnv();

        QuotaManagementCreateParams params = QuotaManagementCreateParams.builder()
            .organizationId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .setting(QuotaManagementCreateParams.Setting.ALLOW_PAY_AS_YOU_GO)
            .value(0L)
            .build();
        QuotaConfiguration quotaConfiguration = client.quotaManagement().create(params);
    }
}

200 example

{
  "configuration_metadata": {
    "foo": "bar"
  },
  "configuration_type": "allow_pay_as_you_go",
  "configuration_value": {
    "numerator": 0,
    "denominator": 0,
    "denominator_units": "day"
  },
  "source_id": "source_id",
  "source_type": "GLOBAL",
  "status": "ACTIVE",
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "ended_at": "2019-12-27T18:11:19.117Z",
  "idempotency_key": "idempotency_key",
  "started_at": "2019-12-27T18:11:19.117Z",
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

200 example

{
  "configuration_metadata": {
    "foo": "bar"
  },
  "configuration_type": "allow_pay_as_you_go",
  "configuration_value": {
    "numerator": 0,
    "denominator": 0,
    "denominator_units": "day"
  },
  "source_id": "source_id",
  "source_type": "GLOBAL",
  "status": "ACTIVE",
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "ended_at": "2019-12-27T18:11:19.117Z",
  "idempotency_key": "idempotency_key",
  "started_at": "2019-12-27T18:11:19.117Z",
  "updated_at": "2019-12-27T18:11:19.117Z"
}