SDK Reference
Go: Getting started
Overview
Install the Go SDK and authenticate with your organization API key.
The client wraps REST endpoints with typed models, automatic retries on transient failures, and cursor pagination helpers.
Who should read this
- QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.
Prerequisites
- Go runtime installed
- Organization API key
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
Install
Add SDK package to your project dependencies.
Verify version with package manager list command.
Configure API key
Export ZOF_API_KEY from CI secrets or local .env (never commit).
Smoke test
Call client.projects.list() and confirm 200 response.
Log organization scope from first project object.
Key concepts
- Organization scope
- All Zof Console and API operations are isolated to your authenticated tenant.
- Governed execution
- Agent output and remediation follow policy packs with human approval when configured.
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.
Example
# Install npm install github.com/zof-ai/zof-go # or pip install zof-ai
Was this page helpful?