Access the facts, information and the chain of reasoning that led to a decision
Evidence - Returns the evidence for a given fact
get
/analysis/evidence/{factID}/{sessionID}
View the source of the fact, including how it was derived when inferred from a rule.
Authorizations
Path parameters
factIDstringRequired
The factID for which to retrieve evidence
sessionIDstringRequired
The sessionID where the fact was created
Responses
200
Fact detail
application/json
get
/analysis/evidence/{factID}/{sessionID}
200
Fact detail
Interaction Log - Retrieves interaction events
get
/analysis/interactions/{sessionID}
View a log of interaction events within the session, including queries, injected facts, questions asked, answers given and results returned.
Note: interaction log recording is switched off by default. It must be enabled in the Studio per version per knowledge map. Only sessions started after it is enabled will be recorded.
Authorizations
Path parameters
sessionIDstringRequired
The session id to access the interaction logs
Query parameters
formatstringOptional
Format of the retrieved data. CSV or JSON
Responses
200
Interaction log detail
application/json
get
/analysis/interactions/{sessionID}
200
Interaction log detail
Session - Returns session information
get
/analysis/session/{sessionID}
Access session information, such as all of the facts available within a session, or version information for the knowledge map used in a session.
Authorizations
X-API-KeystringRequired
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 Knowledge Map.
Our legacy authentication method of HTTP BasicAuth continues to be supported, but we highly advise transitioning to the new method.
Path parameters
sessionIDstringRequired
The sessionID of the session
Query parameters
filterstring · enumOptional
The type of information requested - version or facts
Default: versionPossible values:
relationshipsstring[]Optional
A comma-separated list of relationships to filter the session data by.
Responses
200
Session detail
application/json
Responseone of
or
get
/analysis/session/{sessionID}
200
Session detail
Explain (BETA) - Returns a natural language explanation of the evidence tree
post
/nl/explain
Get a natural language explanation of the chain of reasoning for any given fact.
Authorizations
X-API-KeystringRequired
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 Knowledge Map.
Our legacy authentication method of HTTP BasicAuth continues to be supported, but we highly advise transitioning to the new method.
Header parameters
VersionstringRequired
Version of the natural language API
Default: v1
Body
languagestringRequired
The users preferred language setting i.e. "en", "za"
sessionIDstringRequired
The session ID needed to access that specific session
factIDstringRequired
The ID of a fact specific to that session to retrieve data from
{
"explanation": "Based on the information provided, Ben can claim for a repair. This decision is supported by several key facts:\n\nBen holds a Gold policy, which provides comprehensive coverage for his mobile phone. The Gold policy specifically covers water damage, which is the type of loss Ben has suffered. \n\nThe incident in question involves water damage to Ben's mobile phone. This aligns with the coverage provided by his Gold policy, as the policy explicitly insures mobile phones and covers water damage.\n\nIn response to this type of loss, a repair claim is deemed appropriate. The Gold policy includes provisions for repair claims, making this a suitable course of action for addressing the water damage to Ben's mobile phone.\n\nAll of these factors come together to support the conclusion that Ben is eligible to claim for a repair of his water-damaged mobile phone under his Gold policy.",
"metadata": {
"querySubmittedAt": "2025-07-10T11:16:12.597111859Z",
"languageEngineResponseTime": 5538,
"llmTokens": {
"completionTokens": 174,
"promptTokens": 726,
"totalTokens": 900
},
"apiVersion": "",
"endpoint": "explain",
"sessionID": "bdef015c-0ab4-417c-982f-b8d9ff48efc1"
}
}
