Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rainbird Technologies Decisions API

Get decisions from your knowledge maps. **Start** a session, **inject** any available facts, run a **query**, provide a **response** to any questions asked and **undo** your answers to give a different response. **Note:** query, response and undo endpoints can all return *either* a **questionResponse** (the reasoning engine needs more information) *or* a **resultResponse** (the decision). Alternatively you can **interact** with the reasoning engine via natural language. This is in beta, is subject to change and responses may vary due to natural language interpretation.

Rainbird Technologies Decisions API is one of 3 APIs that Rainbird Technologies publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Decisions. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 6 operations across 6 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 1.2.0.

Requests are made against 2 base URLs: https://api.rainbird.ai, https://enterprise-api.rainbird.ai.

6 operations 6 paths 12 schemas 1 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.2.0
Base URL
https://api.rainbird.ai
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Rainbird Technologies Decisions API declares 3 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (apiKey). An API key is passed in the header as x-evidence-key (evidenceKey). An API key is passed in the header as x-interaction-key (interactionKey).

  • apiKey — Authentication with the Rainbird API uses a user key, passed in the header. This can be found on the Account page or with the controls for [publishing a Knowle…
  • evidenceKey — To access secured evidence, you should pass your evidence key
  • interactionKey — To access secured interaction logs, you should pass your interaction key

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 1 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Decisions 6

Get decisions from your knowledge maps. Start a session, inject any available facts, run a query, provide a response to any questions asked and undo your answers to give a differe…

GET
/start/{kmID}
Start - Start a new session
start 3 params → 200
POST
/{sessionID}/inject
Inject - Inject facts into a session
inject 1 param body → 200
POST
/{sessionID}/query
Query - Query a running session
query 1 param body → 200
POST
/{sessionID}/response
Response - Respond with an answer to a question
response 1 param body → 200
POST
/{sessionID}/undo
Undo - Undoes the previous answer
undo 1 param body → 200
POST
/nl/interact
Interact (BETA) - natural language injection, queries and question responses
interact 1 param body → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Question (14 properties), NLMetadata (6 properties), NLError (4 properties), ResultResponse (4 properties). Each schema is shown below with its type and property counts.

Question
object
A question object that needs a response
14 properties
QuestionResponse
object
A question the engine wants answered
4 properties 2 required
Object
The object side concept instance or value
Certainty
number
How certain this fact or answer is
NLError
object
Error for the natural language endpoints
4 properties
NLMetadata
object
Metadata for the natural language endpoints
6 properties
Relationship
string
The relationship between subject and object
ResultResponse
object
The engine is providing results
4 properties 2 required
Subject
string
The subject side concept instance or value
Prompt
string
User interaction required for further processing
CanAdd
boolean
Whether further objects can be added to the query
KnownAnswers
array
An array of objects that have been answered

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rainbird-technologies-decisions-api-openapi.yml Raw ↑

Other APIs Rainbird Technologies publishes across the network.

Rainbird Technologies Evidence API
Rainbird Technologies Platform API