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 Evidence API

Access the facts, information and the chain of reasoning that led to a decision

Rainbird Technologies Evidence 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 Evidence. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 4 operations across 4 paths, and defines 18 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.

4 operations 4 paths 18 schemas 3 GET1 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 Evidence 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 4

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

Evidence 4

Access the facts, information and the chain of reasoning that led to a decision

GET
/analysis/evidence/{factID}/{sessionID}
Evidence - Returns the evidence for a given fact
evidence 2 params → 200
GET
/analysis/interactions/{sessionID}
Interaction Log - Retrieves interaction events
interactions 2 params → 200
GET
/analysis/session/{sessionID}
Session - Returns session information
session 3 params → 200
POST
/nl/explain
Explain (BETA) - Returns a natural language explanation of the evidence tree
explain 1 param body → 200

Schemas 18

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

Certainty
number
How certain this fact or answer is
NLMetadata
object
Metadata for the natural language endpoints
6 properties
InteractionEventStart
object
Start event retrieved via the interaction log
1 property
Alt
string
Alternative Text for the condition displayed in the Evidence Tree
InteractionEventInject
object
Inject event retrieved via the interaction log
1 property
Subject
string
The subject side concept instance or value
Prompt
string
User interaction required for further processing
InteractionEventResults
object
Results event retrieved via the interaction log
1 property
Impact
number
The impact this condition has on the result as a percentage
Object
The object side concept instance or value
InteractionEventQuery
object
Query event retrieved via the interaction log
1 property
Relationship
string
The relationship between subject and object
InteractionEventDatasource
object
Datasource event retrieved via the interaction log
1 property
InteractionEventQuestions
object
Questions event retrieved via the interaction log
1 property
Salience
number
The weight of a condition
InteractionEventAnswers
object
Answers event retrieved via the interaction log
1 property
NLError
object
Error for the natural language endpoints
4 properties
WasMet
boolean
Whether the expression returned true or false when not assigned to a variable. Always returns true when assigned to a variable

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Rainbird Technologies publishes across the network.

Rainbird Technologies Decisions API
Rainbird Technologies Platform API