# Runloop AI Docs

## Docs

- [Complete a BenchmarkRun.](https://docs.runloop.ai/api-reference/benchmark/complete-a-benchmarkrun.md): Complete a currently running BenchmarkRun.
- [Create a Benchmark.](https://docs.runloop.ai/api-reference/benchmark/create-a-benchmark.md): Create a Benchmark with a set of Scenarios.
- [Get a Benchmark.](https://docs.runloop.ai/api-reference/benchmark/get-a-benchmark.md): Get a previously created Benchmark.
- [Get a previously created BenchmarkRun.](https://docs.runloop.ai/api-reference/benchmark/get-a-previously-created-benchmarkrun.md): Get a BenchmarkRun given ID.
- [List BenchmarkRuns.](https://docs.runloop.ai/api-reference/benchmark/list-benchmarkruns.md): List all BenchmarkRuns matching filter.
- [List Benchmarks.](https://docs.runloop.ai/api-reference/benchmark/list-benchmarks.md): List all Benchmarks matching filter.
- [List Public Benchmarks.](https://docs.runloop.ai/api-reference/benchmark/list-public-benchmarks.md): List all public benchmarks matching filter.
- [Start a new BenchmarkRun.](https://docs.runloop.ai/api-reference/benchmark/start-a-new-benchmarkrun.md): Start a new BenchmarkRun based on the provided Benchmark.
- [Update a Benchmark.](https://docs.runloop.ai/api-reference/benchmark/update-a-benchmark.md): Update a Benchmark with a set of Scenarios.
- [Create and build a Blueprint.](https://docs.runloop.ai/api-reference/blueprint/create-and-build-a-blueprint.md): Starts build of custom defined container Blueprint. The Blueprint will begin in the 'provisioning' step and transition to the 'building' step once it is selected off the build queue., Upon build complete it will transition to 'building_complete' if the build is successful.
- [Delete a Blueprint.](https://docs.runloop.ai/api-reference/blueprint/delete-a-blueprint.md): Delete a previously created Blueprint.
- [Get a Blueprint.](https://docs.runloop.ai/api-reference/blueprint/get-a-blueprint.md): Get the details of a previously created Blueprint including the build status.
- [Get Blueprint build logs.](https://docs.runloop.ai/api-reference/blueprint/get-blueprint-build-logs.md): Get all logs from the building of a Blueprint.
- [List Blueprints.](https://docs.runloop.ai/api-reference/blueprint/list-blueprints.md): List all Blueprints or filter by name.
- [Preview Dockerfile definition for a Blueprint.](https://docs.runloop.ai/api-reference/blueprint/preview-dockerfile-definition-for-a-blueprint.md): Preview building a Blueprint with the specified configuration. You can take the resulting Dockerfile and test out your build using any local docker tooling.
- [The Blueprint Object](https://docs.runloop.ai/api-reference/blueprint/the-blueprint-object.md)
- [Create a Browser.](https://docs.runloop.ai/api-reference/browser/create-a-browser.md): Create a Devbox that has a managed Browser and begin the boot process. As part of booting the Devbox, the browser will automatically be started with connection utilities activated.
- [Get Browser Details.](https://docs.runloop.ai/api-reference/browser/get-browser-details.md)
- [Create a Computer.](https://docs.runloop.ai/api-reference/computer/create-a-computer.md): Create a Computer and begin the boot process. The Computer will initially launch in the 'provisioning' state while Runloop allocates the necessary infrastructure. It will transition to the 'initializing' state while the booted Computer runs any Runloop or user defined set up scripts. Finally, the Computer will transition to the 'running' state when it is ready for use.
- [Get Computer Details.](https://docs.runloop.ai/api-reference/computer/get-computer-details.md)
- [Asynchronously execute a command via the Devbox shell](https://docs.runloop.ai/api-reference/devbox/asynchronously-execute-a-command-via-the-devbox-shell.md): Execute the given command in the Devbox shell asynchronously and returns the execution that can be used to track the command's progress.
- [Create a Devbox.](https://docs.runloop.ai/api-reference/devbox/create-a-devbox.md): Create a Devbox and begin the boot process. The Devbox will initially launch in the 'provisioning' state while Runloop allocates the necessary infrastructure. It will transition to the 'initializing' state while the booted Devbox runs any Runloop or user defined set up scripts. Finally, the Devbox will transition to the 'running' state when it is ready for use.
- [Create a disk snapshot of a running Devbox.](https://docs.runloop.ai/api-reference/devbox/create-a-disk-snapshot-of-a-running-devbox.md): Create a disk snapshot of a devbox with the specified name and metadata to enable launching future Devboxes with the same disk state.
- [Create a tunnel to an available port on the Devbox.](https://docs.runloop.ai/api-reference/devbox/create-a-tunnel-to-an-available-port-on-the-devbox.md): Create a live tunnel to an available port on the Devbox. Note the port must be made available using Devbox.create.availablePorts. Otherwise, the tunnel will not connect to any running processes on the Devbox.
- [Create an SSH key for a Devbox](https://docs.runloop.ai/api-reference/devbox/create-an-ssh-key-for-a-devbox.md): Create an SSH key for a Devbox to enable remote access.
- [Delete a disk snapshot of a Devbox.](https://docs.runloop.ai/api-reference/devbox/delete-a-disk-snapshot-of-a-devbox.md): Delete a previously taken disk snapshot of a Devbox.
- [Download binary file contents from Devbox filesystem.](https://docs.runloop.ai/api-reference/devbox/download-binary-file-contents-from-devbox-filesystem.md): Download file contents of any type (binary, text, etc) from a specified path on the Devbox.
- [Get Devbox details.](https://docs.runloop.ai/api-reference/devbox/get-devbox-details.md): Get the latest details and status of a Devbox.
- [Get Devbox logs.](https://docs.runloop.ai/api-reference/devbox/get-devbox-logs.md): Get all logs from a running or completed Devbox.
- [Get status of an asynchronous execution on a Devbox.](https://docs.runloop.ai/api-reference/devbox/get-status-of-an-asynchronous-execution-on-a-devbox.md): Get the latest status of a previously launched asynchronous execuction including stdout/error and the exit code if complete.
- [null](https://docs.runloop.ai/api-reference/devbox/kill-an-asynchronous-execution-currently-running-on-a-devbox.md)
- [List Devboxes.](https://docs.runloop.ai/api-reference/devbox/list-devboxes.md): List all Devboxes while optionally filtering by status.
- [List disk snapshots of a Devbox.](https://docs.runloop.ai/api-reference/devbox/list-disk-snapshots-of-a-devbox.md): List all snapshots of a Devbox while optionally filtering by Devbox ID.
- [Live Tail Devbox Logs.](https://docs.runloop.ai/api-reference/devbox/live-tail-devbox-logs.md): Tail the logs for the given devbox. This will return past log entries and continue streaming from there. The stream will then continue to stream logs until the connection is closed.
- [Read text file contents from Devbox filesystem.](https://docs.runloop.ai/api-reference/devbox/read-text-file-contents-from-devbox-filesystem.md): Read file contents from a file on a Devbox as a UTF-8. Note 'downloadFile' should be used for large files (greater than 100MB). Returns the file contents as a UTF-8 string.
- [Remove an open tunnel on the Devbox.](https://docs.runloop.ai/api-reference/devbox/remove-an-open-tunnel-on-the-devbox.md): Remove a previously opened tunnel on the Devbox.
- [Shutdown a running Devbox.](https://docs.runloop.ai/api-reference/devbox/shutdown-a-running-devbox.md): Shutdown a running Devbox. This will permanently stop the Devbox. If you want to save the state of the Devbox, you should take a snapshot before shutting down or should suspend the Devbox instead of shutting down.
- [Synchronously execute a shell command on a Devbox](https://docs.runloop.ai/api-reference/devbox/synchronously-execute-a-shell-command-on-a-devbox.md): Execute a bash command in the Devbox shell, await the command completion and return the output.
- [The Devbox Object](https://docs.runloop.ai/api-reference/devbox/the-devbox-object.md)
- [Upload binary file contents to Devbox filesystem.](https://docs.runloop.ai/api-reference/devbox/upload-binary-file-contents-to-devbox-filesystem.md): Upload file contents of any type (binary, text, etc) to a Devbox. Note this API is suitable for large files (larger than 100MB) and efficiently uploads files via multipart form data.
- [Write text file contents to Devbox filesystem.](https://docs.runloop.ai/api-reference/devbox/write-text-file-contents-to-devbox-filesystem.md): Write UTF-8 string contents to a file at path on the Devbox. Note for large files (larger than 100MB), the upload_file endpoint must be used.
- [Introduction](https://docs.runloop.ai/api-reference/introduction.md): Welcome to the Runloop API Reference Documentation
- [Create a Repository Connection.](https://docs.runloop.ai/api-reference/repository/create-a-repository-connection.md): Create a connection to a Github Repository and trigger an initial inspection of the repo's technical stack and developer environment requirements.
- [Delete a Repository Connection and associated objects.](https://docs.runloop.ai/api-reference/repository/delete-a-repository-connection-and-associated-objects.md): Permanently Delete a Repository Connection including any automatically generated inspection insights.
- [Get Repository Connection details.](https://docs.runloop.ai/api-reference/repository/get-repository-connection-details.md): Get Repository Connection details including latest inspection status and generated repository insights.
- [List analyzed repository versions.](https://docs.runloop.ai/api-reference/repository/list-analyzed-repository-versions.md): List all analyzed versions of a repository connection including automatically generated insights for each version.
- [List available repository connections.](https://docs.runloop.ai/api-reference/repository/list-available-repository-connections.md): List all available repository connections.
- [The Repository Object](https://docs.runloop.ai/api-reference/repository/the-repository-object.md)
- [Trigger inspection of the latest version of a repository connection.](https://docs.runloop.ai/api-reference/repository/trigger-inspection-of-the-latest-version-of-a-repository-connection.md): Trigger inspection of the latest version of a repository including repo's technical stack and developer environment requirements.
- [Complete a ScenarioRun.](https://docs.runloop.ai/api-reference/scenario/complete-a-scenariorun.md): Complete a currently running ScenarioRun. Calling complete will shutdown underlying Devbox resource.
- [Create a custom scenario scorer.](https://docs.runloop.ai/api-reference/scenario/create-a-custom-scenario-scorer.md): Create a custom scenario scorer.
- [Create a Scenario.](https://docs.runloop.ai/api-reference/scenario/create-a-scenario.md): Create a Scenario, a repeatable AI coding evaluation test that defines the starting environment as well as evaluation success criteria.
- [Get a previously created ScenarioRun.](https://docs.runloop.ai/api-reference/scenario/get-a-previously-created-scenariorun.md): Get a ScenarioRun given ID.
- [Get a Scenario.](https://docs.runloop.ai/api-reference/scenario/get-a-scenario.md): Get a previously created scenario.
- [List Public Scenarios.](https://docs.runloop.ai/api-reference/scenario/list-public-scenarios.md): List all public scenarios matching filter.
- [List Scenario Scorers.](https://docs.runloop.ai/api-reference/scenario/list-scenario-scorers.md): List all Scenario Scorers matching filter.
- [List ScenarioRuns.](https://docs.runloop.ai/api-reference/scenario/list-scenarioruns.md): List all ScenarioRuns matching filter.
- [List Scenarios.](https://docs.runloop.ai/api-reference/scenario/list-scenarios.md): List all Scenarios matching filter.
- [Retrieve Scenario Scorer.](https://docs.runloop.ai/api-reference/scenario/retrieve-scenario-scorer.md): Retrieve Scenario Scorer.
- [Score a ScenarioRun.](https://docs.runloop.ai/api-reference/scenario/score-a-scenariorun.md): Score a currently running ScenarioRun.
- [Start a new ScenarioRun.](https://docs.runloop.ai/api-reference/scenario/start-a-new-scenariorun.md): Start a new ScenarioRun based on the provided Scenario.
- [Update a custom scenario scorer.](https://docs.runloop.ai/api-reference/scenario/update-a-custom-scenario-scorer.md): Update a scenario scorer.
- [Update a Scenario.](https://docs.runloop.ai/api-reference/scenario/update-a-scenario.md): Update a Scenario, a repeatable AI coding evaluation test that defines the starting environment as well as evaluation success criteria.
- [Validate a custom scenario scorer.](https://docs.runloop.ai/api-reference/scenario/validate-a-custom-scenario-scorer.md): Validate a scenario scorer.
- [Build Custom Agent Benchmarks with Runloop](https://docs.runloop.ai/benchmarks/custom-benchmarks.md): Learn how to create and run custom benchmarks. We're personally excited about this part of our platform - let us know at support@runloop.ai if you need any help!
- [Overview of Benchmarking on Runloop](https://docs.runloop.ai/benchmarks/overview.md): Make your agent better and more reliable with Runloop's tools for benchmarking.
- [Public Benchmarks](https://docs.runloop.ai/benchmarks/public-benchmarks.md): Learn how to easily run your agent against popular public benchmarks.
- [Quickstart - Controlling a Browser in a Runloop Devbox](https://docs.runloop.ai/devboxes/addons/browser.md): Learn how to control a browser programmatically inside a Runloop Devbox using the Runloop SDK
- [Quickstart - Controlling a remote computer in a Runloop Devbox](https://docs.runloop.ai/devboxes/addons/computer.md): Learn how to control a computer programmatically inside a Runloop Devbox using the Runloop SDK
- [Overview of Devbox Add-ons](https://docs.runloop.ai/devboxes/addons/overview.md)
- [Devbox Blueprints](https://docs.runloop.ai/devboxes/blueprints.md): Reproducible templates for devboxes
- [Mount a Code Repository on a Devbox](https://docs.runloop.ai/devboxes/code-mounts.md): Enable AI agents to work with full projects: access public and private repositories
- [Debugging Agent Output with SSH](https://docs.runloop.ai/devboxes/debugging-agent-output-with-ssh.md): Securely connect to a remote Runloop Devbox using SSH for debugging
- [Execute Commands on a Devbox](https://docs.runloop.ai/devboxes/execute-commands.md): Run and execute code at scale
- [Read and Write Files on a Devbox](https://docs.runloop.ai/devboxes/files.md): Give your AI agent access to modify and interact with files on your devbox.
- [The Devbox Lifecycle](https://docs.runloop.ai/devboxes/lifecycle.md): Reference documentation for the various states a Devbox can be in.
- [Managing Devbox Metadata](https://docs.runloop.ai/devboxes/metadata.md): Effectively manage and organize large numbers of Devboxes using metadata
- [Overview of Devboxes](https://docs.runloop.ai/devboxes/overview.md)
- [Configuring Devbox Instance Sizes](https://docs.runloop.ai/devboxes/sizes.md): Configure your Devboxes using predefined sizes
- [Devbox Snapshots](https://docs.runloop.ai/devboxes/snapshots.md): Saved diskstates from existing for devboxes for re-use & branching
- [Start and Stop a Devbox](https://docs.runloop.ai/devboxes/start-stop.md): Getting started with the Runloop platform
- [Troubleshooting Blueprint Builds](https://docs.runloop.ai/devboxes/troubleshooting-blueprints.md): Debug and fix your Blueprint builds in Runloop.
- [Open a Tunnel to a Service on a Devbox](https://docs.runloop.ai/devboxes/tunnels.md): Create a tunnel to access ports on your Devbox
- [Usage with Common Model Providers and Frameworks](https://docs.runloop.ai/examples/llm-integrations.md)
- [Quickstart: Giving Agents a Development Environment](https://docs.runloop.ai/overview/quickstart.md)
- [What is Runloop?](https://docs.runloop.ai/overview/what-is-runloop.md)
- [Support for AI tools](https://docs.runloop.ai/tools/ai-tools.md): Add context about the Runloop API to your LLMs
- [Runloop CLI](https://docs.runloop.ai/tools/cli.md): Explore, experiment with, and test the Runloop API using the Runloop CLI.
- [Cursor Rules](https://docs.runloop.ai/tools/cursor-files.md)
- [Runloop Dashboard](https://docs.runloop.ai/tools/dashboard.md): Manage, monitor, and optimize your AI-powered coding environments with the Runloop Dashboard.
- [SDKs](https://docs.runloop.ai/tools/sdks.md): Use the Runloop SDKs to interact with the Runloop API.