Building an Evidence Tree URL

Within the Rainbird Studio access is provided to a visual representation of the Evidence Tree.

Whilst this is designed primarily for Rainbird Authors, rather than end-users, some clients wants to store a link to the Evidence Tree alongside query results within their own systems for audit purposes.

Where this is necessary Evidence Tree URL can be programmatically built with the following data:

• URL structure

• Hostname

• Fact ID

• Session ID

URL Structure

The Evidence Tree app URL is structured as follows:

[STUDIO_HOSTNAME]/evidence:id=[FACT_ID]&api=[API_HOSTNAME]&sid=[SESSION_ID]

Hostname

The following details the Studio and API hostname for some of our environments:

Environment	Studio hostname	API hostname
Community	https://app.rainbird.ai	https://api.rainbird.ai
Enterprise (UK & Europe)	https://enterprise.rainbird.ai	https://enterprise-api.rainbird.ai
Enterprise (South America)	https://sa-enterprise.rainbird.ai	https://sa-enterprise-api.rainbird.ai
Example private environment	https://clientname.rainbird.ai	https://clientname-api.rainbird.ai

An example for Enterprise (UK & Europe) would be:

https://enterprise.rainbird.ai/evidence?id=[FACT_ID]&api=https://enterprise-api.rainbird.ai&sid=[SESSION_ID]

Fact ID

The ID used to fetch the evidence tree that lead to this decision. Received in the resultResponse for each object in the result array. i.e. if there are multiple results to a query, there will be a Fact ID for each result.

Session ID

The ID for the session in which the results are provided. Received from the /start request.

Evidence Security

In order to ensure the Evidence Tree can be accessed via the URL a method to pass the evidence key in the header needs to be established, or link sharing needs to be enabled.

Further information on this can be found in the Evidence Tree section.