Go SDK

Version 0.6.0. Generated source. This page corrects errors in that source.

This library provides convenient access to the Dedalus REST API from Go.

The full API of this library can be found in api.md.

Contents

• Installation
• Usage
• API Reference
• Authentication
• Errors
• Client Options
• Request Options
• Retries and Timeouts
• Pagination
• Helpers
• Logging
• Requirements

Installation

go get github.com/dedalus-labs/dedalus-go@v0.6.0

Usage

package main

import (
	"context"
	"fmt"
	"os"

	sdk "github.com/dedalus-labs/dedalus-go"
	"github.com/dedalus-labs/dedalus-go/option"
)

func main() {
	client := sdk.NewClient(
		option.WithXAPIKey(os.Getenv("DEDALUS_X_API_KEY")),
	)

	machine, err := client.Machines.New(context.Background(), sdk.MachineNewParams{
		CreateParams: sdk.CreateParams{
			Autosleep:  sdk.F[string]("300s"),
			MemoryMib:  sdk.F[int64](4096),
			StorageGib: sdk.F[int64](10),
			Vcpu:       sdk.F[float64](1),
		},
	})
	if err != nil {
		panic(err)
	}

	fmt.Println(machine.MachineID)
}

The examples in the following sections assume a client configured as shown above.

See the API reference for every available operation.

Authentication

Pass credentials to the generated client constructor. Environment variables are read automatically when supported by the target runtime.

Declared schemes:

• ApiKeyAuth API key in header x-api-key
• BearerAuth bearer token

Errors

Non-success responses return generated API errors. Error objects expose status, headers, response body, and request metadata where the target runtime supports it.

machine, err := client.Machines.New(context.Background(), sdk.MachineNewParams{
	CreateParams: sdk.CreateParams{
		Autosleep:  sdk.F[string]("300s"),
		MemoryMib:  sdk.F[int64](4096),
		StorageGib: sdk.F[int64](10),
		Vcpu:       sdk.F[float64](1),
	},
})
if err != nil {
	var apiErr *sdk.Error
	if errors.As(err, &apiErr) {
		fmt.Println(apiErr.StatusCode, apiErr.JSON.RawJSON())
	}
	panic(err)
}

fmt.Println(machine.MachineID)

// imports: "context", "errors", "fmt", sdk "github.com/dedalus-labs/dedalus-go"

Documented error statuses: 401, 403, 409, 429, 503, default.

Client Options

Configure the generated client by setting any of these options when you create it.

client := sdk.NewClient(
	option.WithBaseURL("https://api.example.com"),
	option.WithMaxRetries(2),
	option.WithRequestTimeout(60*time.Second),
)

// imports: sdk "github.com/dedalus-labs/dedalus-go", "github.com/dedalus-labs/dedalus-go/option", "time"

Request Options

Retries and Timeouts

Generated clients support request timeouts and retry temporary failures such as network errors, 408, 409, 429, and 5xx responses. Retry delays honor Retry-After headers when present. Tune the retry and timeout client options shown above, or override them per request.

Pagination

List returns one page. ListAutoPaging returns an iterator that fetches later pages for you.

iter := client.Machines.ListAutoPaging(context.Background(), sdk.MachineListParams{})
for iter.Next() {
	machine := iter.Current()
	fmt.Println(machine.MachineID)
}
if err := iter.Err(); err != nil {
	panic(err)
}

Helpers

• Pass option.WithResponseInto(&raw) to capture the underlying *http.Response for a request.
• Use the generated F, String, Int, Bool, Float, and Null helpers when setting optional params.

Logging

• Wrap the HTTP client with option.WithMiddleware(...) to add request logging or tracing.

Requirements

• Go 1.22 or newer

Powered by Scalar.