Version 2.21 has reached end of support. Upgrade to a newer supported version.
Ctrlk
Contact support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Researcher Command Line Interface Deprecated

Deprecated

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
200

File download successful

text/plain
stringOptional
get/api/v1/cli/installer/unix
GET /api/v1/cli/installer/unix HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Contents of the file
Deprecated

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
200

A text commands to install the CLI on Unix

application/json
commandstringRequired

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

Example: runai version
get/api/v1/cli/installer/unix/commands
GET /api/v1/cli/installer/unix/commands HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Contents of the commands to install the CLI on Unix
Deprecated

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
200

File download successful

text/plain
stringOptional
get/api/v1/cli/installer/mac
GET /api/v1/cli/installer/mac HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Contents of the file
Deprecated

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
200

A text commands to install the CLI on Mac

application/json
commandstringRequired

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

Example: runai version
get/api/v1/cli/installer/mac/commands
GET /api/v1/cli/installer/mac/commands HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Contents of the commands to install the CLI on Mac
Deprecated

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
200

File download successful

text/plain
stringOptional
get/api/v1/cli/installer/linux
GET /api/v1/cli/installer/linux HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Contents of the file
Deprecated

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
200

A text commands to install the CLI on Linux

application/json
commandstringRequired

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

Example: runai version
get/api/v1/cli/installer/linux/commands
GET /api/v1/cli/installer/linux/commands HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Contents of the commands to install the CLI on Linux
Deprecated

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
200

A text commands to install the CLI on Windows

application/json
commandstringRequired

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

Example: runai version
get/api/v1/cli/installer/windows/commands
GET /api/v1/cli/installer/windows/commands HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Contents of the commands to install the CLI on Windows
Deprecated

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: 4Required

The operating system name.

Example: linuxPossible values:
architecturestring · min: 4Required

The architecture type.

Example: arm64
Responses
200

File download successful

application/octet-stream
string · binaryOptional
get/api/v1/cli/dist/{operatingSystem}/{architecture}/runai
GET /api/v1/cli/dist/{operatingSystem}/{architecture}/runai HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Contents of the file
Deprecated

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: 4Required

The manual document name.

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

Executed successfully.

text/html
stringOptional
get/api/v1/cli/docs/{documentName}
GET /api/v1/cli/docs/{documentName} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text
PreviousResearcher Command Line InterfaceNextAdministrator Command Line Interface

Last updated