api.md

layout	title	permalink
page	Knapsack Pro API	/api/

API documentation

Here you can find API documentation for Regular Mode and Queue Mode. The API documentation might be useful if you want to build a client library to directly integrate with Knapsack Pro API.

Preview API v1 documentation

How API works

You can learn how Knapsack Pro API works from the below videos or reading the article showing the difference between Regular Mode and Queue Mode.

• Regular Mode - deterministic tests split across parallel CI nodes.
  Docs: How knapsack_pro gem works in Regular Mode.
• Queue Mode - dynamic tests split across parallel CI nodes.
  Docs: How knapsack_pro gem works in Queue Mode.

How to build native integration with API

• JavaScript: How to build native integration with Knapsack Pro API to run tests in parallel for any test runner (testing framework)
• Any programming language: How to build a custom Knapsack Pro API client from scratch in any programming language

How to export data from API

You may also find a useful article with examples of how to extract timing data for recorded CI builds using API.