Skip to content

QVAC-17317 doc: write API ref SDK v0.9.0#1632

Merged
BrunoCampana merged 2 commits into
mainfrom
docs/sdk-api-ref-v0.9
Apr 16, 2026
Merged

QVAC-17317 doc: write API ref SDK v0.9.0#1632
BrunoCampana merged 2 commits into
mainfrom
docs/sdk-api-ref-v0.9

Conversation

@BrunoCampana

Copy link
Copy Markdown
Contributor

Objective

Create a new API reference for SDK v0.9.0.

Scope

Delta between API v0.8.0 and v0.9.0:

New functions:

  • finetune() — Fine-tuning support with three overloads: run (returns FinetuneHandle with progress streaming), stop, and getState
  • diffusion() — Image generation via Stable Diffusion models, with progress streaming and DiffusionClientParams (includes SamplingMethod and Scheduler enums)
  • suspend() — Suspend the SDK server lifecycle
  • resume() — Resume a suspended SDK server
  • heartbeat() — Health check with optional delegate parameter, returns HeartbeatResponse
  • defineDuplexHandler() — Define bidirectional plugin handlers with request/response schemas

Removed functions:

  • ping() — Removed from the public API

Modified functions:

  • embed() — Return type changed from Promise<number[]> to Promise<{ embedding: number[]; stats?: EmbedStats }> (and array variant accordingly). New EmbedStats type with totalTime, tokensPerSecond, totalTokens, backendDevice
  • completion() — Added backendDevice field ("cpu" | "gpu" | undefined) to CompletionStats

New errors:

  • LIFECYCLE_SUSPEND_FAILED (code 53600)
  • LIFECYCLE_RESUME_FAILED (code 53601)

Updated error scopes:

  • INVALID_RESPONSE_TYPE — Now also thrown by finetune(), heartbeat(), resume(), suspend(); no longer thrown by ping()
  • STREAM_ENDED_WITHOUT_RESPONSE — Now also thrown by finetune()

@BrunoCampana BrunoCampana self-assigned this Apr 16, 2026
@BrunoCampana BrunoCampana added the documentation Improvements or additions to documentation label Apr 16, 2026
@BrunoCampana BrunoCampana requested a review from a team as a code owner April 16, 2026 15:17
@BrunoCampana BrunoCampana requested a review from a team as a code owner April 16, 2026 15:17
@kinsta

kinsta Bot commented Apr 16, 2026

Copy link
Copy Markdown

Preview deployments for qvac-docs-staging ⚡️

Status Branch preview Commit preview
✅ Ready Visit preview Visit preview

Commit: 6b72de5f90d85d9a08da6aa8830724d6a2379c89

Deployment ID: 809e6501-67e8-4241-a792-28142a6d2063

Static site name: qvac-docs-staging-fazwv

@github-actions

github-actions Bot commented Apr 16, 2026

Copy link
Copy Markdown
Contributor

Tier-based Approval Status

**PR Tier:** TIER1

**Current Status:** ✅ APPROVED

**Requirements:**
- 1 Team Member approval ✅ (1/1)
- 1 Team Lead OR Management approval ✅ (1/1)



---
*This comment is automatically updated when reviews change.*

@BrunoCampana BrunoCampana marked this pull request as draft April 16, 2026 15:37
@BrunoCampana BrunoCampana marked this pull request as ready for review April 16, 2026 15:57
@BrunoCampana BrunoCampana merged commit 5a5ea01 into main Apr 16, 2026
12 of 13 checks passed
@BrunoCampana BrunoCampana deleted the docs/sdk-api-ref-v0.9 branch April 16, 2026 16:58
Proletter pushed a commit that referenced this pull request May 24, 2026
* doc: api v0.9 manually written

* doc: SDK - api reference - v0.9.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation tier1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants