handinger

package module
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 8, 2026 License: Apache-2.0 Imports: 20 Imported by: 0

README

Handinger Go API Library

Go Reference

The Handinger Go library provides convenient access to the Handinger REST API from applications written in Go.

It is generated with Stainless.

Installation

import (
	"github.com/Ramensoft/handinger-go" // imported as handinger
)

Or to pin the version:

go get -u 'github.com/Ramensoft/handinger-go@v0.5.0'

Requirements

This library requires Go 1.22+.

Usage

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

package main

import (
	"context"
	"fmt"

	"github.com/Ramensoft/handinger-go"
	"github.com/Ramensoft/handinger-go/option"
)

func main() {
	client := handinger.NewClient(
		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("HANDINGER_API_KEY")
	)
	worker, err := client.Tasks.New(context.TODO(), handinger.TaskNewParams{
		CreateTask: handinger.CreateTaskParam{
			CreateWorkerParam: handinger.CreateWorkerParam{},
			WorkerID:          "t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM",
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", worker.ID)
}
Request fields

The handinger library uses the omitzero semantics from the Go 1.24+ encoding/json release for request fields.

Required primitive fields (int64, string, etc.) feature the tag `api:"required"`. These fields are always serialized, even their zero values.

Optional primitive types are wrapped in a param.Opt[T]. These fields can be set with the provided constructors, handinger.String(string), handinger.Int(int64), etc.

Any param.Opt[T], map, slice, struct or string enum uses the tag `json:"...,omitzero"`. Its zero value is considered omitted.

The param.IsOmitted(any) function can confirm the presence of any omitzero field.

p := handinger.ExampleParams{
	ID:   "id_xxx",                // required property
	Name: handinger.String("..."), // optional property

	Point: handinger.Point{
		X: 0,                // required field will serialize as 0
		Y: handinger.Int(1), // optional field will serialize as 1
		// ... omitted non-required fields will not be serialized
	},

	Origin: handinger.Origin{}, // the zero value of [Origin] is considered omitted
}

To send null instead of a param.Opt[T], use param.Null[T](). To send null instead of a struct T, use param.NullStruct[T]().

p.Name = param.Null[string]()       // 'null' instead of string
p.Point = param.NullStruct[Point]() // 'null' instead of struct

param.IsNull(p.Name)  // true
param.IsNull(p.Point) // true

Request structs contain a .SetExtraFields(map[string]any) method which can send non-conforming fields in the request body. Extra fields overwrite any struct fields with a matching key. For security reasons, only use SetExtraFields with trusted data.

To send a custom value instead of a struct, use param.Override[T](value).

// In cases where the API specifies a given type,
// but you want to send something else, use [SetExtraFields]:
p.SetExtraFields(map[string]any{
	"x": 0.01, // send "x" as a float instead of int
})

// Send a number instead of an object
custom := param.Override[handinger.FooParams](12)
Request unions

Unions are represented as a struct with fields prefixed by "Of" for each of its variants, only one field can be non-zero. The non-zero field will be serialized.

Sub-properties of the union can be accessed via methods on the union struct. These methods return a mutable pointer to the underlying data, if present.

// Only one field can be non-zero, use param.IsOmitted() to check if a field is set
type AnimalUnionParam struct {
	OfCat *Cat `json:",omitzero,inline`
	OfDog *Dog `json:",omitzero,inline`
}

animal := AnimalUnionParam{
	OfCat: &Cat{
		Name: "Whiskers",
		Owner: PersonParam{
			Address: AddressParam{Street: "3333 Coyote Hill Rd", Zip: 0},
		},
	},
}

// Mutating a field
if address := animal.GetOwner().GetAddress(); address != nil {
	address.ZipCode = 94304
}
Response objects

All fields in response structs are ordinary value types (not pointers or wrappers). Response structs also include a special JSON field containing metadata about each property.

type Animal struct {
	Name   string `json:"name,nullable"`
	Owners int    `json:"owners"`
	Age    int    `json:"age"`
	JSON   struct {
		Name        respjson.Field
		Owner       respjson.Field
		Age         respjson.Field
		ExtraFields map[string]respjson.Field
	} `json:"-"`
}

To handle optional data, use the .Valid() method on the JSON field. .Valid() returns true if a field is not null, not present, or couldn't be marshaled.

If .Valid() is false, the corresponding field will simply be its zero value.

raw := `{"owners": 1, "name": null}`

var res Animal
json.Unmarshal([]byte(raw), &res)

// Accessing regular fields

res.Owners // 1
res.Name   // ""
res.Age    // 0

// Optional field checks

res.JSON.Owners.Valid() // true
res.JSON.Name.Valid()   // false
res.JSON.Age.Valid()    // false

// Raw JSON values

res.JSON.Owners.Raw()                  // "1"
res.JSON.Name.Raw() == "null"          // true
res.JSON.Name.Raw() == respjson.Null   // true
res.JSON.Age.Raw() == ""               // true
res.JSON.Age.Raw() == respjson.Omitted // true

These .JSON structs also include an ExtraFields map containing any properties in the json response that were not specified in the struct. This can be useful for API features not yet present in the SDK.

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
Response Unions

In responses, unions are represented by a flattened struct containing all possible fields from each of the object variants. To convert it to a variant use the .AsFooVariant() method or the .AsAny() method if present.

If a response value union contains primitive values, primitive fields will be alongside the properties but prefixed with Of and feature the tag json:"...,inline".

type AnimalUnion struct {
	// From variants [Dog], [Cat]
	Owner Person `json:"owner"`
	// From variant [Dog]
	DogBreed string `json:"dog_breed"`
	// From variant [Cat]
	CatBreed string `json:"cat_breed"`
	// ...

	JSON struct {
		Owner respjson.Field
		// ...
	} `json:"-"`
}

// If animal variant
if animal.Owner.Address.ZipCode == "" {
	panic("missing zip code")
}

// Switch on the variant
switch variant := animal.AsAny().(type) {
case Dog:
case Cat:
default:
	panic("unexpected type")
}
RequestOptions

This library uses the functional options pattern. Functions defined in the option package return a RequestOption, which is a closure that mutates a RequestConfig. These options can be supplied to the client or at individual requests. For example:

client := handinger.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Tasks.New(context.TODO(), ...,
	// Override the header
	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
	// Add an undocumented field to the request body, using sjson syntax
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

The request option option.WithDebugLog(nil) may be helpful while debugging.

See the full list of request options.

Pagination

This library provides some conveniences for working with paginated list endpoints.

You can use .ListAutoPaging() methods to iterate through items across all pages:

Or you can use simple .List() methods to fetch a single page and receive a standard response object with additional helper methods like .GetNextPage(), e.g.:

Errors

When the API returns a non-success status code, we return an error with type *handinger.Error. This contains the StatusCode, *http.Request, and *http.Response values of the request, as well as the JSON of the error body (much like other response objects in the SDK).

To handle errors, we recommend that you use the errors.As pattern:

_, err := client.Tasks.New(context.TODO(), handinger.TaskNewParams{
	CreateTask: handinger.CreateTaskParam{
		CreateWorkerParam: handinger.CreateWorkerParam{},
		WorkerID:          "t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM",
	},
})
if err != nil {
	var apierr *handinger.Error
	if errors.As(err, &apierr) {
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
	}
	panic(err.Error()) // GET "/api/tasks": 400 Bad Request { ... }
}

When other errors occur, they are returned unwrapped; for example, if HTTP transport fails, you might receive *url.Error wrapping *net.OpError.

Timeouts

Requests do not time out by default; use context to configure a timeout for a request lifecycle.

Note that if a request is retried, the context timeout does not start over. To set a per-retry timeout, use option.WithRequestTimeout().

// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
client.Tasks.New(
	ctx,
	handinger.TaskNewParams{
		CreateTask: handinger.CreateTaskParam{
			CreateWorkerParam: handinger.CreateWorkerParam{},
			WorkerID:          "t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM",
		},
	},
	// This sets the per-retry timeout
	option.WithRequestTimeout(20*time.Second),
)
File uploads

Request parameters that correspond to file uploads in multipart requests are typed as io.Reader. The contents of the io.Reader will by default be sent as a multipart form part with the file name of "anonymous_file" and content-type of "application/octet-stream".

The file name and content-type can be customized by implementing Name() string or ContentType() string on the run-time type of io.Reader. Note that os.File implements Name() string, so a file returned by os.Open will be sent with the file name on disk.

We also provide a helper handinger.File(reader io.Reader, filename string, contentType string) which can be used to wrap any io.Reader with the appropriate file name and content type.

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.

You can use the WithMaxRetries option to configure or disable this:

// Configure the default for all requests:
client := handinger.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Tasks.New(
	context.TODO(),
	handinger.TaskNewParams{
		CreateTask: handinger.CreateTaskParam{
			CreateWorkerParam: handinger.CreateWorkerParam{},
			WorkerID:          "t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM",
		},
	},
	option.WithMaxRetries(5),
)
Accessing raw response data (e.g. response headers)

You can access the raw HTTP response data by using the option.WithResponseInto() request option. This is useful when you need to examine response headers, status codes, or other details.

// Create a variable to store the HTTP response
var response *http.Response
worker, err := client.Tasks.New(
	context.TODO(),
	handinger.TaskNewParams{
		CreateTask: handinger.CreateTaskParam{
			CreateWorkerParam: handinger.CreateWorkerParam{},
			WorkerID:          "t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM",
		},
	},
	option.WithResponseInto(&response),
)
if err != nil {
	// handle error
}
fmt.Printf("%+v\n", worker)

fmt.Printf("Status Code: %d\n", response.StatusCode)
fmt.Printf("Headers: %+#v\n", response.Header)
Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.Get, client.Post, and other HTTP verbs. RequestOptions on the client, such as retries, will be respected when making these requests.

var (
    // params can be an io.Reader, a []byte, an encoding/json serializable object,
    // or a "…Params" struct defined in this library.
    params map[string]any

    // result can be an []byte, *http.Response, a encoding/json deserializable object,
    // or a model defined in this library.
    result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
    …
}
Undocumented request params

To make requests using undocumented parameters, you may use either the option.WithQuerySet() or the option.WithJSONSet() methods.

params := FooNewParams{
    ID:   "id_xxxx",
    Data: FooNewParamsData{
        FirstName: handinger.String("John"),
    },
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
Undocumented response properties

To access undocumented response properties, you may either access the raw JSON of the response as a string with result.JSON.RawJSON(), or get the raw JSON of a particular field on the result with result.JSON.Foo.Raw().

Any fields that are not present on the response struct will be saved and can be accessed by result.JSON.ExtraFields() which returns the extra fields as a map[string]Field.

Middleware

We provide option.WithMiddleware which applies the given middleware to requests.

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	LogReq(req)

	// Forward the request to the next handler
	res, err = next(req)

	// Handle stuff after the request
	end := time.Now()
	LogRes(res, err, start - end)

    return res, err
}

client := handinger.NewClient(
	option.WithMiddleware(Logger),
)

When multiple middlewares are provided as variadic arguments, the middlewares are applied left to right. If option.WithMiddleware is given multiple times, for example first in the client then the method, the middleware in the client will run first and the middleware given in the method will run next.

You may also replace the default http.Client with option.WithHTTPClient(client). Only one http client is accepted (this overwrites any previous client) and receives requests after any middleware has been applied.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
  2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Contributing

See the contributing documentation.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool 

func Bool(b bool) param.Opt[bool]

func BoolPtr 

func BoolPtr(v bool) *bool

func DefaultClientOptions 

func DefaultClientOptions() []option.RequestOption

DefaultClientOptions read from the environment (HANDINGER_API_KEY, HANDINGER_BASE_URL). This should be used to initialize new clients.

func File 

func File(rdr io.Reader, filename string, contentType string) file

func Float 

func Float(f float64) param.Opt[float64]

func FloatPtr 

func FloatPtr(v float64) *float64

func Int 

func Int(i int64) param.Opt[int64]

func IntPtr 

func IntPtr(v int64) *int64

func Opt 

func Opt[T comparable](v T) param.Opt[T]

func Ptr 

func Ptr[T any](v T) *T

func String 

func String(s string) param.Opt[string]

func StringPtr 

func StringPtr(v string) *string

func Time 

func Time(t time.Time) param.Opt[time.Time]

func TimePtr 

func TimePtr(v time.Time) *time.Time

Types

type Client 

type Client struct {

	// Create, retrieve, and manage agent worker templates.
	Workers WorkerService
	// Run and inspect tasks against a worker.
	Tasks TaskService
	// contains filtered or unexported fields
}

Client creates a struct with services and top level methods that help with interacting with the handinger API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient 

func NewClient(opts ...option.RequestOption) (r Client)

NewClient generates a new client with the default option read from the environment (HANDINGER_API_KEY, HANDINGER_BASE_URL). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

func (*Client) Delete 

func (r *Client) Delete(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Delete makes a DELETE request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Execute 

func (r *Client) Execute(ctx context.Context, method string, path string, params any, res any, opts ...option.RequestOption) error

Execute makes a request with the given context, method, URL, request params, response, and request options. This is useful for hitting undocumented endpoints while retaining the base URL, auth, retries, and other options from the client.

If a byte slice or an io.Reader is supplied to params, it will be used as-is for the request body.

The params is by default serialized into the body using encoding/json. If your type implements a MarshalJSON function, it will be used instead to serialize the request. If a URLQuery method is implemented, the returned url.Values will be used as query strings to the url.

If your params struct uses param.Field, you must provide either [MarshalJSON], [URLQuery], and/or [MarshalForm] functions. It is undefined behavior to use a struct uses param.Field without specifying how it is serialized.

Any "…Params" object defined in this library can be used as the request argument. Note that 'path' arguments will not be forwarded into the url.

The response body will be deserialized into the res variable, depending on its type:

  • A pointer to a *http.Response is populated by the raw response.
  • A pointer to a byte array will be populated with the contents of the request body.
  • A pointer to any other type uses this library's default JSON decoding, which respects UnmarshalJSON if it is defined on the type.
  • A nil value will not read the response body.

For even greater flexibility, see option.WithResponseInto and option.WithResponseBodyInto.

func (*Client) Get 

func (r *Client) Get(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Get makes a GET request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Patch 

func (r *Client) Patch(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Patch makes a PATCH request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Post 

func (r *Client) Post(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Post makes a POST request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Put 

func (r *Client) Put(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Put makes a PUT request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

type CreateTaskParam added in v0.2.0 

type CreateTaskParam struct {
	// Worker id the task belongs to.
	WorkerID string `json:"workerId" api:"required"`
	CreateWorkerParam
}

func (CreateTaskParam) MarshalJSON added in v0.2.0 

func (r CreateTaskParam) MarshalJSON() (data []byte, err error)

type CreateWorkerParam 

type CreateWorkerParam struct {
	// Persistent system prompt the worker uses for every task it runs.
	Instructions param.Opt[string] `json:"instructions,omitzero"`
	// Natural-language description of the worker to use for AI-generated instructions
	// when `instructions` is omitted.
	Prompt param.Opt[string] `json:"prompt,omitzero"`
	// Optional display name. When omitted, Handinger assigns a random dog-themed name.
	Title param.Opt[string] `json:"title,omitzero"`
	// `public` (default) is visible to all org members. `private` is only visible to
	// invited members.
	//
	// Any of "public", "private".
	Visibility CreateWorkerVisibility `json:"visibility,omitzero"`
	// contains filtered or unexported fields
}

func (CreateWorkerParam) MarshalJSON 

func (r CreateWorkerParam) MarshalJSON() (data []byte, err error)

func (*CreateWorkerParam) UnmarshalJSON 

func (r *CreateWorkerParam) UnmarshalJSON(data []byte) error

type CreateWorkerVisibility added in v0.2.0 

type CreateWorkerVisibility string

`public` (default) is visible to all org members. `private` is only visible to invited members. 

const (
	CreateWorkerVisibilityPublic  CreateWorkerVisibility = "public"
	CreateWorkerVisibilityPrivate CreateWorkerVisibility = "private"
)

type Error 

type Error = apierror.Error

type Task added in v0.2.0 

type Task struct {
	ID              string `json:"id" api:"required"`
	CompletedAt     string `json:"completedAt" api:"required"`
	CreatedAt       string `json:"createdAt" api:"required"`
	CreatedByUserID string `json:"createdByUserId" api:"required"`
	OrganizationID  string `json:"organizationId" api:"required"`
	// Any of "pending", "running", "completed", "error", "aborted".
	Status TaskStatus `json:"status" api:"required"`
	Title  string     `json:"title" api:"required"`
	Totals TaskTotals `json:"totals" api:"required"`
	// Any of "api", "email", "schedule", "ui".
	TriggeredBy TaskTriggeredBy `json:"triggeredBy" api:"required"`
	WorkerID    string          `json:"workerId" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID              respjson.Field
		CompletedAt     respjson.Field
		CreatedAt       respjson.Field
		CreatedByUserID respjson.Field
		OrganizationID  respjson.Field
		Status          respjson.Field
		Title           respjson.Field
		Totals          respjson.Field
		TriggeredBy     respjson.Field
		WorkerID        respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (Task) RawJSON added in v0.2.0 

func (r Task) RawJSON() string

Returns the unmodified JSON received from the API

func (*Task) UnmarshalJSON added in v0.2.0 

func (r *Task) UnmarshalJSON(data []byte) error

type TaskNewParams added in v0.2.0 

type TaskNewParams struct {
	CreateTask CreateTaskParam
	// contains filtered or unexported fields
}

func (TaskNewParams) MarshalJSON added in v0.2.0 

func (r TaskNewParams) MarshalJSON() (data []byte, err error)

func (*TaskNewParams) UnmarshalJSON added in v0.2.0 

func (r *TaskNewParams) UnmarshalJSON(data []byte) error

type TaskService added in v0.2.0 

type TaskService struct {
	// contains filtered or unexported fields
}

Run and inspect tasks against a worker.

TaskService contains methods and other services that help with interacting with the handinger API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTaskService method instead.

func NewTaskService added in v0.2.0 

func NewTaskService(opts ...option.RequestOption) (r TaskService)

NewTaskService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TaskService) Get added in v0.2.0 

func (r *TaskService) Get(ctx context.Context, taskID string, opts ...option.RequestOption) (res *TaskWithTurns, err error)

Retrieve a single task and its individual turns.

func (*TaskService) New added in v0.2.0 

func (r *TaskService) New(ctx context.Context, body TaskNewParams, opts ...option.RequestOption) (res *Worker, err error)

Run a new task against an existing worker. Send `multipart/form-data` to attach files; the bytes are bootstrapped into the worker's workspace before the task starts.

type TaskStatus added in v0.2.0 

type TaskStatus string
const (
	TaskStatusPending   TaskStatus = "pending"
	TaskStatusRunning   TaskStatus = "running"
	TaskStatusCompleted TaskStatus = "completed"
	TaskStatusError     TaskStatus = "error"
	TaskStatusAborted   TaskStatus = "aborted"
)

type TaskTotals added in v0.2.0 

type TaskTotals struct {
	Credits    float64 `json:"credits" api:"required"`
	DurationMs float64 `json:"durationMs" api:"required"`
	TurnCount  float64 `json:"turnCount" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Credits     respjson.Field
		DurationMs  respjson.Field
		TurnCount   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (TaskTotals) RawJSON added in v0.2.0 

func (r TaskTotals) RawJSON() string

Returns the unmodified JSON received from the API

func (*TaskTotals) UnmarshalJSON added in v0.2.0 

func (r *TaskTotals) UnmarshalJSON(data []byte) error

type TaskTriggeredBy added in v0.2.0 

type TaskTriggeredBy string
const (
	TaskTriggeredByAPI      TaskTriggeredBy = "api"
	TaskTriggeredByEmail    TaskTriggeredBy = "email"
	TaskTriggeredBySchedule TaskTriggeredBy = "schedule"
	TaskTriggeredByUi       TaskTriggeredBy = "ui"
)

type TaskWithTurns added in v0.2.0 

type TaskWithTurns struct {
	Task  Task                `json:"task" api:"required"`
	Turns []TaskWithTurnsTurn `json:"turns" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Task        respjson.Field
		Turns       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (TaskWithTurns) RawJSON added in v0.2.0 

func (r TaskWithTurns) RawJSON() string

Returns the unmodified JSON received from the API

func (*TaskWithTurns) UnmarshalJSON added in v0.2.0 

func (r *TaskWithTurns) UnmarshalJSON(data []byte) error

type TaskWithTurnsTurn added in v0.2.0 

type TaskWithTurnsTurn struct {
	ID           string  `json:"id" api:"required"`
	CompletedAt  string  `json:"completedAt" api:"required"`
	Credits      float64 `json:"credits" api:"required"`
	DurationMs   int64   `json:"durationMs" api:"required"`
	Input        string  `json:"input" api:"required"`
	InputTokens  int64   `json:"inputTokens" api:"required"`
	OutputText   string  `json:"outputText" api:"required"`
	OutputTokens int64   `json:"outputTokens" api:"required"`
	Role         string  `json:"role" api:"required"`
	Seq          int64   `json:"seq" api:"required"`
	StartedAt    string  `json:"startedAt" api:"required"`
	Status       string  `json:"status" api:"required"`
	TaskID       string  `json:"taskId" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID           respjson.Field
		CompletedAt  respjson.Field
		Credits      respjson.Field
		DurationMs   respjson.Field
		Input        respjson.Field
		InputTokens  respjson.Field
		OutputText   respjson.Field
		OutputTokens respjson.Field
		Role         respjson.Field
		Seq          respjson.Field
		StartedAt    respjson.Field
		Status       respjson.Field
		TaskID       respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (TaskWithTurnsTurn) RawJSON added in v0.2.0 

func (r TaskWithTurnsTurn) RawJSON() string

Returns the unmodified JSON received from the API

func (*TaskWithTurnsTurn) UnmarshalJSON added in v0.2.0 

func (r *TaskWithTurnsTurn) UnmarshalJSON(data []byte) error

type Worker 

type Worker struct {
	ID                string         `json:"id" api:"required"`
	CreatedAt         int64          `json:"created_at" api:"required"`
	Error             any            `json:"error" api:"required"`
	Files             []WorkerFile   `json:"files" api:"required"`
	IncompleteDetails any            `json:"incomplete_details" api:"required"`
	Messages          []any          `json:"messages" api:"required"`
	Metadata          map[string]any `json:"metadata" api:"required"`
	// Any of "worker".
	Object     WorkerObject   `json:"object" api:"required"`
	Output     []WorkerOutput `json:"output" api:"required"`
	OutputText string         `json:"output_text" api:"required"`
	Running    bool           `json:"running" api:"required"`
	Sources    []WorkerSource `json:"sources" api:"required"`
	// Any of "running", "completed", "pending".
	Status WorkerStatus `json:"status" api:"required"`
	Usage  WorkerUsage  `json:"usage"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                respjson.Field
		CreatedAt         respjson.Field
		Error             respjson.Field
		Files             respjson.Field
		IncompleteDetails respjson.Field
		Messages          respjson.Field
		Metadata          respjson.Field
		Object            respjson.Field
		Output            respjson.Field
		OutputText        respjson.Field
		Running           respjson.Field
		Sources           respjson.Field
		Status            respjson.Field
		Usage             respjson.Field
		ExtraFields       map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (Worker) RawJSON 

func (r Worker) RawJSON() string

Returns the unmodified JSON received from the API

func (*Worker) UnmarshalJSON 

func (r *Worker) UnmarshalJSON(data []byte) error

type WorkerFile 

type WorkerFile struct {
	Filename  string `json:"filename" api:"required"`
	MediaType string `json:"mediaType" api:"required"`
	URL       string `json:"url" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Filename    respjson.Field
		MediaType   respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WorkerFile) RawJSON 

func (r WorkerFile) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerFile) UnmarshalJSON 

func (r *WorkerFile) UnmarshalJSON(data []byte) error

type WorkerGetEmailResponse added in v0.5.0 

type WorkerGetEmailResponse struct {
	Email string `json:"email" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Email       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WorkerGetEmailResponse) RawJSON added in v0.5.0 

func (r WorkerGetEmailResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerGetEmailResponse) UnmarshalJSON added in v0.5.0 

func (r *WorkerGetEmailResponse) UnmarshalJSON(data []byte) error

type WorkerGetParams 

type WorkerGetParams struct {
	// Set to "true" to receive a server-sent event stream that replays all stored
	// messages and then continues with live chunks from the active task (if any)
	// before closing.
	//
	// Any of "true", "false".
	Stream WorkerGetParamsStream `query:"stream,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (WorkerGetParams) URLQuery 

func (r WorkerGetParams) URLQuery() (v url.Values, err error)

URLQuery serializes WorkerGetParams's query parameters as `url.Values`.

type WorkerGetParamsStream added in v0.1.0 

type WorkerGetParamsStream string

Set to "true" to receive a server-sent event stream that replays all stored messages and then continues with live chunks from the active task (if any) before closing. 

const (
	WorkerGetParamsStreamTrue  WorkerGetParamsStream = "true"
	WorkerGetParamsStreamFalse WorkerGetParamsStream = "false"
)

type WorkerNewParams 

type WorkerNewParams struct {
	CreateWorker CreateWorkerParam
	// contains filtered or unexported fields
}

func (WorkerNewParams) MarshalJSON 

func (r WorkerNewParams) MarshalJSON() (data []byte, err error)

func (*WorkerNewParams) UnmarshalJSON 

func (r *WorkerNewParams) UnmarshalJSON(data []byte) error

type WorkerNewResponse added in v0.2.0 

type WorkerNewResponse struct {
	ID             string `json:"id" api:"required"`
	CreatedAt      string `json:"createdAt" api:"required"`
	Instructions   string `json:"instructions" api:"required"`
	OrganizationID string `json:"organizationId" api:"required"`
	Title          string `json:"title" api:"required"`
	UpdatedAt      string `json:"updatedAt" api:"required"`
	UserID         string `json:"userId" api:"required"`
	// Any of "public", "private".
	Visibility WorkerNewResponseVisibility `json:"visibility" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID             respjson.Field
		CreatedAt      respjson.Field
		Instructions   respjson.Field
		OrganizationID respjson.Field
		Title          respjson.Field
		UpdatedAt      respjson.Field
		UserID         respjson.Field
		Visibility     respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WorkerNewResponse) RawJSON added in v0.2.0 

func (r WorkerNewResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerNewResponse) UnmarshalJSON added in v0.2.0 

func (r *WorkerNewResponse) UnmarshalJSON(data []byte) error

type WorkerNewResponseVisibility added in v0.2.0 

type WorkerNewResponseVisibility string
const (
	WorkerNewResponseVisibilityPublic  WorkerNewResponseVisibility = "public"
	WorkerNewResponseVisibilityPrivate WorkerNewResponseVisibility = "private"
)

type WorkerObject 

type WorkerObject string
const (
	WorkerObjectWorker WorkerObject = "worker"
)

type WorkerOutput 

type WorkerOutput struct {
	ID      string                `json:"id" api:"required"`
	Content []WorkerOutputContent `json:"content" api:"required"`
	// Any of "assistant".
	Role string `json:"role" api:"required"`
	// Any of "completed".
	Status string `json:"status" api:"required"`
	// Any of "message".
	Type string `json:"type" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Content     respjson.Field
		Role        respjson.Field
		Status      respjson.Field
		Type        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WorkerOutput) RawJSON 

func (r WorkerOutput) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerOutput) UnmarshalJSON 

func (r *WorkerOutput) UnmarshalJSON(data []byte) error

type WorkerOutputContent 

type WorkerOutputContent struct {
	Text string `json:"text" api:"required"`
	// Any of "output_text".
	Type string `json:"type" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Text        respjson.Field
		Type        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WorkerOutputContent) RawJSON 

func (r WorkerOutputContent) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerOutputContent) UnmarshalJSON 

func (r *WorkerOutputContent) UnmarshalJSON(data []byte) error

type WorkerScheduleCancelParams 

type WorkerScheduleCancelParams struct {
	WorkerID string `path:"workerId" api:"required" json:"-"`
	// contains filtered or unexported fields
}

type WorkerScheduleCancelResponse 

type WorkerScheduleCancelResponse struct {
	Cancelled bool `json:"cancelled" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Cancelled   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WorkerScheduleCancelResponse) RawJSON 

func (r WorkerScheduleCancelResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerScheduleCancelResponse) UnmarshalJSON 

func (r *WorkerScheduleCancelResponse) UnmarshalJSON(data []byte) error

type WorkerScheduleCron added in v0.1.0 

type WorkerScheduleCron struct {
	ID string `json:"id" api:"required"`
	// Any of "low", "standard", "high", "unlimited".
	Budget    string        `json:"budget" api:"required"`
	Cron      string        `json:"cron" api:"required"`
	Input     string        `json:"input" api:"required"`
	NextRunAt time.Time     `json:"nextRunAt" api:"required" format:"date-time"`
	Type      constant.Cron `json:"type" default:"cron"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Budget      respjson.Field
		Cron        respjson.Field
		Input       respjson.Field
		NextRunAt   respjson.Field
		Type        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WorkerScheduleCron) RawJSON added in v0.1.0 

func (r WorkerScheduleCron) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerScheduleCron) UnmarshalJSON added in v0.1.0 

func (r *WorkerScheduleCron) UnmarshalJSON(data []byte) error

type WorkerScheduleDelayed added in v0.1.0 

type WorkerScheduleDelayed struct {
	ID string `json:"id" api:"required"`
	// Any of "low", "standard", "high", "unlimited".
	Budget         string           `json:"budget" api:"required"`
	DelayInSeconds int64            `json:"delayInSeconds" api:"required"`
	Input          string           `json:"input" api:"required"`
	NextRunAt      time.Time        `json:"nextRunAt" api:"required" format:"date-time"`
	Type           constant.Delayed `json:"type" default:"delayed"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID             respjson.Field
		Budget         respjson.Field
		DelayInSeconds respjson.Field
		Input          respjson.Field
		NextRunAt      respjson.Field
		Type           respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WorkerScheduleDelayed) RawJSON added in v0.1.0 

func (r WorkerScheduleDelayed) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerScheduleDelayed) UnmarshalJSON added in v0.1.0 

func (r *WorkerScheduleDelayed) UnmarshalJSON(data []byte) error

type WorkerScheduleInterval added in v0.1.0 

type WorkerScheduleInterval struct {
	ID string `json:"id" api:"required"`
	// Any of "low", "standard", "high", "unlimited".
	Budget          string            `json:"budget" api:"required"`
	Input           string            `json:"input" api:"required"`
	IntervalSeconds int64             `json:"intervalSeconds" api:"required"`
	NextRunAt       time.Time         `json:"nextRunAt" api:"required" format:"date-time"`
	Type            constant.Interval `json:"type" default:"interval"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID              respjson.Field
		Budget          respjson.Field
		Input           respjson.Field
		IntervalSeconds respjson.Field
		NextRunAt       respjson.Field
		Type            respjson.Field
		ExtraFields     map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WorkerScheduleInterval) RawJSON added in v0.1.0 

func (r WorkerScheduleInterval) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerScheduleInterval) UnmarshalJSON added in v0.1.0 

func (r *WorkerScheduleInterval) UnmarshalJSON(data []byte) error

type WorkerScheduleListResponse 

type WorkerScheduleListResponse struct {
	Schedules []WorkerScheduleUnion `json:"schedules" api:"required"`
	WorkerID  string                `json:"workerId" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Schedules   respjson.Field
		WorkerID    respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WorkerScheduleListResponse) RawJSON 

func (r WorkerScheduleListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerScheduleListResponse) UnmarshalJSON 

func (r *WorkerScheduleListResponse) UnmarshalJSON(data []byte) error

type WorkerScheduleNewParams 

type WorkerScheduleNewParams struct {
	Input string                           `json:"input" api:"required"`
	When  WorkerScheduleNewParamsWhenUnion `json:"when,omitzero" api:"required"`
	// Any of "low", "standard", "high", "unlimited".
	Budget WorkerScheduleNewParamsBudget `json:"budget,omitzero"`
	// contains filtered or unexported fields
}

func (WorkerScheduleNewParams) MarshalJSON 

func (r WorkerScheduleNewParams) MarshalJSON() (data []byte, err error)

func (*WorkerScheduleNewParams) UnmarshalJSON 

func (r *WorkerScheduleNewParams) UnmarshalJSON(data []byte) error

type WorkerScheduleNewParamsBudget 

type WorkerScheduleNewParamsBudget string
const (
	WorkerScheduleNewParamsBudgetLow       WorkerScheduleNewParamsBudget = "low"
	WorkerScheduleNewParamsBudgetStandard  WorkerScheduleNewParamsBudget = "standard"
	WorkerScheduleNewParamsBudgetHigh      WorkerScheduleNewParamsBudget = "high"
	WorkerScheduleNewParamsBudgetUnlimited WorkerScheduleNewParamsBudget = "unlimited"
)

type WorkerScheduleNewParamsWhenCron added in v0.1.0 

type WorkerScheduleNewParamsWhenCron struct {
	Cron string `json:"cron" api:"required"`
	// This field can be elided, and will marshal its zero value as "cron".
	Type constant.Cron `json:"type" default:"cron"`
	// contains filtered or unexported fields
}

The properties Cron, Type are required.

func (WorkerScheduleNewParamsWhenCron) MarshalJSON added in v0.1.0 

func (r WorkerScheduleNewParamsWhenCron) MarshalJSON() (data []byte, err error)

func (*WorkerScheduleNewParamsWhenCron) UnmarshalJSON added in v0.1.0 

func (r *WorkerScheduleNewParamsWhenCron) UnmarshalJSON(data []byte) error

type WorkerScheduleNewParamsWhenDelayed added in v0.1.0 

type WorkerScheduleNewParamsWhenDelayed struct {
	DelayInSeconds int64 `json:"delayInSeconds" api:"required"`
	// This field can be elided, and will marshal its zero value as "delayed".
	Type constant.Delayed `json:"type" default:"delayed"`
	// contains filtered or unexported fields
}

The properties DelayInSeconds, Type are required.

func (WorkerScheduleNewParamsWhenDelayed) MarshalJSON added in v0.1.0 

func (r WorkerScheduleNewParamsWhenDelayed) MarshalJSON() (data []byte, err error)

func (*WorkerScheduleNewParamsWhenDelayed) UnmarshalJSON added in v0.1.0 

func (r *WorkerScheduleNewParamsWhenDelayed) UnmarshalJSON(data []byte) error

type WorkerScheduleNewParamsWhenInterval added in v0.1.0 

type WorkerScheduleNewParamsWhenInterval struct {
	IntervalSeconds int64 `json:"intervalSeconds" api:"required"`
	// This field can be elided, and will marshal its zero value as "interval".
	Type constant.Interval `json:"type" default:"interval"`
	// contains filtered or unexported fields
}

The properties IntervalSeconds, Type are required.

func (WorkerScheduleNewParamsWhenInterval) MarshalJSON added in v0.1.0 

func (r WorkerScheduleNewParamsWhenInterval) MarshalJSON() (data []byte, err error)

func (*WorkerScheduleNewParamsWhenInterval) UnmarshalJSON added in v0.1.0 

func (r *WorkerScheduleNewParamsWhenInterval) UnmarshalJSON(data []byte) error

type WorkerScheduleNewParamsWhenScheduled added in v0.1.0 

type WorkerScheduleNewParamsWhenScheduled struct {
	Date time.Time `json:"date" api:"required" format:"date-time"`
	// This field can be elided, and will marshal its zero value as "scheduled".
	Type constant.Scheduled `json:"type" default:"scheduled"`
	// contains filtered or unexported fields
}

The properties Date, Type are required.

func (WorkerScheduleNewParamsWhenScheduled) MarshalJSON added in v0.1.0 

func (r WorkerScheduleNewParamsWhenScheduled) MarshalJSON() (data []byte, err error)

func (*WorkerScheduleNewParamsWhenScheduled) UnmarshalJSON added in v0.1.0 

func (r *WorkerScheduleNewParamsWhenScheduled) UnmarshalJSON(data []byte) error

type WorkerScheduleNewParamsWhenUnion 

type WorkerScheduleNewParamsWhenUnion struct {
	OfScheduled *WorkerScheduleNewParamsWhenScheduled `json:",omitzero,inline"`
	OfDelayed   *WorkerScheduleNewParamsWhenDelayed   `json:",omitzero,inline"`
	OfCron      *WorkerScheduleNewParamsWhenCron      `json:",omitzero,inline"`
	OfInterval  *WorkerScheduleNewParamsWhenInterval  `json:",omitzero,inline"`
	// contains filtered or unexported fields
}

Only one field can be non-zero.

Use param.IsOmitted to confirm if a field is set.

func (WorkerScheduleNewParamsWhenUnion) MarshalJSON 

func (u WorkerScheduleNewParamsWhenUnion) MarshalJSON() ([]byte, error)

func (*WorkerScheduleNewParamsWhenUnion) UnmarshalJSON 

func (u *WorkerScheduleNewParamsWhenUnion) UnmarshalJSON(data []byte) error

type WorkerScheduleScheduled added in v0.1.0 

type WorkerScheduleScheduled struct {
	ID string `json:"id" api:"required"`
	// Any of "low", "standard", "high", "unlimited".
	Budget    string             `json:"budget" api:"required"`
	Input     string             `json:"input" api:"required"`
	NextRunAt time.Time          `json:"nextRunAt" api:"required" format:"date-time"`
	Type      constant.Scheduled `json:"type" default:"scheduled"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Budget      respjson.Field
		Input       respjson.Field
		NextRunAt   respjson.Field
		Type        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WorkerScheduleScheduled) RawJSON added in v0.1.0 

func (r WorkerScheduleScheduled) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerScheduleScheduled) UnmarshalJSON added in v0.1.0 

func (r *WorkerScheduleScheduled) UnmarshalJSON(data []byte) error

type WorkerScheduleService 

type WorkerScheduleService struct {
	// contains filtered or unexported fields
}

Manage future and recurring worker tasks.

WorkerScheduleService contains methods and other services that help with interacting with the handinger API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewWorkerScheduleService method instead.

func NewWorkerScheduleService 

func NewWorkerScheduleService(opts ...option.RequestOption) (r WorkerScheduleService)

NewWorkerScheduleService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*WorkerScheduleService) Cancel 

func (r *WorkerScheduleService) Cancel(ctx context.Context, scheduleID string, body WorkerScheduleCancelParams, opts ...option.RequestOption) (res *WorkerScheduleCancelResponse, err error)

Cancel a scheduled task for a worker.

func (*WorkerScheduleService) List 

func (r *WorkerScheduleService) List(ctx context.Context, workerID string, opts ...option.RequestOption) (res *WorkerScheduleListResponse, err error)

List scheduled tasks for a worker.

func (*WorkerScheduleService) New 

func (r *WorkerScheduleService) New(ctx context.Context, workerID string, body WorkerScheduleNewParams, opts ...option.RequestOption) (res *WorkerScheduleUnion, err error)

Schedule a worker instruction for a future or recurring run.

type WorkerScheduleUnion 

type WorkerScheduleUnion struct {
	ID        string    `json:"id"`
	Budget    string    `json:"budget"`
	Input     string    `json:"input"`
	NextRunAt time.Time `json:"nextRunAt"`
	// Any of "scheduled", "delayed", "cron", "interval".
	Type string `json:"type"`
	// This field is from variant [WorkerScheduleDelayed].
	DelayInSeconds int64 `json:"delayInSeconds"`
	// This field is from variant [WorkerScheduleCron].
	Cron string `json:"cron"`
	// This field is from variant [WorkerScheduleInterval].
	IntervalSeconds int64 `json:"intervalSeconds"`
	JSON            struct {
		ID              respjson.Field
		Budget          respjson.Field
		Input           respjson.Field
		NextRunAt       respjson.Field
		Type            respjson.Field
		DelayInSeconds  respjson.Field
		Cron            respjson.Field
		IntervalSeconds respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

WorkerScheduleUnion contains all possible properties and values from WorkerScheduleScheduled, WorkerScheduleDelayed, WorkerScheduleCron, WorkerScheduleInterval.

Use the WorkerScheduleUnion.AsAny method to switch on the variant.

Use the methods beginning with 'As' to cast the union to one of its variants.

func (WorkerScheduleUnion) AsAny added in v0.1.0 

func (u WorkerScheduleUnion) AsAny() anyWorkerSchedule

Use the following switch statement to find the correct variant 

switch variant := WorkerScheduleUnion.AsAny().(type) {
case handinger.WorkerScheduleScheduled:
case handinger.WorkerScheduleDelayed:
case handinger.WorkerScheduleCron:
case handinger.WorkerScheduleInterval:
default:
  fmt.Errorf("no variant present")
}

func (WorkerScheduleUnion) AsCron added in v0.1.0 

func (u WorkerScheduleUnion) AsCron() (v WorkerScheduleCron)

func (WorkerScheduleUnion) AsDelayed added in v0.1.0 

func (u WorkerScheduleUnion) AsDelayed() (v WorkerScheduleDelayed)

func (WorkerScheduleUnion) AsInterval added in v0.1.0 

func (u WorkerScheduleUnion) AsInterval() (v WorkerScheduleInterval)

func (WorkerScheduleUnion) AsScheduled added in v0.1.0 

func (u WorkerScheduleUnion) AsScheduled() (v WorkerScheduleScheduled)

func (WorkerScheduleUnion) RawJSON 

func (u WorkerScheduleUnion) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerScheduleUnion) UnmarshalJSON 

func (r *WorkerScheduleUnion) UnmarshalJSON(data []byte) error

type WorkerService 

type WorkerService struct {

	// Manage future and recurring worker tasks.
	Schedules WorkerScheduleService
	// contains filtered or unexported fields
}

Create, retrieve, and manage agent worker templates.

WorkerService contains methods and other services that help with interacting with the handinger API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewWorkerService method instead.

func NewWorkerService 

func NewWorkerService(opts ...option.RequestOption) (r WorkerService)

NewWorkerService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*WorkerService) Get 

func (r *WorkerService) Get(ctx context.Context, workerID string, query WorkerGetParams, opts ...option.RequestOption) (res *Worker, err error)

Retrieve the current worker state and messages from its most recent task. Returns a JSON worker object by default, or a server-sent event stream when `stream=true`.

func (*WorkerService) GetEmail 

func (r *WorkerService) GetEmail(ctx context.Context, workerID string, opts ...option.RequestOption) (res *WorkerGetEmailResponse, err error)

Retrieve the inbound email address for a worker.

func (*WorkerService) New 

func (r *WorkerService) New(ctx context.Context, body WorkerNewParams, opts ...option.RequestOption) (res *WorkerNewResponse, err error)

Create a new worker. The worker is a reusable agent template; tasks are runs against this template. Use `POST /tasks` to actually run the agent.

type WorkerSource 

type WorkerSource struct {
	ID    string `json:"id" api:"required"`
	Title string `json:"title" api:"required"`
	// Any of "url".
	Type string `json:"type" api:"required"`
	URL  string `json:"url" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Title       respjson.Field
		Type        respjson.Field
		URL         respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WorkerSource) RawJSON 

func (r WorkerSource) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerSource) UnmarshalJSON 

func (r *WorkerSource) UnmarshalJSON(data []byte) error

type WorkerStatus 

type WorkerStatus string
const (
	WorkerStatusRunning   WorkerStatus = "running"
	WorkerStatusCompleted WorkerStatus = "completed"
	WorkerStatusPending   WorkerStatus = "pending"
)

type WorkerUsage 

type WorkerUsage struct {
	Credits    int64 `json:"credits"`
	DurationMs int64 `json:"durationMs"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Credits     respjson.Field
		DurationMs  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (WorkerUsage) RawJSON 

func (r WorkerUsage) RawJSON() string

Returns the unmodified JSON received from the API

func (*WorkerUsage) UnmarshalJSON 

func (r *WorkerUsage) UnmarshalJSON(data []byte) error

Source Files

View all Source files

Directories

Path Synopsis
apierror
apiform
apijson
apiquery
encoding/json
Package json implements encoding and decoding of JSON as defined in RFC 7159.
 Package json implements encoding and decoding of JSON as defined in RFC 7159.
encoding/json/sentinel
encoding/json/shims
This package provides shims over Go 1.2{2,3} APIs which are missing from Go 1.22, and used by the Go 1.24 encoding/json package.
 This package provides shims over Go 1.2{2,3} APIs which are missing from Go 1.22, and used by the Go 1.24 encoding/json package.
paramutil
requestconfig
testutil
packages
param
respjson
shared
constant

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.