Platform API usage

The Timefold Platform API provides management capabilities across the entire platform. It is distinct from the model APIs, which are per-model, solve-focused APIs used to submit datasets and retrieve results.

Use the Platform API when you need to automate or integrate with platform administration like configuring external map providers, or managing location sets. Model APIs, by contrast, use API keys for authentication and support only a single model’s solve operations. See Model API usage for details on model API authentication and usage.

Use cases

The Platform API covers several areas of platform administration, like:

  • External map provider registration: register and configure third-party map providers as an alternative to the built-in OSRM service. See Implementing an external map provider for details on what an external provider must implement, and Registering an external map provider for how to register one.

  • Location sets management: create and manage named sets of locations to pre-compute and cache distance matrices, avoiding redundant recalculation across runs. See Location sets configuration for details.

  • Configuration profiles management: list, create, update, and delete configuration profiles for a model. Configuration profiles let you predefine model settings such as termination conditions, resource allocation, and constraint weights without modifying the model itself. See Configuration profiles and parameters for a full explanation.

The Platform API covers administration endpoints only. Operations such as submitting datasets, querying audit logs, managing tenants or members, and provisioning API keys are available through separate model APIs. See the model API documentation for solve operations.

API specification

The Platform API is fully described in OpenAPI format:

Authentication with Personal Access Tokens

The Platform API uses Personal Access Tokens (PATs) for authentication. PATs are scoped by tenant and resource permission, giving you fine-grained control over what each token can access.

Include the token in the Authorization header of each request:

Authorization: Bearer <your-personal-access-token>

Unlike API keys, which are tenant-level credentials tied to model access, PATs are personal and belong to the user who created them.

See Personal access tokens for how to generate a PAT in the platform UI, and for the token permissions you can grant.