CloudYali Developer Resources

CloudYali API quickstart

The public API needs no authentication. Start from the discovery document, then load the specification.

curl https://www.cloudyali.io/api
curl https://www.cloudyali.io/openapi.json
curl https://www.cloudyali.io/api/v1/features

Every successful response uses the envelope { "success": true, "data": … }. Every failure uses the structured error envelope described below.

CloudYali public API endpoints

Reachable, unauthenticated endpoints served from https://www.cloudyali.io.

CloudYali API authentication

The endpoints listed above are public and require no credentials. The authenticated CloudYali platform API — the one that returns your own cost, budget and inventory data — is scoped to your account and is provisioned from the CloudYali console. Contact support@cloudyali.io for access and the current endpoint reference.

CloudYali API error codes

Every non-2xx response from a CloudYali endpoint is JSON — never an HTML error page. The code field is stable and safe to branch on, and hint tells you what to do about it.

{
  "success": false,
  "error": {
    "code": "validation_error",
    "message": "Missing required field: businessEmail",
    "hint": "Provide every field listed in `details.required_fields` and retry.",
    "details": { "missing_fields": ["businessEmail"] },
    "documentation_url": "https://www.cloudyali.io/developers",
    "request_id": "3f1c9a54-6f0e-4a1e-9a2d-0b7c2f5f1a44"
  }
}

CloudYali API rate limits

The public API allows 120 requests per 60 seconds per client. You do not have to guess how much of that you have left — every response tells you.

RateLimit-Policy: "public";q=120;w=60
RateLimit: "public";r=118;t=47
X-RateLimit-Limit: 120
X-RateLimit-Remaining: 118
X-RateLimit-Reset: 1767225647

• RateLimit-Policy is the IETF structured field for the published quota: q is the quota, w the window in seconds. It is on every response.
• RateLimit is your live position: r requests remaining, t seconds until the window resets. It appears on responses a shared cache will not store — a CDN must never replay one caller’s counters to another. The X-RateLimit-* trio carries the same numbers for clients that read those instead.
• Exceeding the quota returns 429 with Retry-After in seconds and the rate_limited error code. Wait that long; do not retry sooner.

Enforcement happens at the origin, so a response served from CDN cache is not counted against you. If your workload needs more than this, tell us what you are building at support@cloudyali.io.

CloudYali API versioning and deprecation

The API is versioned in the URL path and is currently v1. Within a major version changes are additive only. Anything that could break a caller ships under a new major version path, and a retirement is announced at least 180 days ahead with the Deprecation and Sunset response headers.

The full contract — including what does and does not count as a breaking change — is at CloudYali API versioning and deprecation policy.

CloudYali resources for AI agents

CloudYali publishes machine-readable versions of its content so agents do not have to scrape rendered HTML.

Using CloudYali with LLM function calling

The CloudYali OpenAPI document is written to convert cleanly into tool definitions: every operation has a unique operationId, a description written for a model rather than a human skimming docs, typed parameters with explicit bounds, and a declared response schema.

# Operation ids exposed by the CloudYali public API
getApiIndex            GET  /api
getServiceHealth       GET  /api/v1/health
listProductFeatures    GET  /api/v1/features
listBlogPosts          GET  /api/v1/blogs
getBlogPostBySlug      GET  /api/v1/blogs/{slug}
getDemoRequestStatus   GET  /api/demo-request
submitDemoRequest      POST /api/demo-request

CloudYali CLI

cloudyali is a zero-dependency command-line client for the endpoints above. Every command prints JSON, so it composes with jq and drops into scripts without anyone writing an HTTP client first.

npx @cloudyali/cli features --provider AWS | jq '.features[].name'

Install instructions, the full command list and exit codes are on the CloudYali CLI page. If you would rather generate a client in your own language, the OpenAPI specification feeds openapi-generator directly.

CloudYali developer support

Questions about the CloudYali API, integrations or agent access: support@cloudyali.io. Include the request_id from any error response — it lets us find the exact request in our logs.