RAIDEN AI

API Docs

Sequence

Session

User

Commands Guide

Examples

MLB Data

Findings from papers & articles

Shell2 API

shell2

<p class="slate-p" placeholder="Type / for widgets">Sequences are a predefined list of consecutive tasks to be executed in the shell2 sandbox</p><p class="slate-p" placeholder="Type / for widgets"></p>

Sequences are a predefined list of consecutive tasks to be executed in the shell2 sandbox

<p class="slate-p" placeholder="Type / for widgets">This API endpoint allows you to run a sequence within the Shell2 API. By making a request to this endpoint, you can initiate the execution of a predefined sequence of actions or tasks. This feature is especially useful for automating repetitive or complex processes within your application. Running a sequence can help streamline your workflow and save valuable time and resources.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

This API endpoint allows you to run a sequence within the Shell2 API. By making a request to this endpoint, you can initiate the execution of a predefined sequence of actions or tasks. This feature is especially useful for automating repetitive or complex processes within your application. Running a sequence can help streamline your workflow and save valuable time and resources.

Run a sequence

timeout

public

The "sequence" parameter is a required parameter that specifies the sequence to be executed. This parameter should be provided as a JSON object or string that defines the steps and actions to be performed in the sequence.

sequence

webhook

status

sequenceId

<p class="slate-p" placeholder="Type / for widgets">The /sequence/get API endpoint allows you to retrieve all data from a sequence execution.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

The /sequence/get API endpoint allows you to retrieve all data from a sequence execution.

Fetch sequence data

metadata

This parameter contains the details of a specific sequence.

stack

files

<p class="slate-p" placeholder="Type / for widgets">This API endpoint allows you to retrieve a list of all sequences.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

This API endpoint allows you to retrieve a list of all sequences.

List all sequences

The "sequences" parameter is used to specify the list of sequences to be returned. It is a required parameter for the "post /sequence/list" endpoint. This parameter should be passed as an array of sequence names or IDs.

sequences

<p class="slate-p" placeholder="Type / for widgets">The post /sequence/update API endpoint allows you to update a sequence in the Shell2 API - namely its public status.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

The post /sequence/update API endpoint allows you to update a sequence in the Shell2 API - namely its public status.

Update a sequence

This parameter is returned in the response to indicate the status of the sequence update operation. The possible values for this parameter are "success" and "error".

<p>The Session API endpoint allows you to retrieve information about live user sessions in Shell2.</p>

The Session API endpoint allows you to retrieve information about live user sessions in Shell2.

<p>The User API section provides functionality for retrieving and updating user data.</p>

The User API section provides functionality for retrieving and updating user data.

<p class="slate-p" placeholder="Type / for widgets">Messages you send in shell2 sessions &amp; sequences without any prefix, are interpreted as <strong class="slate-bold">queries to generate code by default.</strong></p><h3 class="slate-h3">- Message Without Prefix</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Description</strong>: Code generation task.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Usage</strong>: <code class="slate-code">{CODE_TASK}</code></div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Examples</strong>:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><code class="slate-code">plot a cosine wave animation into a mp4 file</code></div></li><li class="slate-li"><div style="position:relative"><code class="slate-code">calculate and display the square root of 64</code></div></li></ul></li></ul><p class="slate-p" placeholder="Type / for widgets">Since not every message is a code generation task, here is a list of currently available commands to use inside shell2 sessions &amp; sequences.</p><h3 class="slate-h3"><code class="slate-code">/m</code> - Normal Text Prompt</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Description</strong>: This command generates normal text prompts without code generation.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Usage</strong>: <code class="slate-code">/m {TEXT_PROMPT}</code></div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Examples</strong>:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><code class="slate-code">/m how to get clout?</code></div></li><li class="slate-li"><div style="position:relative"><code class="slate-code">/m what are some important metrics mentioned in the previous text?</code></div></li></ul></li></ul><h3 class="slate-h3"><code class="slate-code">/doc</code> - Extract Text from Document or Image</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Description</strong>: This command can extract text from documents or images. It can be used directly from a URL or with a sandbox file. It works with various document files, image formats, and CSV files.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Usage</strong>: <code class="slate-code">/doc {URL_OR_FILENAME} {OPTIONAL_TEXT_PROMPT}</code></div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Examples</strong>:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><code class="slate-code">/doc https://arxiv.org/pdf/1804.02767.pdf what is the paper about?</code></div></li><li class="slate-li"><div style="position:relative"><code class="slate-code">/doc scores_data.csv</code></div></li><li class="slate-li"><div style="position:relative"><code class="slate-code">/doc uploads://my_uploaded_paper.pdf</code></div></li></ul></li></ul><h3 class="slate-h3"><code class="slate-code">/web</code> - Extract Text from Webpage</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Description</strong>: This command extracts text from a webpage.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Usage</strong>: <code class="slate-code">/web {URL} {OPTIONAL_TEXT_PROMPT}</code></div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Examples</strong>:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><code class="slate-code">/web https://example.com/articles/some_article</code></div></li><li class="slate-li"><div style="position:relative"><code class="slate-code">/web https://www.latent.space/p/ai-ux-moat summarize in a single paragraph</code></div></li></ul></li></ul><h3 class="slate-h3"><code class="slate-code">/file</code> - Download File from URL</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Description</strong>: This command allows you to download a file from a URL.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Usage</strong>: <code class="slate-code">/file {URL} {OPTIONAL_OUTPUT_FILENAME}</code></div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Examples</strong>:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><code class="slate-code">/file https://raw.githubusercontent.com/datasets/gdp/master/data/gdp.csv</code></div></li><li class="slate-li"><div style="position:relative"><code class="slate-code">/file https://example.com/some_file.png i_love_u.png</code></div></li><li class="slate-li"><div style="position:relative"><code class="slate-code">/doc uploads://my_uploaded_file.json</code></div></li></ul></li></ul><h3 class="slate-h3"><code class="slate-code">/shell</code> - Execute a Shell Command</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Description</strong>: This command allows you to execute a shell command.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Usage</strong>: <code class="slate-code">/shell {COMMAND}</code></div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Examples</strong>:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><code class="slate-code">/shell pip install -U seaborn</code></div></li></ul></li></ul><h3 class="slate-h3"><code class="slate-code">/run</code> - Execute Python Code</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Description</strong>: This command allows you to execute Python code.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Usage</strong>: <code class="slate-code">/run {PYTHON_CODE}</code></div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Examples</strong>:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><code class="slate-code">/run x = 1337</code></div></li><li class="slate-li"><div style="position:relative"><code class="slate-code">/run import time; print(f&apos;current timestamp: {time.time()}&apos;)</code></div></li></ul></li></ul><h3 class="slate-h3"><code class="slate-code">/file_extract</code> - Download &amp; Extract an Archive</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Description</strong>: This command allows you to download and extract an archive.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Usage</strong>: <code class="slate-code">/file_extract {ARCHIVE_URL} {OPTIONAL_ARCHIVE_OUTPUT_FILENAME}</code></div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Examples</strong>:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><code class="slate-code">/file_extract https://raw.githubusercontent.com/example/example-data/main/my_archive.7z</code></div></li></ul></li></ul><h3 class="slate-h3"><code class="slate-code">/done</code> - Close the Session</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Description</strong>: This command closes the session.</div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Usage</strong>: <code class="slate-code">/done</code></div></li><li class="slate-li"><div style="position:relative"><strong class="slate-bold">Examples</strong>:</div><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><code class="slate-code">/done</code></div></li></ul></li></ul><p class="slate-p" placeholder="Type / for widgets">Feel free to use these commands to interact with the tool as needed. If you have any questions or need assistance, please contact us via email or on twitter (@n_raidenai).</p>

Messages you send in shell2 sessions & sequences without any prefix, are interpreted as 

Since not every message is a code generation task, here is a list of currently available commands to use inside shell2 sessions & sequences.

Feel free to use these commands to interact with the tool as needed. If you have any questions or need assistance, please contact us via email or on twitter (@n_raidenai).

<p>Here are some example you can use to test shell2.</p><p>You can either use them as sequences or use them in live sessions.</p>

Here are some example you can use to test shell2.

You can either use them as sequences or use them in live sessions.