API reference
JumpCLI's external API is defined by the API documentation and stable contracts published by the deployment instance. Public browser clients access only the JumpCLI product service; they do not call the Casdoor management API, Meteroid management API, or payment service directly.
api.jumpcli.com is currently a reserved developer API endpoint, not an alias for an existing browser sign-in session. It will be enabled after contracts for API keys, independent authentication, versioning, rate limits, and auditing have been published.
Main endpoint categories
| Category | Example use |
|---|---|
| Image generation | Submit a generation, query a job, and read results |
| Image editing | Upload an editing source and submit an edit request |
| Gallery | Filter, read, favorite, import, and export images |
| Account | Read account sessions, subscriptions, and billing projections |
| Operator | Process reviews, plans, and configuration after authorization and operator step-up verification |
Calling principles
- Once the developer API is formally available, use
api.jumpcli.comor the self-hosted API address provided by the service operator. - Call only capabilities permitted by the current account and subscription.
- Handle
401,403,402,429, and upstream failures; do not retry indefinitely. - Do not embed operator keys in browsers, public repositories, or client applications.
Before upgrading an API integration, read the deployment instance's release notes and validate compatibility with a non-production account.