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

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

Polling

Polling means your application periodically GETs the dataset metadata and checks the solverStatus field until it reaches SOLVING_COMPLETED, SOLVING_FAILED, or SOLVING_INCOMPLETE.

Use polling only when neither Webhooks nor Server sent events (SSE) are viable, for example, if your application runs in an environment where outbound streaming connections aren’t supported.

The main drawback is that polling creates unnecessary load and introduces latency proportional to your poll interval. If you do poll, use a backoff strategy: start with a short interval and increase it for longer-running solves rather than polling at a fixed rate.

In production, we recommend configuring Webhooks to retrieve the solutions to your submitted datasets from Timefold.

In local development environments, we recommend Server sent events (SSE), however, when server sent events are not possible, you can poll Timefold.

Configuring polling

To poll for the solution to a dataset, use the dataset ID from the response to the POST operation and make a GET request to the following endpoint:

/v1/{model-entity-name}/<ID>/metadata

  • Replace <ID> with the dataset ID.

  • For field service routing and pick-up and delivery routing, replace {model-entity-name} with route-plans.

  • For employee shift scheduling, replace {model-entity-name} with schedules.

Read dataset lifecycle to know which statuses exist and which ones are final.

See Webhooks for more information.

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