Docs
  • Solver
  • Models
    • Field Service Routing
    • Employee Shift Scheduling
    • Pick-up and Delivery Routing
  • Platform
Try models
  • Timefold Platform
  • API integration

Timefold Platform

    • Introduction
    • Scheduling API concepts
    • Getting started with the Timefold Platform
    • Platform concepts
    • Models
      • Model catalog and documentation
      • Model maturity and versioning
      • Trialing Timefold models
    • How-tos
      • Dataset lifecycle
      • Interpreting dataset results
      • Configuration parameters and profiles
      • Reviewing the audit log
      • Searching and categorizing datasets for auditability
      • Member management and roles
      • Secrets management
      • Solve queue
      • Using the maps service
      • Comparing datasets (preview)
      • Insights (preview)
      • Real-time planning with /from-patch (preview)
    • Job-oriented guides
      • Balancing different optimization goals
      • Validating an optimized plan with Explainable AI
      • Uncovering inefficiencies in operational planning
      • Responding to disruptions with real-time planning
      • Designing better routing plans with (just enough) traffic awareness
    • API integration
      • Model API usage
      • Receiving model API results
        • Webhooks
        • Server sent events (SSE)
        • Polling
      • Handling changes to your planning data
      • Integration scenarios
        • Multiple environments and clusters
        • Data residency requirements
        • Air-gapped environments
      • Platform API usage
    • Changelog
    • Feature requests
    • Self-Hosted
      • Self-Hosted vs. Timefold Cloud Platform
      • Installation instructions
      • Upgrade instructions
      • Troubleshooting
    • Support
      • Contacting support
      • Platform status
      • Troubleshooting
    • Trust
      • Risk profile
      • Product security
      • Data security
      • Legal and privacy
      • AI legislation compliance
      • Trust center

API integration

This section covers how to integrate your application with the Timefold Platform API. It explains how to authenticate and use the model APIs, how to receive asynchronous solver results, and how to structure your integration for scenarios such as multiple environments, data residency requirements, and air-gapped deployments.

Important to know

It’s important to keep the following in mind as you read through the deployment options and integration patterns.

Timefold Platform shouldn’t be your source of truth.

Datasets on the platform have a limited retention period. The platform supports patching datasets, but the authoritative version of your planning data should remain in your own systems. See Handling changes to your planning data for the recommended pattern.

Timefold Platform is independently certified.

Timefold is ISO 27001:2022 certified and holds a SOC 2 Type 2 attestation. GDPR is supported via a Data Processing Agreement. For Timefold’s position on the EU AI Act, see AI legislation compliance. The Timefold Trust Center hosts the ISO 27001 certificate, SOC 2 Letter of Attestation, the sub-processor list, and full audit reports under NDA.

Timefold Platform tenants have a resource cap.

When a tenant exceeds its concurrent capacity, additional requests are queued and started when capacity is available. Build this queueing behavior into your integration design.

  • © 2026 Timefold BV
  • Timefold.ai
  • Documentation
  • Changelog
  • Send feedback
  • Privacy
  • Legal
    • Light mode
    • Dark mode
    • System default