A pool is the object you use to describe an open session on Qarnot's computing platform.

A pool is described by the following properties:

  • a UUID, to uniquely idenfity the pool
  • a name, so you can easily identify your pools when you use the API, one of our SDKs, or the console
  • a profile describing the nature of the pool (e.g Blender, Docker)
  • constants definitions (see profiles), used to parametrize the profile (e.g the blender file to render, the docker image to use, the command to execute, …)
  • a certain number of instances or a given range, describing how many instances should be kept open
  • input resources (one or several API buckets), that will be available for your tasks to use (see environment for further details on how to access them from your program)

During the execution, the pool will have other properties:

  • a state, among the following values. The order in which they are represented here also reflects the life cycle of the pool.
State Signification
Submitted The pool has been submitted
PartiallyDispatched Some instances have been dispatched to computing nodes, but none is running yet
FullyDispatched All your instances have been dispatched, but none is running yet
PartiallyExecuting Some instances of the pool are running, but some are still in queue
FullyExecuting All the remaining instances of the pool are running (some may have completed already)
Closing The pool is currently in the closing process.
Close The pool has been close by the user.
PendingDelete The pool is currently in the deletion process.
  • some details about the running instances, like:
    • CPU usage, nominal and actual frequency (see environment)
    • RAM size and usage
  • the cumulated CPU time (the one that is invoiced), and a human wall time from the pool creation


A pool is composed of one or several instances. Each instance will execute on its own computing node, and every instance will have the same profile, input data and constants.

Error handling

Pool failure

Pool can failed if your maximum simultaneous CPU is reached.


REST API error codes: If you encounter a REST API error, you can refer to the common errors page.

Next steps