SDKs

Overview

Official SDKs provide typed interfaces, automatic retries, pagination helpers, and idempotency key support for Node.js, Python, Go, and Java codebases.

Prefer SDKs over raw HTTP when building internal platforms, custom dashboards, or long-running workers that integrate with Zof.

Who should read this

• QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.

When to use this workflow

• Onboarding new team members to Zof terminology and workflows
• Authoring internal runbooks aligned with Console labels
• Designing CI/CD or webhook integrations against documented behavior

Step-by-step procedure

Key concepts

Node.js / TypeScript

npm install @zof-ai/sdk

Python

pip install zof-ai

Go

go get github.com/zof-ai/zof-go

Java

Maven: ai.zof:sdk

Best practices

• Validate changes in staging before applying release gates to production.
• Include run IDs and timestamps when escalating issues to support or auditors.
• Align internal runbook terminology with Zof Console UI labels for clarity.

Node.js

import { ZofClient } from '@zof-ai/sdk';

const client = new ZofClient({ apiKey: process.env.ZOF_API_KEY });
const run = await client.runs.create({
  projectId: 'proj_abc123',
  environment: 'staging',
  testCaseIds: ['tc_001'],
});
await client.runs.waitUntilComplete(run.id);