search
Contact support

Researcher Command Line Interface

hashtag
Download Unix installer script

get

This endpoint returns a unix script that can be used to install the Run:ai CLI.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
chevron-right
200

File download successful

text/plain
stringOptional
get
/api/v1/cli-exposer/installer/unix

hashtag
Get Unix installer script commands

get

This endpoint returns a unix script commands that can be used to install the Run:ai CLI.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
chevron-right
200

A text commands to install the CLI on Unix

application/json
commandstring · min: 1 · max: 200Required

The commands that can be used to install the Run:ai CLI.

Example: runai version
get
/api/v1/cli-exposer/installer/unix/commands

hashtag
Download Mac installer script

get

This endpoint returns a Mac script that can be used to install the Run:ai CLI.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
chevron-right
200

File download successful

text/plain
stringOptional
get
/api/v1/cli-exposer/installer/mac

hashtag
Get Mac installer script commands

get

This endpoint returns a Mac script commands that can be used to install the Run:ai CLI.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
chevron-right
200

A text commands to install the CLI on Mac

application/json
commandstring · min: 1 · max: 200Required

The commands that can be used to install the Run:ai CLI.

Example: runai version
get
/api/v1/cli-exposer/installer/mac/commands

hashtag
Download Linux installer script

get

This endpoint returns a Linux script that can be used to install the Run:ai CLI.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
chevron-right
200

File download successful

text/plain
stringOptional
get
/api/v1/cli-exposer/installer/linux

hashtag
Get Linux installer script commands

get

This endpoint returns a linux script commands that can be used to install the Run:ai CLI.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
chevron-right
200

A text commands to install the CLI on Linux

application/json
commandstring · min: 1 · max: 200Required

The commands that can be used to install the Run:ai CLI.

Example: runai version
get
/api/v1/cli-exposer/installer/linux/commands

hashtag
Get Windows MSI installer script commands

get

This endpoint returns a windows script commands that can be used to install the Run:ai CLI.

Authorizations
AuthorizationstringRequired

Bearer authentication

Responses
chevron-right
200

A text commands to install the CLI on Windows

application/json
commandstring · min: 1 · max: 200Required

The commands that can be used to install the Run:ai CLI.

Example: runai version
get
/api/v1/cli-exposer/installer/windows/commands

hashtag
Download RunAI Researcher command line binary

get

This endpoint returns a binary file that run the Run:ai CLI.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
operatingSystemstring · enum · min: 4 · max: 7Required

The operating system name.

Example: linuxPossible values:
architecturestring · min: 4 · max: 10Required

The architecture type.

Example: arm64
Responses
chevron-right
200

File download successful

application/octet-stream
string · binaryOptional
get
/api/v1/cli-exposer/dist/{operatingSystem}/{architecture}/runai

hashtag
Get CLI document by name

get

This endpoint returns a document of help for the Run:ai CLI.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
documentNamestring · min: 4 · max: 255Required

The manual document name.

Example: runai.mdPattern: ^[A-Za-z0-9_]+\.md$
Responses
chevron-right
200

Executed successfully.

text/html
stringOptional
get
/api/v1/cli-exposer/docs/{documentName}
PreviousLogoNextResearcher Command Line Interface Deprecated

Last updated