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.

Documentation

Explore our docs for extensive documentation.

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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.12 Windows x86-64

robocorp_action_server-0.2.0-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.2.0-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.2.0-cp311-cp311-win_amd64.whl (9.0 MB view details)

Uploaded CPython 3.11 Windows x86-64

robocorp_action_server-0.2.0-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.2.0-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.2.0-cp310-cp310-win_amd64.whl (9.0 MB view details)

Uploaded CPython 3.10 Windows x86-64

robocorp_action_server-0.2.0-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.2.0-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.2.0.tar.gz.

File metadata

  • Download URL: robocorp_action_server-0.2.0.tar.gz
  • Upload date:
  • Size: 388.4 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.2.0.tar.gz
Algorithm Hash digest
SHA256 783eae5ed066bf741d0050d40df117728664cdd64dee043e4a8171fe47b341b5
MD5 92d380be27edb1afcd7eadfa70977009
BLAKE2b-256 ef15234b3d8ca0e4736fbd68b134db8e5c860edfd5459110bf235b587ac8cc0d

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for robocorp_action_server-0.2.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 caf44a75aa2264b32137f3df5b2212d70fabf1e95f0efd7f0caf0ac0af6c7357
MD5 4bb381f0f5623ca09ace01326a0ae8a5
BLAKE2b-256 f76d6518cea91b18cb42b558b2464cd5c8add452e8714afd8a7bf0df96c8c10a

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.2.0-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.2.0-cp312-cp312-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 d257a441907265cd9d47b7844000595c8fca0e1fb6ce5b29bfb52af3dda441c9
MD5 3b784281df2790ac64b84de85773c922
BLAKE2b-256 bded36ac59ff5cfc452b66d41f4c7117b83645d2ff7b0451b54da94d988d20c5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for robocorp_action_server-0.2.0-cp312-cp312-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 84d066b089c18476c410b997f3abe2af6049474b85cd2aed4153bdc369b510fb
MD5 60f58c8c8ead904474a7f652a6bc23b4
BLAKE2b-256 fa606700ebc0f40322fa3ae0a9a5facadcc43a56d64b0219f505e403f2a2b264

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for robocorp_action_server-0.2.0-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 a10916675e22a9a81768df86435a96ce4243c83dacf04ac01d42059800f5b11c
MD5 01f38e7798385f15cf53e43c3c2b9dcf
BLAKE2b-256 aca15994630fcd52f07f9127971669daa8b14786d626cd52413c16cec1d76873

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.2.0-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.2.0-cp311-cp311-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 564e0b2ec5ca48571e83497a869cb2c1bad03c3b4a7390177b98f2a66d598d74
MD5 5b7e6ae71e5f02a6dbdc79e5634f4e08
BLAKE2b-256 ee0fcad6ad6916b7da9504340baef2ea4ac0982feab5f97cb618683480cf8fb5

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for robocorp_action_server-0.2.0-cp311-cp311-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 a683f9cd357d2244dbe89835e1818540945de3a9dfab75b065c1a3eab3e9bba9
MD5 270445d516e470021495a6eb227bf96c
BLAKE2b-256 99951ede9961aa67fc8708f53832ae126e8eec0ffac4a31f86140146461b3ff3

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for robocorp_action_server-0.2.0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 a9af18e84968094bbfe0fdca601f1ddb0babbee12c9af46f94b0d03047d786e0
MD5 97a7cbb3a2aeede632b52cf504118dc6
BLAKE2b-256 63b9b5e45ffc4492fb34f0b9f85f9b9fc7f4f1310e164fb8ecac4f16ddda8dcd

See more details on using hashes here.

Provenance

File details

Details for the file robocorp_action_server-0.2.0-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.2.0-cp310-cp310-manylinux_2_17_x86_64.manylinux_2_5_x86_64.manylinux1_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 4f5391cae520ec4126c637162dfac245954016f8e4f4262bff95a3cf6f128a2d
MD5 7b2eb7d97bd3d95fcf103ece42bdcb98
BLAKE2b-256 165ff2efc980f41d68ea6b6b18d45a9cc180e61e211df945857bdce90e5a5180

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for robocorp_action_server-0.2.0-cp310-cp310-macosx_11_0_x86_64.whl
Algorithm Hash digest
SHA256 3c5153d1a7513c4973895d19b3109b68f0dd5ec94f9ccba9d39e4224c1133c74
MD5 c06348c8bc2a21cf63accdab3b628ad4
BLAKE2b-256 f6dfe7e3da0c9be66052d9484a51a86966d224e508c8a00426bc275b3b8bba4d

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