Documentation Index
Fetch the complete documentation index at: https://docs.youka.io/llms.txt
Use this file to discover all available pages before exploring further.
These methods are read-mostly account helpers. They use the same YoukaClient authentication and per-request options as project and export calls.
client.account.get(options?)
Fetch the account identity for the active API key.
const account = await client.account.get();
console.log(account.email, account.userId, account.apiKeyId);
client.credits.overview(options?)
Fetch available balance, renewal dates, top-ups, and subscription renewal metadata.
const credits = await client.credits.overview();
if (!credits.availableBalance) {
console.log("No credits available");
}
client.billing.getCatalog(options?)
Fetch subscription and top-up pricing for the authenticated account.
const catalog = await client.billing.getCatalog();
console.log(
catalog.unitCredits,
catalog.subscription.monthly.unitPriceFormatted,
);
client.billing.createCheckout(body, options?)
Create a Stripe checkout URL.
const checkout = await client.billing.createCheckout({
productType: "subscription",
cycle: "monthly",
quantity: 1,
});
console.log(checkout.url);
productType: "topup" and a positive quantity. The SDK defaults platform to "sdk" unless you override it.
Create a billing portal URL.
const portal = await client.billing.getManageUrl();
console.log(portal.url);
What’s next
- Projects - quote and create projects
- Exports - quote and render exports
- Errors - handle authentication and billing errors
