@runapi.ai/topaz
v0.2.4
Published
RunAPI Topaz SDK for JavaScript, Ruby, and Go
Maintainers
Readme
Topaz API JavaScript SDK for RunAPI
The topaz api JavaScript SDK is the language-specific package for Topaz on RunAPI. Use this topaz api package for image upscale, video upscale, restoration, and production cleanup flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in JavaScript.
This topaz api README is the JavaScript package guide inside the public topaz-sdk repository. For the repository overview, start at ../README.md; for model details, use https://runapi.ai/models/topaz; for API reference, use https://runapi.ai/docs#topaz; for SDK docs, use https://runapi.ai/docs#sdk-topaz.
Install
npm install @runapi.ai/topazQuick start
import { TopazClient } from '@runapi.ai/topaz';
const client = new TopazClient();
const task = await client.imageUpscales.create({
// Pass the Topaz JSON request body from https://runapi.ai/docs#topaz.
});
const status = await client.imageUpscales.get(task.id);Use create when you want to submit a task and return quickly, get when you need the latest task state, and run when a script should create and poll until completion. In web request handlers, prefer create plus webhook or later get polling so a worker is not held open.
Language notes
Use the TypeScript types in src/types.ts and the resource classes under src/resources when building upscaling applications. The available resources include image upscales, and video upscales. Keep RUNAPI_API_KEY in the environment or your secret manager; never commit API keys or callback secrets.
Links
- Model page: https://runapi.ai/models/topaz
- SDK docs: https://runapi.ai/docs#sdk-topaz
- Product docs: https://runapi.ai/docs#topaz
- Pricing and rate limits: https://runapi.ai/models/topaz/image-upscale
- Provider comparison: https://runapi.ai/providers/topaz
- Full catalog: https://runapi.ai/models
- Repository: https://github.com/runapi-ai/topaz-sdk
License
Licensed under the Apache License, Version 2.0.
