Skip to content

Researcher REST API

The purpose of the Researcher REST API is to provide an easy-to-use programming interface for submitting, listing, and deleting Jobs.

There are other APIs that provide the same functionality. Specifically:

Find the API Endpoint URL

If your installation is Self Hosted, your organization has created a DNS entry for the researcher service. If your installation is SaaS based, then the URL is composed of an IP address part and a port part (<IP-ADDRESS>:<PORT>). To find the endpoint, run:

echo "http://$(kubectl get nodes -o=jsonpath='{.items[0].status.addresses[0].address}'):$(kubectl get services -n runai -o=jsonpath='{.items[?(@.metadata.name == "researcher-service")].spec.ports[0].nodePort}')"

Authentication

By default, the Researcher REST API is not authenticated. At this point in time, when the system is configured to authenticate Researchers, the researcher API will not work. We are working to fix that.


Last update: August 23, 2021