Researcher Command Line Interface Deprecated

Download Unix installer scriptDeprecated

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

SecuritybearerAuth

Responses

200

File download successful

400

Bad request.

401

Unauthorized

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/cli/installer/unix

Response samples

text/plain

Contents of the file

Get Unix installer script commandsDeprecated

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

SecuritybearerAuth

Responses

200

A text commands to install the CLI on Unix

400

Bad request.

401

Unauthorized

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/cli/installer/unix/commands

Response samples

application/json

"Contents of the commands to install the CLI on Unix"

Download Mac installer scriptDeprecated

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

SecuritybearerAuth

Responses

200

File download successful

400

Bad request.

401

Unauthorized

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/cli/installer/mac

Response samples

text/plain

Contents of the file

Get Mac installer script commandsDeprecated

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

SecuritybearerAuth

Responses

200

A text commands to install the CLI on Mac

400

Bad request.

401

Unauthorized

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/cli/installer/mac/commands

Response samples

application/json

"Contents of the commands to install the CLI on Mac"

Download Linux installer scriptDeprecated

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

SecuritybearerAuth

Responses

200

File download successful

400

Bad request.

401

Unauthorized

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/cli/installer/linux

Response samples

text/plain

Contents of the file

Get Linux installer script commandsDeprecated

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

SecuritybearerAuth

Responses

200

A text commands to install the CLI on Linux

400

Bad request.

401

Unauthorized

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/cli/installer/linux/commands

Response samples

application/json

"Contents of the commands to install the CLI on Linux"

Get Windows MSI installer script commandsDeprecated

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

SecuritybearerAuth

Responses

200

A text commands to install the CLI on Windows

400

Bad request.

401

Unauthorized

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/cli/installer/windows/commands

Response samples

application/json

"Contents of the commands to install the CLI on Windows"

Download RunAI Researcher command line binaryDeprecated

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

SecuritybearerAuth

Request

path Parameters

operatingSystem required	string >= 4 characters The operating system name. Enum: "linux" "windows" "darwin" Example: linux
architecture required	string >= 4 characters The architecture type. Example: arm64

Responses

200

File download successful

401

Unauthorized

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/cli/dist/{operatingSystem}/{architecture}/runai

Response samples

application/octet-stream

Contents of the file

Get CLI document by nameDeprecated

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

SecuritybearerAuth

Request

path Parameters

documentName

required

string >= 4 characters ^[A-Za-z0-9_]+\.md$

The manual document name.

Example: runai.md

Responses

200

Executed successfully.

401

Unauthorized

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/cli/docs/{documentName}

Response samples

application/json

{"code": 401,
"message": "Issuer is not familiar."
}

➔ Next to Administrator Command Line Interface