Skip to main content

bellator-si-python

Bellator Schedule Intelligence APIs - Stateless Schedule Health APIs

## Features

* **Schedule Analysis** - Comprehensive schedule health analysis
* **Critical Path** - CPM-based critical path calculation
* **Validation** - Schedule validation and quality checks
* **Future: Resource Management** - Resource allocation and leveling
* **Future: Simulation** - Monte Carlo and what-if analysis
* **Future: AI Recommendations** - LLM-powered optimization suggestions

## Authentication

API key authentication via `x-api-key` header or OAuth 2.0 Bearer token via `Authorization` header.

### API Key Authentication (Legacy)
Include API key in `x-api-key` header.

### OAuth 2.0 / Azure AD Authentication (Recommended)
Include Bearer token in `Authorization` header: `Authorization: Bearer <token>`

Tiers:
- **Free**: 2,000 tasks, 100 req/min, 5MB payload
- **Professional**: 5,000 tasks, 500 req/min, 25MB payload
- **Enterprise**: 50,000 tasks, 2,000 req/min, 100MB payload
- **Government**: 100,000+ tasks, 10,000 req/min, 500MB payload

## Usage Metering

All API requests are metered and tracked for:
- Request duration (milliseconds)
- Task count processed
- Token consumption (for LLM operations)
- Estimated cost (USD)

Metering events are emitted to logs and can be integrated with billing systems.

## Security

* Tier-based task limits (500-100,000 tasks per request)
* Tier-based payload limits (5-500 MB)
* Input validation and sanitization
* Tier-based rate limiting (100-10,000 requests per 60 seconds)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.4.0
  • Package version: 0.4.0
  • Generator version: 7.18.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import bellator_si

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import bellator_si

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import bellator_si
from bellator_si.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.bellatorsi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = bellator_si.Configuration(
    host = "https://api.bellatorsi.com"
)



# Enter a context with an instance of the API client
with bellator_si.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bellator_si.APIKeysApi(api_client)

    try:
        # Generate Agent Ephemeral Key
        api_response = api_instance.generate_agent_key_api_v1_keys_ephemeral_generate_agent_post()
        print("The response of APIKeysApi->generate_agent_key_api_v1_keys_ephemeral_generate_agent_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIKeysApi->generate_agent_key_api_v1_keys_ephemeral_generate_agent_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.bellatorsi.com

Class Method HTTP request Description
APIKeysApi generate_agent_key_api_v1_keys_ephemeral_generate_agent_post POST /api/v1/keys/ephemeral/generate/agent Generate Agent Ephemeral Key
APIKeysApi generate_ephemeral_key_api_v1_keys_ephemeral_generate_post POST /api/v1/keys/ephemeral/generate Generate Ephemeral API Key
APIKeysApi get_key_info_api_v1_keys_ephemeral_info_get GET /api/v1/keys/ephemeral/info Get Key Usage Info
APIKeysApi revoke_key_api_v1_keys_ephemeral_revoke_delete DELETE /api/v1/keys/ephemeral/revoke Revoke Ephemeral Key
AccountApi get_account_tier_api_v1_account_tier_get GET /api/v1/account/tier Get current API tier and limits
AnalysisApi analysis_cpm POST /api/v1/analysis/cpm Calculate Critical Path
AnalysisApi analysis_cpm_async POST /api/v1/analysis/cpm/async Calculate Critical Path (Async)
AnalysisApi analysis_resources POST /api/v1/analysis/resources Resource Analysis
AnalysisApi analysis_resources_async POST /api/v1/analysis/resources/async Resource Analysis (Async)
AnalysisApi analysis_validate POST /api/v1/analysis/validate Validate Schedule
AuthenticationApi create_api_key_api_v1_auth_keys_post POST /api/v1/auth/keys Create Api Key
AuthenticationApi delete_account_api_v1_auth_account_delete DELETE /api/v1/auth/account Delete Account
AuthenticationApi get_user_profile_api_v1_auth_profile_get GET /api/v1/auth/profile Get User Profile
AuthenticationApi list_api_keys_api_v1_auth_keys_get GET /api/v1/auth/keys List Api Keys
AuthenticationApi oauth_callback_api_v1_auth_callback_get GET /api/v1/auth/callback Oauth Callback
AuthenticationApi options_delete_account_api_v1_auth_account_options OPTIONS /api/v1/auth/account Options Delete Account
AuthenticationApi options_keys_api_v1_auth_keys_options OPTIONS /api/v1/auth/keys Options Keys
AuthenticationApi options_revoke_key_api_v1_auth_keys_key_id_options OPTIONS /api/v1/auth/keys/{key_id} Options Revoke Key
AuthenticationApi revoke_api_key_api_v1_auth_keys_key_id_delete DELETE /api/v1/auth/keys/{key_id} Revoke Api Key
AuthenticationApi signup_user_api_v1_auth_signup_post POST /api/v1/auth/signup Signup User
AuthenticationApi update_api_key_label_api_v1_auth_keys_key_id_label_patch PATCH /api/v1/auth/keys/{key_id}/label Update Api Key Label
BillingApi azure_marketplace_webhook_api_v1_billing_azure_marketplace_webhook_post POST /api/v1/billing/azure-marketplace/webhook Azure Marketplace Webhook
BillingApi azure_marketplace_webhook_api_v1_billing_azure_marketplace_webhook_post_0 POST /api/v1/billing/azure-marketplace/webhook Azure Marketplace Webhook
BillingApi create_checkout_session_api_v1_billing_checkout_post POST /api/v1/billing/checkout Create Stripe Checkout Session for Starter tier
BillingApi create_portal_session_api_v1_billing_portal_post POST /api/v1/billing/portal Create Stripe Customer Portal Session
BillingApi export_overage_settlement_api_v1_billing_settlement_overage_export_get GET /api/v1/billing/settlement/overage-export Export Overage Settlement
BillingApi export_overage_settlement_api_v1_billing_settlement_overage_export_get_0 GET /api/v1/billing/settlement/overage-export Export Overage Settlement
BillingApi reconcile_checkout_session_api_v1_billing_checkout_reconcile_post POST /api/v1/billing/checkout/reconcile Reconcile completed Stripe checkout session
ContactFormApi get_email_diagnostics_api_v1_contact_email_diagnostics_get GET /api/v1/contact/email/diagnostics Get contact email diagnostics
ContactFormApi get_submission_types_api_v1_contact_submission_types_get GET /api/v1/contact/submission-types Get available submission types
ContactFormApi get_waitlist_types_api_v1_contact_waitlist_types_get GET /api/v1/contact/waitlist-types Get available waitlist types
ContactFormApi submit_contact_form_api_v1_contact_submit_post POST /api/v1/contact/submit Submit contact form
FeedbackApi submit_page_feedback_api_v1_feedback_page_post POST /api/v1/feedback/page Submit docs page helpfulness feedback
FeedbackApi submit_playground_feedback_api_v1_feedback_post POST /api/v1/feedback Submit playground feedback
ForensicsApi as_planned_vs_as_built_api_v1_forensics_as_planned_vs_as_built_post POST /api/v1/forensics/as-planned-vs-as-built As-Planned vs. As-Built Comparison
ForensicsApi as_planned_vs_as_built_async_api_v1_forensics_as_planned_vs_as_built_async_post POST /api/v1/forensics/as-planned-vs-as-built/async As-Planned vs. As-Built Comparison (Async)
ForensicsApi baseline_compare_api_v1_forensics_baseline_compare_post POST /api/v1/forensics/baseline-compare Baseline Variance Analysis
ForensicsApi baseline_compare_async_api_v1_forensics_baseline_compare_async_post POST /api/v1/forensics/baseline-compare/async Baseline Variance Analysis (Async)
ForensicsApi change_tracking_api_v1_forensics_change_tracking_post POST /api/v1/forensics/change-tracking Time-Series Change Detection
ForensicsApi change_tracking_async_api_v1_forensics_change_tracking_async_post POST /api/v1/forensics/change-tracking/async Time-Series Change Detection (Async)
ForensicsApi delay_analysis_api_v1_forensics_delay_analysis_post POST /api/v1/forensics/delay-analysis Delay Attribution Analysis
ForensicsApi delay_analysis_async_api_v1_forensics_delay_analysis_async_post POST /api/v1/forensics/delay-analysis/async Delay Attribution Analysis (Async)
HealthApi health_check_health_get GET /health Health Check
ImportApi import_mpp_api_v1_import_mpp_post POST /api/v1/import/mpp Import MS Project XML Schedule
ImportApi import_xer_api_v1_import_xer_post POST /api/v1/import/xer Import Primavera P6 XER Schedule
InfrastructureApi infrastructure_health_api_v1_infrastructure_health_get GET /api/v1/infrastructure/health Infrastructure Health
InfrastructureApi redis_health_check_api_v1_infrastructure_health_redis_get GET /api/v1/infrastructure/health/redis Redis Health Check
JobsApi cancel_async_job_api_v1_jobs_job_id_cancel_post POST /api/v1/jobs/{job_id}/cancel Cancel Job
JobsApi delete_job_api_v1_jobs_job_id_delete DELETE /api/v1/jobs/{job_id} Delete Job
JobsApi get_async_job_status_api_v1_jobs_job_id_get GET /api/v1/jobs/{job_id} Get Job Status
MCPApi invoke_tool_mcp_tools_tool_name_post POST /mcp/tools/{tool_name} Invoke Tool
MCPApi list_mcp_tools_mcp_tools_get GET /mcp/tools List Mcp Tools
MCPApi mcp_streamable_delete_mcp_delete DELETE /mcp Mcp Streamable Delete
MCPApi mcp_streamable_get_mcp_get GET /mcp Mcp Streamable Get
MCPApi mcp_streamable_post_mcp_post POST /mcp Mcp Streamable Post
ResourceManagementApi allocate_resources_api_v1_resources_allocate_post POST /api/v1/resources/allocate Allocate Resources (Placeholder)
ResourceManagementApi level_resources_api_v1_resources_level_post POST /api/v1/resources/level Resource Leveling (Placeholder)
RootApi root_get GET / Root
SandboxApi list_sandbox_fixtures_api_v1_sandbox_fixtures_get GET /api/v1/sandbox/fixtures List Sandbox Fixtures
SimulationAnalysisApi run_monte_carlo_api_v1_simulation_monte_carlo_post POST /api/v1/simulation/monte-carlo Monte Carlo Simulation (Placeholder)
SimulationAnalysisApi run_what_if_api_v1_simulation_what_if_post POST /api/v1/simulation/what-if What-If Analysis (Placeholder)
UsageQuotaApi export_usage_api_v1_usage_export_get GET /api/v1/usage/export Export Usage
UsageQuotaApi get_key_usage_api_v1_usage_keys_key_id_get GET /api/v1/usage/keys/{key_id} Get Key Usage
UsageQuotaApi get_my_usage_api_v1_usage_me_get GET /api/v1/usage/me Get My Usage
ComplianceApi get_compliance_metadata_api_v1_compliance_metadata_get GET /api/v1/compliance/metadata Get Compliance Metadata
ComplianceApi get_function_compliance_metadata_api_v1_compliance_metadata_function_name_get GET /api/v1/compliance/metadata/{function_name} Get Function Compliance Metadata
HealthApi calculate_health_score_api_v1_health_score_post POST /api/v1/health/score Calculate Schedule Health Score
HealthApi health_dcma14_point POST /api/v1/health/dcma-14-point DCMA 14-Point Assessment
HealthApi health_dcma14_point_async POST /api/v1/health/dcma-14-point/async DCMA 14-Point Assessment (Async)
HealthApi health_dcma_decm POST /api/v1/health/dcma-decm DCMA DECM Assessment
HealthApi health_dcma_decm_async POST /api/v1/health/dcma-decm/async DCMA DECM Assessment (Async)
HealthApi health_logic_audit POST /api/v1/health/logic-audit Logic Audit
HealthApi health_logic_audit_async POST /api/v1/health/logic-audit/async Logic Audit (Async)
HealthApi health_planning_horizon POST /api/v1/health/planning-horizon Planning Horizon
HealthApi health_planning_horizon_async POST /api/v1/health/planning-horizon/async Planning Horizon (Async)
HealthApi health_progress_audit POST /api/v1/health/progress-audit Progress Audit
HealthApi health_progress_audit_async POST /api/v1/health/progress-audit/async Progress Audit (Async)
HealthApi health_schedule_risk_index POST /api/v1/health/schedule-risk-index Schedule Risk Index
HealthApi health_schedule_risk_index_async POST /api/v1/health/schedule-risk-index/async Schedule Risk Index (Async)
HealthApi submit_async_health_score_api_v1_health_score_async_post POST /api/v1/health/score/async Submit Async Health Score Job
WebhooksApi delete_webhook_registration_api_v1_webhooks_registration_delete DELETE /api/v1/webhooks/registration Delete Webhook Registration
WebhooksApi get_delivery_status_api_v1_webhooks_deliveries_webhook_id_get GET /api/v1/webhooks/deliveries/{webhook_id} Get Delivery Status
WebhooksApi get_dlq_api_v1_webhooks_dlq_get GET /api/v1/webhooks/dlq Get Dead Letter Queue
WebhooksApi get_job_deliveries_api_v1_webhooks_deliveries_job_job_id_get GET /api/v1/webhooks/deliveries/job/{job_id} Get Job Deliveries
WebhooksApi get_webhook_registration_api_v1_webhooks_registration_get GET /api/v1/webhooks/registration Get Webhook Registration
WebhooksApi register_webhook_api_v1_webhooks_register_post POST /api/v1/webhooks/register Register Webhook

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

OAuth2

BearerAuth

  • Type: Bearer authentication (JWT)

Author

Metadata

Release files for bellator-si 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bellator-si 0.4.0
File Size Uploaded
bellator_si-0.4.0.tar.gz 267.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for bellator-si 0.4.0
File Interpreter ABI Platform
bellator_si-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 970.1 kB

Release files / bellator_si-0.4.0.tar.gz

Download URL bellator_si-0.4.0.tar.gz
Size 267.8 kB
Tags Source
SHA-256 checksum
How to use checksums
b8f8326ab6a5b77f48ef9091b97059be71d3cda4ea1ba5ba2f8f06f41a3eee81
BLAKE2b-256 checksum
How to use checksums
877640f9e25ce5d33b9a5288a4042d5ee481c57e190c2abb91a4a854a159f47a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release files / bellator_si-0.4.0-py3-none-any.whl

Download URL bellator_si-0.4.0-py3-none-any.whl
Size 702.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0eaafcd41badbbb134fcbc72141993215ecde61c46cc27fb3699d434db1b8f77
BLAKE2b-256 checksum
How to use checksums
9c734ec21f67668554d76f1f0d9c3e2c3085c357fb419ba0353f36925bc57f61
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page