Ensemble public REST API

Using Ensemble's public API, you can programmatically perform many of the same tasks as you can in the GUI. This section introduces Ensemble's REST API, including:

• How to authenticate
• Paginating results
• Endpoint reference

Ensemble provides an Ensemble API node to access the API in your pathways.

Learn about REST APIs

The API documentation assumes you are familiar with REST APIs. If you're not, these resources may be helpful:

• KnowledgeOwl's guide to working with APIs: a basic introduction, including examples of how to call REST APIs.
• IBM Cloud Learn Hub - What is an Application Programming Interface (API): this gives a general, but technical, introduction to APIs.
• IBM Cloud Learn Hub - What is a REST API?: more detailed information about REST APIs.
• MDN web docs - An overview of HTTP: REST APIs work over HTTP, and use HTTP verbs, or methods, to indicate the type of action to perform.

Use the API playground (self-hosted ensemble only)

Trying out the API in the playground can help you understand how APIs work. If you're worried about changing live data, consider setting up a test workflow, or test ensemble instance, to explore safely.