Concepts
How it works
Step 1 — Prepare your image
Your Docker image must implement the agent contract. The platform handles authentication; your code never validates tokens. Listen on the port given by theAGENT_PORT environment variable (default 8080).
See Compute → Agents for the full contract and manifest format.
Step 2 — Register the agent
- Python
- CLI
Step 3 — Deploy an instance
Deploying an instance is done via the REST API or CLI. The SDK does not have adeploy method on client.compute.instance.
- CLI
- curl
object
Key-value pairs injected as environment variables into the instance. Keep secrets in a secret manager and reference them at runtime.
string
Compute tier for the instance:
micro, standard, large, or gpu. Defaults to standard.string
Unique identifier for the deployed instance.
string
Permanent URL in the form
https://agent-<name>-<hash>.compute.hexelstudio.com.string
Initial state, typically
deploying.Step 4 — Call your agent
Step 5 — Manage the lifecycle
Use the SDK or CLI for instance management (list, get, stop, redeploy, delete):- Python
- CLI
Common mistakes
- Image missing the agent contract. Health checks fail and the instance stays in
deploying. Verify/healthand the manifest first. - Expecting a new URL per deploy. Identical configuration returns the same endpoint by design; change configuration to get a new one.
- Putting secrets in capabilities or the image. Pass runtime configuration through
envand use a secret manager for sensitive values.
Best practices
- Tag images with explicit versions (
:v1,:v2) rather than:latest. - Keep a separate environment for staging and production deployments.
- Use
redeployto roll out revisions so the endpoint stays stable for callers.
Related pages
Agents
The agent contract and registration options.
Instances
Endpoints, states, and instance management.
Scaling
Adjust capacity for production load.
Orchestration
Coordinate multiple agents with fleets and tasks.

