Quickstart

Get your first governed action running in under 5 minutes.

Option A: Faramesh Horizon

Sign up at your Horizon URL and complete onboarding.
Copy your API key from the dashboard (you'll get one during onboarding or from API Keys).
Install the SDK and point it at Horizon:

pip install faramesh
# Set your Horizon URL and API key
export FARAMESH_URL="https://api.faramesh.io"  # or your Horizon URL
export FARAMESH_API_KEY="your-api-key"

pip install faramesh
# Set your Horizon URL and API key
export FARAMESH_URL="https://api.faramesh.io"  # or your Horizon URL
export FARAMESH_API_KEY="your-api-key"

pip install faramesh
# Set your Horizon URL and API key
export FARAMESH_URL="https://api.faramesh.io"  # or your Horizon URL
export FARAMESH_API_KEY="your-api-key"

Submit a test action:

from faramesh.sdk import submit_action

action = submit_action(
    agent_id="my-agent",
    tool="http",
    operation="get",
    params={"url": "https://example.com"}
)
print(f"Status: {action['status']}")

from faramesh.sdk import submit_action

action = submit_action(
    agent_id="my-agent",
    tool="http",
    operation="get",
    params={"url": "https://example.com"}
)
print(f"Status: {action['status']}")

from faramesh.sdk import submit_action

action = submit_action(
    agent_id="my-agent",
    tool="http",
    operation="get",
    params={"url": "https://example.com"}
)
print(f"Status: {action['status']}")

Check the dashboard — If the policy requires approval, you'll see it in Approvals. Approve or deny from there.

First run: If your first action is denied, that’s default behavior when no policy rule matches. Add a policy that allows or requires approval for your tool/operation (e.g. in the dashboard under Policies, or see Policy overview and Policy recipes), then submit again.

Option B: Self-hosted (Faramesh Core)

Install and start the server:

Submit a test action:

curl -X POST http://localhost:8000/v1/actions \
  -H "Content-Type: application/json" \
  -d '{"agent_id":"my-agent","tool":"http","operation":"get","params":{"url":"https://example.com"}}'

curl -X POST http://localhost:8000/v1/actions \
  -H "Content-Type: application/json" \
  -d '{"agent_id":"my-agent","tool":"http","operation":"get","params":{"url":"https://example.com"}}'

curl -X POST http://localhost:8000/v1/actions \
  -H "Content-Type: application/json" \
  -d '{"agent_id":"my-agent","tool":"http","operation":"get","params":{"url":"https://example.com"}}'

Check the result — Open http://localhost:8000/docs for the API, or use the dashboard at http://localhost:8000 if available.

First run: Same as Horizon—if the action is denied, add a policy rule that allows or requires approval for your tool/operation (see Policies).

Next steps

Define policies — Control what's allowed, denied, or needs approval
Connect your agent framework — LangChain, CrewAI, AutoGen
Set up approval notifications — Slack and email

Table of content