← Back to Documentation
API & Automation
REST API
Use REST endpoints for authentication, licensing, deployments, billing, and operational automation.
Key Steps
- Authenticate with the expected session or bearer credential for the route.
- Use idempotency and retry behavior for provisioning and billing workflows.
- Treat the API as an operational interface, not a bypass around license or access policy.
Article Scope
This guide focuses on the operational steps needed to run Orchestris with team access, provider control, and predictable usage.
Common API areas
- Authentication and account lifecycle.
- License validation, deployment heartbeat, and usage reporting.
- Billing, checkout, and provisioning workflows.
Request safety
- Validate inputs before calling administrative endpoints.
- Use idempotency keys where supported for retries.
- Log request IDs so failed calls can be traced without exposing secrets.
Access model
- User-facing calls require valid user session context.
- Deployment calls require deployment credentials.
- Administrative operations should be restricted to the smallest practical operator group.
Related Topics
API & Automation
Agent API Gateway
Connect OpenAI-compatible agent tools to Orchestris Server while keeping model access, quota, and usage controls in one place.
API & Automation
Client Streaming Notes
Understand the native streaming path used by connected clients and private deployments.
API & Automation
Webhook Notes
Plan webhook-style automation around documented portal and billing events.