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).

The package.yaml file is required for specifying the Python environment and dependencies for your Action (RCC will be used to automatically bootstrap it and keep it updated given the package.yaml contents).

Note: the package.yaml is optional if the action server is not being used as a standalone (i.e.: if it was pip-installed it can use the same python environment where it's installed).

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.1.1.tar.gz (379.9 kB view details)

Uploaded Source

Built Distributions

robocorp_action_server-0.1.1-cp312-cp312-win_amd64.whl (9.0 MB view details)

Uploaded CPython 3.12 Windows x86-64

robocorp_action_server-0.1.1-cp312-cp312-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl (10.5 MB view details)

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

robocorp_action_server-0.1.1-cp312-cp312-macosx_11_0_x86_64.whl (15.3 MB view details)

Uploaded CPython 3.12 macOS 11.0+ x86-64

robocorp_action_server-0.1.1-cp311-cp311-win_amd64.whl (9.0 MB view details)

Uploaded CPython 3.11 Windows x86-64

robocorp_action_server-0.1.1-cp311-cp311-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl (10.5 MB view details)

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

robocorp_action_server-0.1.1-cp311-cp311-macosx_11_0_x86_64.whl (15.3 MB view details)

Uploaded CPython 3.11 macOS 11.0+ x86-64

robocorp_action_server-0.1.1-cp310-cp310-win_amd64.whl (9.0 MB view details)

Uploaded CPython 3.10 Windows x86-64

robocorp_action_server-0.1.1-cp310-cp310-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl (10.5 MB view details)

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

robocorp_action_server-0.1.1-cp310-cp310-macosx_11_0_x86_64.whl (15.3 MB view details)

Uploaded CPython 3.10 macOS 11.0+ x86-64

File details

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

File metadata

  • Download URL: robocorp_action_server-0.1.1.tar.gz
  • Upload date:
  • Size: 379.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1016-azure

File hashes

Hashes for robocorp_action_server-0.1.1.tar.gz
Algorithm Hash digest
SHA256 99c8fb62439967ccae00fa09e51a30be2d37594450b2d22720d54ca11821a586
MD5 83bbb41866588b3ac33229333e4932c7
BLAKE2b-256 1fd5ec65d79f52e814a59548096e3d9bdec02647878e03b62b9c4f2d3c105ac7

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for robocorp_action_server-0.1.1-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 a230d3f67a4dfed4b09dfeba97f77191b4e1efbee24cc9b2807f836d37c7e025
MD5 2cb826067429157c9202ede5ff399ede
BLAKE2b-256 837abe7253062399327c4ca7d9f594b44d56c170e23e92f27966c6619956b081

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.1.1-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.1.1-cp312-cp312-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a02dea1c65947306b3e06094f347928f6806c8c3778f7304cc4c9bb95b7fd756
MD5 12dcbbd0bb268acfa7e9be988ee2afc6
BLAKE2b-256 5a8decf4086ce53b244f933c92dc4e19db401070f3d8fa98197e7b3b0d5f77bc

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for robocorp_action_server-0.1.1-cp312-cp312-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 99d73079bc3954aea4ecefca54df914022a1f0549c22695b02ab5a3a0af99840
MD5 3443139cf319b6a20a49ae2df5b650bd
BLAKE2b-256 a71db059782b4010ec92d814a49153e23ac28adf8bdad22f4e19594748075098

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for robocorp_action_server-0.1.1-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 997b1172b18af33cae79d0006c12693dc33da8ac4e5f2eb4cba6631d16cc6538
MD5 c46eee04754c8a7eec53bf1275e56258
BLAKE2b-256 33cc31bfc2db8d53ddba3052c9167a44e07226e5b51ed047b3f54e931c4ec09f

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.1.1-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.1.1-cp311-cp311-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 9a92665353282ca04c60f41a3cd9cec8a54c2f33ba7ff2e8f0192b7e132157a0
MD5 f559a8b8ea40d74d6cd74cd6d5dd56de
BLAKE2b-256 637fd9fb7b866a2b8a65da43ef6996977595deffad0ab58fe8eeb04614dbdcb5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for robocorp_action_server-0.1.1-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 a7218b79fc0957157fb2142b6763fd83ce2e952007f3b5ff31c74957517bd4c7
MD5 f938ddc3aa2a4dfd676816568bca4b4b
BLAKE2b-256 ce95c8729031f09b196a08b99edb09509c75be5b343074ac5fa83e34ecd02905

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for robocorp_action_server-0.1.1-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 d0c637eb8b061727d475abcc89ad6932d3ffcf13426b1606fd0d9be239f9764a
MD5 2facb0541027f7a8af4b1632e97afe48
BLAKE2b-256 7c3252fe6f1385210417ec839fff90f759ae71ef5161861e48a781f1b8251f20

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.1.1-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.1.1-cp310-cp310-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 61b2732e521b6f6afb2c264a6792fdf1db936a4ff12d2bf191d1fa995a89d4bb
MD5 56ad2028db0207070e1aa89c0a2272b3
BLAKE2b-256 e5841e5c3e648647f9b9c4895554a09035f236994df7985cba913067e89a7273

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for robocorp_action_server-0.1.1-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 f65f0e1490ba81301c975a6657fe8fbbfb19e2c2860913cc779765c8bb19d5a5
MD5 98844540d0b2e65747c007a83e0649de
BLAKE2b-256 f7aff57206575d1d7bb5963fb55862872360bcdd6bde7a23961baae5c9a4fc74

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