Documentation Index
Fetch the complete documentation index at: https://hexelstudio.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Agents are Docker images registered in the Hexel registry. Once registered, they can be deployed as instances with permanent endpoints.
Agent contract
Your Docker image must expose the following endpoints:
| Endpoint | Method | Description |
|---|
/health | GET | Returns {"status": "ok"} |
/.well-known/agent.json | GET | Agent manifest with capabilities |
/stream | POST | Streaming response (SSE) |
/invoke | POST | Blocking response |
Register an agent
from hexel import Hexel
client = Hexel(api_key="your_api_key")
agent = client.compute.agent.register(
name="fraud-detector",
image="ghcr.io/org/fraud-agent:v1",
capabilities=["fraud-detection", "streaming"],
)
hexel compute agent register \
--name fraud-detector \
--image ghcr.io/org/fraud-agent:v1 \
--capabilities "fraud-detection,streaming"
Private registries
For images hosted in private registries, provide pull credentials during registration:
agent = client.compute.agent.register(
name="my-agent",
image="123456789.dkr.ecr.us-east-1.amazonaws.com/agent:v1",
image_pull_secret={
"registry": "123456789.dkr.ecr.us-east-1.amazonaws.com",
"username": "AWS",
"password": "your-ecr-token",
},
)
List and search
agents = client.compute.agent.list()
results = client.compute.agent.search(q="fraud")
Delete
client.compute.agent.delete("agent-id")
