Reference
SDKs
Every API operation by its name in the TypeScript, Python and Go SDKs.
The three SDKs are generated from the same OpenAPI document and name every operation the same way: a resource, then a method. TypeScript keeps the name, Python snake-cases it, Go capitalises it. Install and configure them with the SDKs guide.
#Packages
| Language | Package | Client |
|---|---|---|
| TypeScript | @kaabist/sdk | new Kaab() |
| Python | kaabist | Kaab() and AsyncKaab() |
| Go | github.com/kaabist/kaab-go/kaab | kaab.New("") |
Every client reads KAAB_API_KEY and, when it is set, KAAB_BASE_URL.
#Helpers
| What | TypeScript | Python | Go |
|---|---|---|---|
| Wait for a job to end, answering inputs on the way | kaab.jobs.wait(id, { onInput }) | kaab.jobs.wait(id, on_input=…) | client.Jobs.Wait(ctx, id, kaab.WaitOptions{…}) |
| Iterate every item of a list, page after page | for await (const job of kaab.jobs.list()) | for job in kaab.jobs.list() | client.Jobs.ListAll(ctx, params) |
| Verify a webhook delivery | kaab.webhooks.verify(body, header, secret) | kaab.webhooks.verify(body, header, secret) | webhooks.Verify(body, header, secret) |
#Operations
| Operation | TypeScript | Python | Go |
|---|---|---|---|
| Create a job from a program reference or the url + extract shorthand | kaab.jobs.create() | kaab.jobs.create() | client.Jobs.Create() |
| List jobs, newest first | kaab.jobs.list() | kaab.jobs.list() | client.Jobs.List() |
| Create up to 1000 jobs from one program | kaab.jobs.batch() | kaab.jobs.batch() | client.Jobs.Batch() |
| Estimate the credit cost of a job without enqueuing it | kaab.jobs.estimate() | kaab.jobs.estimate() | client.Jobs.Estimate() |
Read the job envelope; Prefer: wait long-polls for a state change | kaab.jobs.get() | kaab.jobs.get() | client.Jobs.Get() |
| Per-step records with timings, snapshots and healing information | kaab.jobs.steps() | kaab.jobs.steps() | client.Jobs.Steps() |
| Redirect to a presigned snapshot JSON URL | kaab.jobs.snapshot() | kaab.jobs.snapshot() | client.Jobs.Snapshot() |
| Redirect to a presigned screenshot URL | kaab.jobs.screenshot() | kaab.jobs.screenshot() | client.Jobs.Screenshot() |
| Redirect to a presigned artifact URL | kaab.jobs.artifact() | kaab.jobs.artifact() | client.Jobs.Artifact() |
Supply the value an await_input step is waiting for | kaab.jobs.input() | kaab.jobs.input() | client.Jobs.Input() |
| Apply a proposal, skip a step, retry from a checkpoint, continue or abort | kaab.jobs.resume() | kaab.jobs.resume() | client.Jobs.Resume() |
| Open a live browser session on a parked job | kaab.jobs.takeover() | kaab.jobs.takeover() | client.Jobs.Takeover() |
| Cancel a job and release its reserved credits | kaab.jobs.cancel() | kaab.jobs.cancel() | client.Jobs.Cancel() |
| Read batch counters | kaab.batches.get() | kaab.batches.get() | client.Batches.Get() |
| List the jobs of a batch | kaab.batches.jobs() | kaab.batches.jobs() | client.Batches.Jobs() |
| Create a program and its first version | kaab.programs.create() | kaab.programs.create() | client.Programs.Create() |
| List programs | kaab.programs.list() | kaab.programs.list() | client.Programs.List() |
| Lint a program definition and return the normalized document | kaab.programs.lint() | kaab.programs.lint() | client.Programs.Lint() |
| Read a program by id or name | kaab.programs.get() | kaab.programs.get() | client.Programs.Get() |
| Rename a program or change its description and canary settings | kaab.programs.update() | kaab.programs.update() | client.Programs.Update() |
| Soft-delete a program | kaab.programs.delete() | kaab.programs.delete() | client.Programs.Delete() |
| List the versions of a program | kaab.programs.versions.list() | kaab.programs.versions.list() | client.Programs.Versions.List() |
| Add a version to a program | kaab.programs.versions.create() | kaab.programs.versions.create() | client.Programs.Versions.Create() |
| Replace a draft version's definition in place; published versions are immutable | kaab.programs.versions.update() | kaab.programs.versions.update() | client.Programs.Versions.Update() |
| Delete a draft version (it is archived); published versions are immutable | kaab.programs.versions.delete() | kaab.programs.versions.delete() | client.Programs.Versions.Delete() |
| Read one version including its definition | kaab.programs.versions.get() | kaab.programs.versions.get() | client.Programs.Versions.Get() |
Publish a draft version and move the latest alias | kaab.programs.versions.publish() | kaab.programs.versions.publish() | client.Programs.Versions.Publish() |
| RFC 6902 JSON Patch between two versions | kaab.programs.versions.diff() | kaab.programs.versions.diff() | client.Programs.Versions.Diff() |
| Run extraction against a stored snapshot without fetching | kaab.programs.versions.replay() | kaab.programs.versions.replay() | client.Programs.Versions.Replay() |
| Point an alias at a version | kaab.programs.aliases.set() | kaab.programs.aliases.set() | client.Programs.Aliases.Set() |
| Remove an alias | kaab.programs.aliases.delete() | kaab.programs.aliases.delete() | client.Programs.Aliases.Delete() |
| Store a browser storage state as a reusable session | kaab.sessions.create() | kaab.sessions.create() | client.Sessions.Create() |
| List sessions | kaab.sessions.list() | kaab.sessions.list() | client.Sessions.List() |
| Read a session by id or name | kaab.sessions.get() | kaab.sessions.get() | client.Sessions.Get() |
| Rename a session or replace its storage state | kaab.sessions.update() | kaab.sessions.update() | client.Sessions.Update() |
| Delete a session | kaab.sessions.delete() | kaab.sessions.delete() | client.Sessions.Delete() |
| Run the validity probe | kaab.sessions.verify() | kaab.sessions.verify() | client.Sessions.Verify() |
| Enqueue the session's refresh program | kaab.sessions.refresh() | kaab.sessions.refresh() | client.Sessions.Refresh() |
| List proposals | kaab.proposals.list() | kaab.proposals.list() | client.Proposals.List() |
| Read a proposal | kaab.proposals.get() | kaab.proposals.get() | client.Proposals.Get() |
| Approve a proposal, optionally promoting it to a new version | kaab.proposals.approve() | kaab.proposals.approve() | client.Proposals.Approve() |
| Reject a proposal | kaab.proposals.reject() | kaab.proposals.reject() | client.Proposals.Reject() |
| Replace the proposed change before approval | kaab.proposals.edit() | kaab.proposals.edit() | client.Proposals.Edit() |
| Create a cron schedule for a program | kaab.schedules.create() | kaab.schedules.create() | client.Schedules.Create() |
| List schedules | kaab.schedules.list() | kaab.schedules.list() | client.Schedules.List() |
| Read a schedule | kaab.schedules.get() | kaab.schedules.get() | client.Schedules.Get() |
| Change a schedule | kaab.schedules.update() | kaab.schedules.update() | client.Schedules.Update() |
| Delete a schedule | kaab.schedules.delete() | kaab.schedules.delete() | client.Schedules.Delete() |
| Pause a schedule | kaab.schedules.pause() | kaab.schedules.pause() | client.Schedules.Pause() |
| Resume a paused schedule | kaab.schedules.resume() | kaab.schedules.resume() | client.Schedules.Resume() |
| List the runs of a schedule | kaab.schedules.runs() | kaab.schedules.runs() | client.Schedules.Runs() |
| Redirect to a presigned URL of a run's JSON Patch against the previous run | kaab.schedules.runDiff() | kaab.schedules.run_diff() | client.Schedules.RunDiff() |
| Register a webhook endpoint; the secret is shown once | kaab.webhooks.create() | kaab.webhooks.create() | client.Webhooks.Create() |
| List webhook endpoints | kaab.webhooks.list() | kaab.webhooks.list() | client.Webhooks.List() |
| Read a webhook endpoint | kaab.webhooks.get() | kaab.webhooks.get() | client.Webhooks.Get() |
| Change a webhook endpoint | kaab.webhooks.update() | kaab.webhooks.update() | client.Webhooks.Update() |
| Delete a webhook endpoint | kaab.webhooks.delete() | kaab.webhooks.delete() | client.Webhooks.Delete() |
| Rotate the signing secret | kaab.webhooks.rotateSecret() | kaab.webhooks.rotate_secret() | client.Webhooks.RotateSecret() |
| List delivery attempts | kaab.webhooks.deliveries() | kaab.webhooks.deliveries() | client.Webhooks.Deliveries() |
| Resend one delivery as a new attempt row; the original is never changed | kaab.webhooks.resendDelivery() | kaab.webhooks.resend_delivery() | client.Webhooks.ResendDelivery() |
Send a ping event to the endpoint and wait up to 10 s for its answer | kaab.webhooks.test() | kaab.webhooks.test() | client.Webhooks.Test() |
Rotate the secret ad-hoc webhook_url deliveries are signed with; shown once | kaab.org.rotateWebhookSecret() | kaab.org.rotate_webhook_secret() | client.Org.RotateWebhookSecret() |
| Read the calling organisation | kaab.org.get() | kaab.org.get() | client.Org.Get() |
| Read credit balance and pools | kaab.credits.get() | kaab.credits.get() | client.Credits.Get() |
| List ledger entries | kaab.ledger.list() | kaab.ledger.list() | client.Ledger.List() |
| Aggregated usage over a period | kaab.usage.get() | kaab.usage.get() | client.Usage.Get() |
| List API keys | kaab.apiKeys.list() | kaab.api_keys.list() | client.APIKeys.List() |
| Create an API key; the secret is shown once | kaab.apiKeys.create() | kaab.api_keys.create() | client.APIKeys.Create() |
| Rotate an API key with an optional grace period | kaab.apiKeys.rotate() | kaab.api_keys.rotate() | client.APIKeys.Rotate() |
| Revoke an API key | kaab.apiKeys.revoke() | kaab.api_keys.revoke() | client.APIKeys.Revoke() |
| List bring-your-own providers | kaab.byoProviders.list() | kaab.byo_providers.list() | client.BYOProviders.List() |
| Register a bring-your-own provider | kaab.byoProviders.create() | kaab.byo_providers.create() | client.BYOProviders.Create() |
| Read a bring-your-own provider | kaab.byoProviders.get() | kaab.byo_providers.get() | client.BYOProviders.Get() |
| Change a bring-your-own provider | kaab.byoProviders.update() | kaab.byo_providers.update() | client.BYOProviders.Update() |
| Delete a bring-your-own provider | kaab.byoProviders.delete() | kaab.byo_providers.delete() | client.BYOProviders.Delete() |
| Health-check a bring-your-own provider | kaab.byoProviders.test() | kaab.byo_providers.test() | client.BYOProviders.Test() |
| Purge the organisation's data within 24 hours | kaab.org.requestDataDeletion() | kaab.org.request_data_deletion() | client.Org.RequestDataDeletion() |
| Read the learned site profile visible to the organisation | kaab.sites.get() | kaab.sites.get() | client.Sites.Get() |