Skip to main content

Robocorp local task server

Project description

robocorp-action-server

Robocorp Action Server is a Python framework designed to simplify the deployment of actions (AI or otherwise).

An action in this case is defined as a Python function (which has inputs/outputs defined), which is served by the Robocorp Action Server.

The Robocorp Action Server automatically generates an OpenAPI spec for your Python code, enabling different AI/LLM Agents to understand and call your Action. It also manages the Action lifecycle and provides full traceability of what happened during runs.

1. Install Action Server

Action Server is available as a stand-alone fully signed executable and via pip install robocorp-action-server.

We recommend the executable to prevent confusion in case you have multiple/crowded Python environments, etc.

For macOS

# Install Robocorp Action Server
brew update
brew install robocorp/tools/action-server 

For Windows

# Download Robocorp Action Server
curl -o action-server.exe https://downloads.robocorp.com/action-server/releases/latest/windows64/action-server.exe

# Add to PATH or move to a folder that is in PATH
setx PATH=%PATH%;%CD%

For Linux

# Download Robocorp Action Server
curl -o action-server https://downloads.robocorp.com/action-server/releases/latest/linux64/action-server
chmod a+x action-server

# Add to PATH or move to a folder that is in PATH
sudo mv action-server /usr/local/bin/

2. Run your first Action

# Bootstrap a new project using this template.
# You'll be prompted for the name of the project (directory):
action-server new

# Start Action Server 
cd my-project
action-server start --expose

👉 You should now have an Action Server running locally at: http://localhost:8080, so open that in your browser and the web UI will guide you further.

👉 Using the --expose -flag, you also get a public internet-facing URL (something like "https://twently-cuddly-dinosaurs.robocorp.link") and the related token. These are the details that you need to configure your AI Agent to have access to your Action

What do you need in your Action Package

An Action Package is currently defined as a local folder that contains at least one Python file containing an action entry point (a Python function marked with @action -decorator from robocorp.actions).

Optionally, you can have a conda.yaml for specifying the Python environment and dependencies for your Action (if a conda.yaml is present, then RCC will be used to automatically bootstrap it and keep it updated given the conda.yaml contents.

See: More information on conda.yaml.

A robot.yaml used by RCC is not required, but it may be useful to have it to manually run the actions out of the Robocorp Action Server.
We recommend checking out Robocorp Code -extension for VS Code.

Bootstrapping a new Action

Start new projects with:

action-server new

Note: the action-server executable should be automatically added to your python installation after pip install robocorp-action-server, but if for some reason it wasn't pip-installed, it's also possible to use python -m robocorp.action_server instead of action-server.

After creating the project, it's possible to serve the actions under the current directory with:

action-server start

For example: When running action-server start, the action server will scan for existing actions under the current directory, and it'll start serving those.

After it's started, it's possible to access the following URLs:

  • /index.html: UI for the Action Server.
  • /openapi.json: Provides the openapi spec for the action server.
  • /docs: Provides access to the APIs available in the server and a UI to test it.

API Reference

Information on specific functions or classes: robocorp.action-server

Changelog

A list of releases and corresponding changes can be found in the changelog.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

robocorp_action_server-0.0.13.tar.gz (309.6 kB view details)

Uploaded Source

Built Distributions

robocorp_action_server-0.0.13-cp312-cp312-win_amd64.whl (8.9 MB view details)

Uploaded CPython 3.12 Windows x86-64

robocorp_action_server-0.0.13-cp312-cp312-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl (10.4 MB view details)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

robocorp_action_server-0.0.13-cp312-cp312-macosx_11_0_x86_64.whl (15.2 MB view details)

Uploaded CPython 3.12 macOS 11.0+ x86-64

robocorp_action_server-0.0.13-cp311-cp311-win_amd64.whl (8.9 MB view details)

Uploaded CPython 3.11 Windows x86-64

robocorp_action_server-0.0.13-cp311-cp311-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl (10.4 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

robocorp_action_server-0.0.13-cp311-cp311-macosx_11_0_x86_64.whl (15.2 MB view details)

Uploaded CPython 3.11 macOS 11.0+ x86-64

robocorp_action_server-0.0.13-cp310-cp310-win_amd64.whl (8.9 MB view details)

Uploaded CPython 3.10 Windows x86-64

robocorp_action_server-0.0.13-cp310-cp310-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl (10.4 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64 manylinux: glibc 2.5+ x86-64

robocorp_action_server-0.0.13-cp310-cp310-macosx_11_0_x86_64.whl (15.2 MB view details)

Uploaded CPython 3.10 macOS 11.0+ x86-64

File details

Details for the file robocorp_action_server-0.0.13.tar.gz.

File metadata

  • Download URL: robocorp_action_server-0.0.13.tar.gz
  • Upload date:
  • Size: 309.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.2.0-1018-azure

File hashes

Hashes for robocorp_action_server-0.0.13.tar.gz
Algorithm Hash digest
SHA256 c35778a49243ca880d995e9379018546a57e074fc3bf3ac59452edae7641ea96
MD5 86d7dde2c3161d3dbe16b0f63dc8091b
BLAKE2b-256 379cf27c45bc82235e2307345ca6a33ab41b06fb0f457b2b5de0c65f064b17bb

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.0.13-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for robocorp_action_server-0.0.13-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 ed236e8916c55ea8a73c63164638559617cc8ba306fc9986dd4dccefe14a6a17
MD5 014ac38960ea3ef6ff67ddf7de7d7343
BLAKE2b-256 7450d70e2958c97b0cabd25d021d63c86bde32b6236df974e3c67732d170c98f

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.0.13-cp312-cp312-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for robocorp_action_server-0.0.13-cp312-cp312-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 261ec67b31ddbb30ffc260ffdc76777e8437ea4ced66b05b04bb5cb56ef2891a
MD5 0fb9518a01b19c31f1a60a9caa86322a
BLAKE2b-256 014550eb03204148c2077d8404099bc40735aa568e5681769bfa3ff22b0ac687

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.0.13-cp312-cp312-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for robocorp_action_server-0.0.13-cp312-cp312-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 213dec3c5d03f9f840c28ae6b8d932165646d6c2de4968a1a45b5367df79ae2f
MD5 4bea3132268224f30eb1921667a2ab26
BLAKE2b-256 39d7b615b58b7b8af4ef18237c60586519ac929da8bb48dc4d8b45b3324cf033

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.0.13-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for robocorp_action_server-0.0.13-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 99dd14e4bc3be43ee9116f094e8c5a922e210ed5da82b5dbeff8b8d1a99056fc
MD5 c7bb4da71195269f89ca26685f0a01a0
BLAKE2b-256 4843d5a80fcd97a71ed56bb775e10e5d99dca03a1cba3d05282d729be4032514

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.0.13-cp311-cp311-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for robocorp_action_server-0.0.13-cp311-cp311-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 fde263646d20d26bdecc543ac90b2eb23b64ec0c20c2bb31af48bf5b36f90f60
MD5 63a85c71ea0956429e6fd706e5f29c1b
BLAKE2b-256 1c74c30079ed748e61fcb0d886244b670eaeebb12f320fbe5bd6be427ec659be

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.0.13-cp311-cp311-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for robocorp_action_server-0.0.13-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 02dc60eb3c77a06e948b5f33133b7eacd020c996787d61b5a6420dee127aff1e
MD5 04343dfcd2bb555cfbd16ade32a352fb
BLAKE2b-256 928df1f1c2f702c22949c752fcaa1581c667c969460f5287d0d98df3a0895ee3

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.0.13-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for robocorp_action_server-0.0.13-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 9a8cd043ba6f5ee8f7bd41e6bcadceb4fa2125224abfb560d4a9a7157bde133e
MD5 033718b144a99c48900bd6d4b7de4b22
BLAKE2b-256 d576029e7c1685718201a40d21eadcaa148882444de14e35fcfe004da42d10f5

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.0.13-cp310-cp310-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for robocorp_action_server-0.0.13-cp310-cp310-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 43e7a68973b968c1b40bfa5c7a1dbf235b4f5dc93d37ea81c71750388b1c9950
MD5 2a72fed2672d83889a31863891d1c023
BLAKE2b-256 0f7b1ad8a0480a76bdb6591ab8cd84f6d8effee08c664365753ad3e8bcf7010d

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.0.13-cp310-cp310-macosx_11_0_x86_64.whl.

File metadata

File hashes

Hashes for robocorp_action_server-0.0.13-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 3774416783f3aae489c2a903e4a009cfa5025a3fd5cc8c9eab7ad9d616980f45
MD5 89b9288d4f7aad00b7d1a21242b4f3a0
BLAKE2b-256 d823497c6038d08cc7dd611106ccabee4c80af247147597e14f84f6a34202aef

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page