client

package
v0.1.5 Latest Latest
Warning

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

Go to latest
Published: Sep 24, 2026 License: MIT Imports: 12 Imported by: 0

README

Go API client

Import github.com/orpheus-agents/orpheus/client using the Orpheus release tag. Go 1.27 or newer is required. This is a package in the root module, with the same version as the server; there is no separate client/vX.Y.Z tag or nested module. The first release containing this package must be newer than v0.1.0.

client.gen.go is generated from ../api/openapi.yaml using ../api/oapi-client.yaml. Do not edit it manually. The generator version is pinned in the root go.mod; consumers use the committed code without running a generator.

Requests and responses

import (
    "context"
    "fmt"
    "net/http"
    "time"

    "github.com/orpheus-agents/orpheus/client"
)

func create(ctx context.Context, baseURL, token, idempotencyKey string) (*client.Accepted, error) {
    api, err := client.NewClientWithResponses(baseURL,
        client.WithHTTPClient(&http.Client{Timeout: 30 * time.Second}),
        client.WithRequestEditorFn(func(_ context.Context, r *http.Request) error {
            r.Header.Set("Authorization", "Bearer "+token)
            return nil
        }),
    )
    if err != nil {
        return nil, err
    }
    response, err := api.CreateSessionWithResponse(ctx,
        &client.CreateSessionParams{IdempotencyKey: &idempotencyKey},
        client.CreateSession{
            Namespace: new("my-connector"),
            ExternalKey: new("source:thread-id"),
            Configuration: client.ConfigurationInput{
                Agent: client.AgentInput{Profile: "default"},
                Sandbox: client.SandboxInput{Template: "my-template"},
            },
            Message: client.TextMessage{Text: "Hello", ExternalKey: new("source:post-id")},
        },
    )
    if err != nil {
        return nil, err
    }
    if response.StatusCode() != http.StatusAccepted || response.JSON202 == nil {
        return nil, fmt.Errorf("create session: HTTP %d", response.StatusCode())
    }
    return response.JSON202, nil
}

Pass the server origin, optionally with a reverse-proxy path prefix, rather than a URL ending in /api/v1. The generated methods append the API paths.

  • ClientWithResponses reads and closes JSON response bodies. A nil Go error is not proof of API success: inspect StatusCode() and JSON200/JSON202 or the corresponding error field, such as JSON409.Error.Code.
  • Unknown statuses and non-JSON bodies remain available in Body and HTTPResponse. Headers such as Retry-After are preserved. Accepted responses also expose typed Headers202.Location.
  • The raw methods return *http.Response; the caller must close Body.
  • Retries and pagination are explicit. Reuse the same idempotency key and body for a retried mutation; an unclear transport result must not create a new job. Follow NextCursor (and HasMore for events) without interpreting opaque cursors.
  • Event, history and hook-output unions expose Discriminator/As… helpers where specified by OpenAPI. Inspect the discriminator before selecting a variant; unmarshalling into a different variant is not semantic validation.

SSE

Use api.StreamEvents(ctx, sessionID, params) to get the streaming response; check the status and content type before reading, and close Body when done. StreamEventsParams exposes both After and LastEventID; the server gives Last-Event-ID precedence. Cancel the request context to stop streaming.

Do not use StreamEventsWithResponse for a live stream. Like the other generated response parsers, it reads until EOF. Use a separate HTTP client or request context with an appropriate lifetime; a short JSON-request timeout would also terminate an SSE stream. SSE parsing, cursor persistence and reconnection policy belong to the connector. REST history/events remain available for recovery.

Development

make generate-client
make generate-client-check
make test-client build-client

The full make generate and make check include this package. Release tags run only make build-client before image publication; generation checks and tests remain in branch/PR CI. External consumers of the generated API are not visible to the server's dead-code analysis; that check remains restricted to the server and its internal tooling.

Documentation

Overview

Package client provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Package client provides the HTTP client and wire types generated from the Orpheus OpenAPI specification. Its version matches the repository's release tag.

NewClientWithResponses parses JSON responses. A nil error only means that the HTTP exchange and parsing succeeded: callers must also check StatusCode and the appropriate JSON field. Retries, pagination and durable delivery are owned by the integration, not the transport client.

Use the raw StreamEvents method for SSE and close its response body when done. StreamEventsWithResponse buffers the entire response and must not be used for a long-lived stream. Set request deadlines or supply a custom HTTP client; the generated client's default transport has no overall timeout.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCancelRunRequest

func NewCancelRunRequest(server string, sid openapi_types.UUID, rid openapi_types.UUID) (*http.Request, error)

NewCancelRunRequest constructs an http.Request for the CancelRun method

func NewCreateRunRequest

func NewCreateRunRequest(server string, sid openapi_types.UUID, params *CreateRunParams, body CreateRunJSONRequestBody) (*http.Request, error)

NewCreateRunRequest calls the generic CreateRun builder with application/json body

func NewCreateRunRequestWithBody

func NewCreateRunRequestWithBody(server string, sid openapi_types.UUID, params *CreateRunParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateRunRequestWithBody constructs an http.Request for the CreateRun method, with any body, and a specified content type

func NewCreateSessionRequest

func NewCreateSessionRequest(server string, params *CreateSessionParams, body CreateSessionJSONRequestBody) (*http.Request, error)

NewCreateSessionRequest calls the generic CreateSession builder with application/json body

func NewCreateSessionRequestWithBody

func NewCreateSessionRequestWithBody(server string, params *CreateSessionParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateSessionRequestWithBody constructs an http.Request for the CreateSession method, with any body, and a specified content type

func NewGetEventsRequest

func NewGetEventsRequest(server string, sid openapi_types.UUID, params *GetEventsParams) (*http.Request, error)

NewGetEventsRequest constructs an http.Request for the GetEvents method

func NewGetHistoryRequest

func NewGetHistoryRequest(server string, sid openapi_types.UUID, params *GetHistoryParams) (*http.Request, error)

NewGetHistoryRequest constructs an http.Request for the GetHistory method

func NewGetRunRequest

func NewGetRunRequest(server string, sid openapi_types.UUID, rid openapi_types.UUID) (*http.Request, error)

NewGetRunRequest constructs an http.Request for the GetRun method

func NewGetSessionRequest

func NewGetSessionRequest(server string, sid openapi_types.UUID) (*http.Request, error)

NewGetSessionRequest constructs an http.Request for the GetSession method

func NewHealthRequest

func NewHealthRequest(server string) (*http.Request, error)

NewHealthRequest constructs an http.Request for the Health method

func NewListAllRunsRequest

func NewListAllRunsRequest(server string, params *ListAllRunsParams) (*http.Request, error)

NewListAllRunsRequest constructs an http.Request for the ListAllRuns method

func NewListRunsRequest

func NewListRunsRequest(server string, sid openapi_types.UUID, params *ListRunsParams) (*http.Request, error)

NewListRunsRequest constructs an http.Request for the ListRuns method

func NewListSessionsRequest

func NewListSessionsRequest(server string, params *ListSessionsParams) (*http.Request, error)

NewListSessionsRequest constructs an http.Request for the ListSessions method

func NewReadyRequest

func NewReadyRequest(server string) (*http.Request, error)

NewReadyRequest constructs an http.Request for the Ready method

func NewSendMessageRequest

func NewSendMessageRequest(server string, sid openapi_types.UUID, rid openapi_types.UUID, params *SendMessageParams, body SendMessageJSONRequestBody) (*http.Request, error)

NewSendMessageRequest calls the generic SendMessage builder with application/json body

func NewSendMessageRequestWithBody

func NewSendMessageRequestWithBody(server string, sid openapi_types.UUID, rid openapi_types.UUID, params *SendMessageParams, contentType string, body io.Reader) (*http.Request, error)

NewSendMessageRequestWithBody constructs an http.Request for the SendMessage method, with any body, and a specified content type

func NewStreamEventsRequest

func NewStreamEventsRequest(server string, sid openapi_types.UUID, params *StreamEventsParams) (*http.Request, error)

NewStreamEventsRequest constructs an http.Request for the StreamEvents method

Types

type Accepted

type Accepted struct {
	MessageID openapi_types.UUID `json:"message_id"`
	RunID     openapi_types.UUID `json:"run_id"`
	SessionID openapi_types.UUID `json:"session_id"`
}

Accepted defines model for Accepted.

type AgentConfiguration

type AgentConfiguration struct {
	Instructions string `json:"instructions"`
	Model        string `json:"model"`
	Profile      string `json:"profile"`
}

AgentConfiguration defines model for AgentConfiguration.

type AgentInput

type AgentInput struct {
	Instructions *string `json:"instructions,omitempty"`
	Model        *string `json:"model,omitempty"`
	Profile      string  `json:"profile"`
}

AgentInput defines model for AgentInput.

type CancelRunHTTPResponse

type CancelRunHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Cancelled
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *Cancelled
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorResponse
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *ErrorResponse
	// JSON415 the response for an HTTP 415 `application/json` response
	JSON415 *ErrorResponse
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ErrorResponse
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ErrorResponse
}

func ParseCancelRunHTTPResponse

func ParseCancelRunHTTPResponse(rsp *http.Response) (*CancelRunHTTPResponse, error)

ParseCancelRunHTTPResponse parses an HTTP response from a CancelRunWithResponse call

func (CancelRunHTTPResponse) ContentType

func (r CancelRunHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CancelRunHTTPResponse) GetBody

func (r CancelRunHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CancelRunHTTPResponse) GetJSON200

func (r CancelRunHTTPResponse) GetJSON200() *Cancelled

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (CancelRunHTTPResponse) GetJSON202

func (r CancelRunHTTPResponse) GetJSON202() *Cancelled

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (CancelRunHTTPResponse) GetJSON400

func (r CancelRunHTTPResponse) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CancelRunHTTPResponse) GetJSON401

func (r CancelRunHTTPResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CancelRunHTTPResponse) GetJSON404

func (r CancelRunHTTPResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (CancelRunHTTPResponse) GetJSON409

func (r CancelRunHTTPResponse) GetJSON409() *ErrorResponse

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (CancelRunHTTPResponse) GetJSON413

func (r CancelRunHTTPResponse) GetJSON413() *ErrorResponse

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (CancelRunHTTPResponse) GetJSON415

func (r CancelRunHTTPResponse) GetJSON415() *ErrorResponse

GetJSON415 returns the response for an HTTP 415 `application/json` response

func (CancelRunHTTPResponse) GetJSON422

func (r CancelRunHTTPResponse) GetJSON422() *ErrorResponse

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (CancelRunHTTPResponse) GetJSON503

func (r CancelRunHTTPResponse) GetJSON503() *ErrorResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (CancelRunHTTPResponse) Status

func (r CancelRunHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (CancelRunHTTPResponse) StatusCode

func (r CancelRunHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Cancelled

type Cancelled struct {
	RunID  openapi_types.UUID `json:"run_id"`
	Status RunStatus          `json:"status"`
}

Cancelled defines model for Cancelled.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CancelRun

func (c *Client) CancelRun(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

CancelRun Cancel Run

Corresponds with POST /api/v1/sessions/{sid}/runs/{rid}/cancel (the `CancelRun` operationId).

func (*Client) CreateRun

func (c *Client) CreateRun(ctx context.Context, sid openapi_types.UUID, params *CreateRunParams, body CreateRunJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateRun Create Run

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/sessions/{sid}/runs (the `CreateRun` operationId).

func (*Client) CreateRunWithBody

func (c *Client) CreateRunWithBody(ctx context.Context, sid openapi_types.UUID, params *CreateRunParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateRunWithBody Create Run

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/sessions/{sid}/runs (the `CreateRun` operationId).

func (*Client) CreateSession

func (c *Client) CreateSession(ctx context.Context, params *CreateSessionParams, body CreateSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateSession Create Session

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/sessions (the `CreateSession` operationId).

func (*Client) CreateSessionWithBody

func (c *Client) CreateSessionWithBody(ctx context.Context, params *CreateSessionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateSessionWithBody Create Session

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/sessions (the `CreateSession` operationId).

func (*Client) GetEvents

func (c *Client) GetEvents(ctx context.Context, sid openapi_types.UUID, params *GetEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetEvents Events

Corresponds with GET /api/v1/sessions/{sid}/events (the `GetEvents` operationId).

func (*Client) GetHistory

func (c *Client) GetHistory(ctx context.Context, sid openapi_types.UUID, params *GetHistoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetHistory History

Corresponds with GET /api/v1/sessions/{sid}/history (the `GetHistory` operationId).

func (*Client) GetRun

func (c *Client) GetRun(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

GetRun Read Run

Corresponds with GET /api/v1/sessions/{sid}/runs/{rid} (the `GetRun` operationId).

func (*Client) GetSession

func (c *Client) GetSession(ctx context.Context, sid openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

GetSession Read Session

Corresponds with GET /api/v1/sessions/{sid} (the `GetSession` operationId).

func (*Client) Health

func (c *Client) Health(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

Health Health

Corresponds with GET /health (the `Health` operationId).

func (*Client) ListAllRuns

func (c *Client) ListAllRuns(ctx context.Context, params *ListAllRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListAllRuns List All Runs

Corresponds with GET /api/v1/runs (the `ListAllRuns` operationId).

func (*Client) ListRuns

func (c *Client) ListRuns(ctx context.Context, sid openapi_types.UUID, params *ListRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListRuns List Runs

Corresponds with GET /api/v1/sessions/{sid}/runs (the `ListRuns` operationId).

func (*Client) ListSessions

func (c *Client) ListSessions(ctx context.Context, params *ListSessionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListSessions List Sessions

Corresponds with GET /api/v1/sessions (the `ListSessions` operationId).

func (*Client) Ready

func (c *Client) Ready(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

Ready Ready

Corresponds with GET /ready (the `Ready` operationId).

func (*Client) SendMessage

SendMessage Send Message

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/sessions/{sid}/runs/{rid}/messages (the `SendMessage` operationId).

func (*Client) SendMessageWithBody

func (c *Client) SendMessageWithBody(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, params *SendMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SendMessageWithBody Send Message

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/sessions/{sid}/runs/{rid}/messages (the `SendMessage` operationId).

func (*Client) StreamEvents

func (c *Client) StreamEvents(ctx context.Context, sid openapi_types.UUID, params *StreamEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

StreamEvents Stream Events

Corresponds with GET /api/v1/sessions/{sid}/events/stream (the `StreamEvents` operationId).

type ClientInterface

type ClientInterface interface {

	// ListAllRuns List All Runs
	//
	// Corresponds with GET /api/v1/runs (the `ListAllRuns` operationId).
	ListAllRuns(ctx context.Context, params *ListAllRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessions List Sessions
	//
	// Corresponds with GET /api/v1/sessions (the `ListSessions` operationId).
	ListSessions(ctx context.Context, params *ListSessionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateSessionWithBody Create Session
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/sessions (the `CreateSession` operationId).
	CreateSessionWithBody(ctx context.Context, params *CreateSessionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateSession Create Session
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/sessions (the `CreateSession` operationId).
	CreateSession(ctx context.Context, params *CreateSessionParams, body CreateSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSession Read Session
	//
	// Corresponds with GET /api/v1/sessions/{sid} (the `GetSession` operationId).
	GetSession(ctx context.Context, sid openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetEvents Events
	//
	// Corresponds with GET /api/v1/sessions/{sid}/events (the `GetEvents` operationId).
	GetEvents(ctx context.Context, sid openapi_types.UUID, params *GetEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// StreamEvents Stream Events
	//
	// Corresponds with GET /api/v1/sessions/{sid}/events/stream (the `StreamEvents` operationId).
	StreamEvents(ctx context.Context, sid openapi_types.UUID, params *StreamEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHistory History
	//
	// Corresponds with GET /api/v1/sessions/{sid}/history (the `GetHistory` operationId).
	GetHistory(ctx context.Context, sid openapi_types.UUID, params *GetHistoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListRuns List Runs
	//
	// Corresponds with GET /api/v1/sessions/{sid}/runs (the `ListRuns` operationId).
	ListRuns(ctx context.Context, sid openapi_types.UUID, params *ListRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRunWithBody Create Run
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/sessions/{sid}/runs (the `CreateRun` operationId).
	CreateRunWithBody(ctx context.Context, sid openapi_types.UUID, params *CreateRunParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateRun Create Run
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/sessions/{sid}/runs (the `CreateRun` operationId).
	CreateRun(ctx context.Context, sid openapi_types.UUID, params *CreateRunParams, body CreateRunJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetRun Read Run
	//
	// Corresponds with GET /api/v1/sessions/{sid}/runs/{rid} (the `GetRun` operationId).
	GetRun(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CancelRun Cancel Run
	//
	// Corresponds with POST /api/v1/sessions/{sid}/runs/{rid}/cancel (the `CancelRun` operationId).
	CancelRun(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SendMessageWithBody Send Message
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/sessions/{sid}/runs/{rid}/messages (the `SendMessage` operationId).
	SendMessageWithBody(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, params *SendMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SendMessage Send Message
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/sessions/{sid}/runs/{rid}/messages (the `SendMessage` operationId).
	SendMessage(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, params *SendMessageParams, body SendMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Health Health
	//
	// Corresponds with GET /health (the `Health` operationId).
	Health(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Ready Ready
	//
	// Corresponds with GET /ready (the `Ready` operationId).
	Ready(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CancelRunWithResponse

func (c *ClientWithResponses) CancelRunWithResponse(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, reqEditors ...RequestEditorFn) (*CancelRunHTTPResponse, error)

CancelRunWithResponse Cancel Run

Returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/sessions/{sid}/runs/{rid}/cancel (the `CancelRun` operationId).

func (*ClientWithResponses) CreateRunWithBodyWithResponse

func (c *ClientWithResponses) CreateRunWithBodyWithResponse(ctx context.Context, sid openapi_types.UUID, params *CreateRunParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRunHTTPResponse, error)

CreateRunWithBodyWithResponse Create Run

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/sessions/{sid}/runs (the `CreateRun` operationId).

func (*ClientWithResponses) CreateRunWithResponse

func (c *ClientWithResponses) CreateRunWithResponse(ctx context.Context, sid openapi_types.UUID, params *CreateRunParams, body CreateRunJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRunHTTPResponse, error)

CreateRunWithResponse Create Run

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/sessions/{sid}/runs (the `CreateRun` operationId).

func (*ClientWithResponses) CreateSessionWithBodyWithResponse

func (c *ClientWithResponses) CreateSessionWithBodyWithResponse(ctx context.Context, params *CreateSessionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSessionHTTPResponse, error)

CreateSessionWithBodyWithResponse Create Session

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/sessions (the `CreateSession` operationId).

func (*ClientWithResponses) CreateSessionWithResponse

func (c *ClientWithResponses) CreateSessionWithResponse(ctx context.Context, params *CreateSessionParams, body CreateSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSessionHTTPResponse, error)

CreateSessionWithResponse Create Session

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/sessions (the `CreateSession` operationId).

func (*ClientWithResponses) GetEventsWithResponse

func (c *ClientWithResponses) GetEventsWithResponse(ctx context.Context, sid openapi_types.UUID, params *GetEventsParams, reqEditors ...RequestEditorFn) (*GetEventsHTTPResponse, error)

GetEventsWithResponse Events

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/sessions/{sid}/events (the `GetEvents` operationId).

func (*ClientWithResponses) GetHistoryWithResponse

func (c *ClientWithResponses) GetHistoryWithResponse(ctx context.Context, sid openapi_types.UUID, params *GetHistoryParams, reqEditors ...RequestEditorFn) (*GetHistoryHTTPResponse, error)

GetHistoryWithResponse History

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/sessions/{sid}/history (the `GetHistory` operationId).

func (*ClientWithResponses) GetRunWithResponse

func (c *ClientWithResponses) GetRunWithResponse(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetRunHTTPResponse, error)

GetRunWithResponse Read Run

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/sessions/{sid}/runs/{rid} (the `GetRun` operationId).

func (*ClientWithResponses) GetSessionWithResponse

func (c *ClientWithResponses) GetSessionWithResponse(ctx context.Context, sid openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetSessionHTTPResponse, error)

GetSessionWithResponse Read Session

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/sessions/{sid} (the `GetSession` operationId).

func (*ClientWithResponses) HealthWithResponse

func (c *ClientWithResponses) HealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthHTTPResponse, error)

HealthWithResponse Health

Returns a wrapper object for the known response body format(s).

Corresponds with GET /health (the `Health` operationId).

func (*ClientWithResponses) ListAllRunsWithResponse

func (c *ClientWithResponses) ListAllRunsWithResponse(ctx context.Context, params *ListAllRunsParams, reqEditors ...RequestEditorFn) (*ListAllRunsHTTPResponse, error)

ListAllRunsWithResponse List All Runs

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/runs (the `ListAllRuns` operationId).

func (*ClientWithResponses) ListRunsWithResponse

func (c *ClientWithResponses) ListRunsWithResponse(ctx context.Context, sid openapi_types.UUID, params *ListRunsParams, reqEditors ...RequestEditorFn) (*ListRunsHTTPResponse, error)

ListRunsWithResponse List Runs

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/sessions/{sid}/runs (the `ListRuns` operationId).

func (*ClientWithResponses) ListSessionsWithResponse

func (c *ClientWithResponses) ListSessionsWithResponse(ctx context.Context, params *ListSessionsParams, reqEditors ...RequestEditorFn) (*ListSessionsHTTPResponse, error)

ListSessionsWithResponse List Sessions

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/sessions (the `ListSessions` operationId).

func (*ClientWithResponses) ReadyWithResponse

func (c *ClientWithResponses) ReadyWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ReadyHTTPResponse, error)

ReadyWithResponse Ready

Returns a wrapper object for the known response body format(s).

Corresponds with GET /ready (the `Ready` operationId).

func (*ClientWithResponses) SendMessageWithBodyWithResponse

func (c *ClientWithResponses) SendMessageWithBodyWithResponse(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, params *SendMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SendMessageHTTPResponse, error)

SendMessageWithBodyWithResponse Send Message

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/sessions/{sid}/runs/{rid}/messages (the `SendMessage` operationId).

func (*ClientWithResponses) SendMessageWithResponse

SendMessageWithResponse Send Message

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/sessions/{sid}/runs/{rid}/messages (the `SendMessage` operationId).

func (*ClientWithResponses) StreamEventsWithResponse

func (c *ClientWithResponses) StreamEventsWithResponse(ctx context.Context, sid openapi_types.UUID, params *StreamEventsParams, reqEditors ...RequestEditorFn) (*StreamEventsHTTPResponse, error)

StreamEventsWithResponse Stream Events

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/sessions/{sid}/events/stream (the `StreamEvents` operationId).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// ListAllRunsWithResponse List All Runs
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/runs (the `ListAllRuns` operationId).
	ListAllRunsWithResponse(ctx context.Context, params *ListAllRunsParams, reqEditors ...RequestEditorFn) (*ListAllRunsHTTPResponse, error)

	// ListSessionsWithResponse List Sessions
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/sessions (the `ListSessions` operationId).
	ListSessionsWithResponse(ctx context.Context, params *ListSessionsParams, reqEditors ...RequestEditorFn) (*ListSessionsHTTPResponse, error)

	// CreateSessionWithBodyWithResponse Create Session
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/sessions (the `CreateSession` operationId).
	CreateSessionWithBodyWithResponse(ctx context.Context, params *CreateSessionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateSessionHTTPResponse, error)

	// CreateSessionWithResponse Create Session
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/sessions (the `CreateSession` operationId).
	CreateSessionWithResponse(ctx context.Context, params *CreateSessionParams, body CreateSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateSessionHTTPResponse, error)

	// GetSessionWithResponse Read Session
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/sessions/{sid} (the `GetSession` operationId).
	GetSessionWithResponse(ctx context.Context, sid openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetSessionHTTPResponse, error)

	// GetEventsWithResponse Events
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/sessions/{sid}/events (the `GetEvents` operationId).
	GetEventsWithResponse(ctx context.Context, sid openapi_types.UUID, params *GetEventsParams, reqEditors ...RequestEditorFn) (*GetEventsHTTPResponse, error)

	// StreamEventsWithResponse Stream Events
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/sessions/{sid}/events/stream (the `StreamEvents` operationId).
	StreamEventsWithResponse(ctx context.Context, sid openapi_types.UUID, params *StreamEventsParams, reqEditors ...RequestEditorFn) (*StreamEventsHTTPResponse, error)

	// GetHistoryWithResponse History
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/sessions/{sid}/history (the `GetHistory` operationId).
	GetHistoryWithResponse(ctx context.Context, sid openapi_types.UUID, params *GetHistoryParams, reqEditors ...RequestEditorFn) (*GetHistoryHTTPResponse, error)

	// ListRunsWithResponse List Runs
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/sessions/{sid}/runs (the `ListRuns` operationId).
	ListRunsWithResponse(ctx context.Context, sid openapi_types.UUID, params *ListRunsParams, reqEditors ...RequestEditorFn) (*ListRunsHTTPResponse, error)

	// CreateRunWithBodyWithResponse Create Run
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/sessions/{sid}/runs (the `CreateRun` operationId).
	CreateRunWithBodyWithResponse(ctx context.Context, sid openapi_types.UUID, params *CreateRunParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateRunHTTPResponse, error)

	// CreateRunWithResponse Create Run
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/sessions/{sid}/runs (the `CreateRun` operationId).
	CreateRunWithResponse(ctx context.Context, sid openapi_types.UUID, params *CreateRunParams, body CreateRunJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateRunHTTPResponse, error)

	// GetRunWithResponse Read Run
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/sessions/{sid}/runs/{rid} (the `GetRun` operationId).
	GetRunWithResponse(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetRunHTTPResponse, error)

	// CancelRunWithResponse Cancel Run
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/sessions/{sid}/runs/{rid}/cancel (the `CancelRun` operationId).
	CancelRunWithResponse(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, reqEditors ...RequestEditorFn) (*CancelRunHTTPResponse, error)

	// SendMessageWithBodyWithResponse Send Message
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/sessions/{sid}/runs/{rid}/messages (the `SendMessage` operationId).
	SendMessageWithBodyWithResponse(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, params *SendMessageParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SendMessageHTTPResponse, error)

	// SendMessageWithResponse Send Message
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/sessions/{sid}/runs/{rid}/messages (the `SendMessage` operationId).
	SendMessageWithResponse(ctx context.Context, sid openapi_types.UUID, rid openapi_types.UUID, params *SendMessageParams, body SendMessageJSONRequestBody, reqEditors ...RequestEditorFn) (*SendMessageHTTPResponse, error)

	// HealthWithResponse Health
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /health (the `Health` operationId).
	HealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthHTTPResponse, error)

	// ReadyWithResponse Ready
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /ready (the `Ready` operationId).
	ReadyWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ReadyHTTPResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type Configuration

type Configuration struct {
	Agent   AgentConfiguration   `json:"agent"`
	Hooks   HooksConfiguration   `json:"hooks"`
	Limits  Limits               `json:"limits"`
	Sandbox SandboxConfiguration `json:"sandbox"`
}

Configuration defines model for Configuration.

type ConfigurationInput

type ConfigurationInput struct {
	Agent   AgentInput   `json:"agent"`
	Hooks   *HooksInput  `json:"hooks,omitempty"`
	Limits  *LimitsInput `json:"limits,omitempty"`
	Sandbox SandboxInput `json:"sandbox"`
}

ConfigurationInput defines model for ConfigurationInput.

type CreateRun

type CreateRun struct {
	// Env Explicit environment variables available only to this run's before_run and after_run hooks. Override session sources with the same names; never passed to the harness, after_create, or before_remove.
	Env *map[string]string `json:"env,omitempty"`

	// EnvFrom Allowlisted orchestrator environment variable names available only to this run's before_run and after_run hooks. Resolved before each hook; override session sources and are never passed to the harness, after_create, or before_remove.
	EnvFrom *[]string `json:"env_from,omitempty"`

	// InputFingerprint Opaque input snapshot version for this run; does not deduplicate requests. Opaque identifier, 1–256 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.
	InputFingerprint *string     `json:"input_fingerprint,omitempty"`
	Message          TextMessage `json:"message"`
}

CreateRun defines model for CreateRun.

type CreateRunHTTPResponse

type CreateRunHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *Accepted
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorResponse
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *ErrorResponse
	// JSON415 the response for an HTTP 415 `application/json` response
	JSON415 *ErrorResponse
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ErrorResponse
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ErrorResponse
	// Headers202 the parsed response headers for an HTTP 202 response
	Headers202 *CreateRunHTTPResponse202Headers
}

func ParseCreateRunHTTPResponse

func ParseCreateRunHTTPResponse(rsp *http.Response) (*CreateRunHTTPResponse, error)

ParseCreateRunHTTPResponse parses an HTTP response from a CreateRunWithResponse call

func (CreateRunHTTPResponse) ContentType

func (r CreateRunHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateRunHTTPResponse) GetBody

func (r CreateRunHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateRunHTTPResponse) GetJSON202

func (r CreateRunHTTPResponse) GetJSON202() *Accepted

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (CreateRunHTTPResponse) GetJSON400

func (r CreateRunHTTPResponse) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateRunHTTPResponse) GetJSON401

func (r CreateRunHTTPResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateRunHTTPResponse) GetJSON404

func (r CreateRunHTTPResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (CreateRunHTTPResponse) GetJSON409

func (r CreateRunHTTPResponse) GetJSON409() *ErrorResponse

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (CreateRunHTTPResponse) GetJSON413

func (r CreateRunHTTPResponse) GetJSON413() *ErrorResponse

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (CreateRunHTTPResponse) GetJSON415

func (r CreateRunHTTPResponse) GetJSON415() *ErrorResponse

GetJSON415 returns the response for an HTTP 415 `application/json` response

func (CreateRunHTTPResponse) GetJSON422

func (r CreateRunHTTPResponse) GetJSON422() *ErrorResponse

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (CreateRunHTTPResponse) GetJSON503

func (r CreateRunHTTPResponse) GetJSON503() *ErrorResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (CreateRunHTTPResponse) Status

func (r CreateRunHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (CreateRunHTTPResponse) StatusCode

func (r CreateRunHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateRunHTTPResponse202Headers

type CreateRunHTTPResponse202Headers struct {
	Location string
}

CreateRunHTTPResponse202Headers the declared response headers of an HTTP 202 response for CreateRun

type CreateRunJSONRequestBody

type CreateRunJSONRequestBody = CreateRun

CreateRunJSONRequestBody defines body for CreateRun for application/json ContentType.

type CreateRunParams

type CreateRunParams struct {
	IdempotencyKey *string `json:"Idempotency-Key,omitempty"`
}

CreateRunParams defines parameters for CreateRun.

type CreateSession

type CreateSession struct {
	Configuration ConfigurationInput `json:"configuration"`

	// Env Explicit environment variables for the first run's before_run and after_run hooks only. Override session sources with the same names; never passed to the harness, after_create, or before_remove.
	Env *map[string]string `json:"env,omitempty"`

	// EnvFrom Allowlisted orchestrator environment variable names for the first run's before_run and after_run hooks only. Resolved before each hook; override session sources and are never passed to the harness, after_create, or before_remove.
	EnvFrom *[]string `json:"env_from,omitempty"`

	// ExternalKey Source-qualified external object key; not unique across sessions. Opaque identifier, 1–512 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.
	ExternalKey *string `json:"external_key,omitempty"`

	// InputFingerprint Opaque input snapshot version for the first run; does not deduplicate requests. Opaque identifier, 1–256 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.
	InputFingerprint *string     `json:"input_fingerprint,omitempty"`
	Message          TextMessage `json:"message"`

	// Namespace Logical integration or workflow name. Opaque identifier, 1–128 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.
	Namespace *string `json:"namespace,omitempty"`
}

CreateSession defines model for CreateSession.

type CreateSessionHTTPResponse

type CreateSessionHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *Accepted
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorResponse
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *ErrorResponse
	// JSON415 the response for an HTTP 415 `application/json` response
	JSON415 *ErrorResponse
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ErrorResponse
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ErrorResponse
	// Headers202 the parsed response headers for an HTTP 202 response
	Headers202 *CreateSessionHTTPResponse202Headers
}

func ParseCreateSessionHTTPResponse

func ParseCreateSessionHTTPResponse(rsp *http.Response) (*CreateSessionHTTPResponse, error)

ParseCreateSessionHTTPResponse parses an HTTP response from a CreateSessionWithResponse call

func (CreateSessionHTTPResponse) ContentType

func (r CreateSessionHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateSessionHTTPResponse) GetBody

func (r CreateSessionHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateSessionHTTPResponse) GetJSON202

func (r CreateSessionHTTPResponse) GetJSON202() *Accepted

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (CreateSessionHTTPResponse) GetJSON400

func (r CreateSessionHTTPResponse) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateSessionHTTPResponse) GetJSON401

func (r CreateSessionHTTPResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateSessionHTTPResponse) GetJSON404

func (r CreateSessionHTTPResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (CreateSessionHTTPResponse) GetJSON409

func (r CreateSessionHTTPResponse) GetJSON409() *ErrorResponse

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (CreateSessionHTTPResponse) GetJSON413

func (r CreateSessionHTTPResponse) GetJSON413() *ErrorResponse

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (CreateSessionHTTPResponse) GetJSON415

func (r CreateSessionHTTPResponse) GetJSON415() *ErrorResponse

GetJSON415 returns the response for an HTTP 415 `application/json` response

func (CreateSessionHTTPResponse) GetJSON422

func (r CreateSessionHTTPResponse) GetJSON422() *ErrorResponse

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (CreateSessionHTTPResponse) GetJSON503

func (r CreateSessionHTTPResponse) GetJSON503() *ErrorResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (CreateSessionHTTPResponse) Status

func (r CreateSessionHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (CreateSessionHTTPResponse) StatusCode

func (r CreateSessionHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateSessionHTTPResponse202Headers

type CreateSessionHTTPResponse202Headers struct {
	Location string
}

CreateSessionHTTPResponse202Headers the declared response headers of an HTTP 202 response for CreateSession

type CreateSessionJSONRequestBody

type CreateSessionJSONRequestBody = CreateSession

CreateSessionJSONRequestBody defines body for CreateSession for application/json ContentType.

type CreateSessionParams

type CreateSessionParams struct {
	IdempotencyKey *string `json:"Idempotency-Key,omitempty"`
}

CreateSessionParams defines parameters for CreateSession.

type Error

type Error struct {
	Code    string        `json:"code"`
	Details []ErrorDetail `json:"details"`
	Message string        `json:"message"`
	Phase   *ErrorPhase   `json:"phase"`
}

Error defines model for Error.

type ErrorDetail

type ErrorDetail struct {
	Code ErrorDetailCode         `json:"code"`
	Path []ErrorDetail_Path_Item `json:"path"`
}

ErrorDetail Validation paths start with body, header, query, or path. Hook execution errors identify configuration.hooks.<name>; codes never contain input values or native validator messages.

type ErrorDetailCode

type ErrorDetailCode string

ErrorDetailCode defines model for ErrorDetail.Code.

const (
	InvalidType  ErrorDetailCode = "invalid_type"
	InvalidValue ErrorDetailCode = "invalid_value"
	Required     ErrorDetailCode = "required"
	UnknownField ErrorDetailCode = "unknown_field"
)

Defines values for ErrorDetailCode.

func (ErrorDetailCode) Valid

func (e ErrorDetailCode) Valid() bool

Valid indicates whether the value is a known member of the ErrorDetailCode enum.

type ErrorDetailPath0

type ErrorDetailPath0 = string

ErrorDetailPath0 defines model for ErrorDetail.Path.0.

type ErrorDetailPath1

type ErrorDetailPath1 = int

ErrorDetailPath1 defines model for ErrorDetail.Path.1.

type ErrorDetail_Path_Item

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

ErrorDetail_Path_Item defines model for ErrorDetail.path.Item.

func (ErrorDetail_Path_Item) AsErrorDetailPath0

func (t ErrorDetail_Path_Item) AsErrorDetailPath0() (ErrorDetailPath0, error)

AsErrorDetailPath0 returns the union data inside the ErrorDetail_Path_Item as a ErrorDetailPath0

func (ErrorDetail_Path_Item) AsErrorDetailPath1

func (t ErrorDetail_Path_Item) AsErrorDetailPath1() (ErrorDetailPath1, error)

AsErrorDetailPath1 returns the union data inside the ErrorDetail_Path_Item as a ErrorDetailPath1

func (*ErrorDetail_Path_Item) FromErrorDetailPath0

func (t *ErrorDetail_Path_Item) FromErrorDetailPath0(v ErrorDetailPath0) error

FromErrorDetailPath0 overwrites any union data inside the ErrorDetail_Path_Item as the provided ErrorDetailPath0

func (*ErrorDetail_Path_Item) FromErrorDetailPath1

func (t *ErrorDetail_Path_Item) FromErrorDetailPath1(v ErrorDetailPath1) error

FromErrorDetailPath1 overwrites any union data inside the ErrorDetail_Path_Item as the provided ErrorDetailPath1

func (ErrorDetail_Path_Item) MarshalJSON

func (t ErrorDetail_Path_Item) MarshalJSON() ([]byte, error)

func (*ErrorDetail_Path_Item) MergeErrorDetailPath0

func (t *ErrorDetail_Path_Item) MergeErrorDetailPath0(v ErrorDetailPath0) error

MergeErrorDetailPath0 performs a merge with any union data inside the ErrorDetail_Path_Item, using the provided ErrorDetailPath0

func (*ErrorDetail_Path_Item) MergeErrorDetailPath1

func (t *ErrorDetail_Path_Item) MergeErrorDetailPath1(v ErrorDetailPath1) error

MergeErrorDetailPath1 performs a merge with any union data inside the ErrorDetail_Path_Item, using the provided ErrorDetailPath1

func (*ErrorDetail_Path_Item) UnmarshalJSON

func (t *ErrorDetail_Path_Item) UnmarshalJSON(b []byte) error

type ErrorPhase

type ErrorPhase string

ErrorPhase defines model for Error.Phase.

const (
	ErrorPhaseExecution    ErrorPhase = "execution"
	ErrorPhaseFinalization ErrorPhase = "finalization"
	ErrorPhasePreparation  ErrorPhase = "preparation"
	ErrorPhaseRecovery     ErrorPhase = "recovery"
)

Defines values for ErrorPhase.

func (ErrorPhase) Valid

func (e ErrorPhase) Valid() bool

Valid indicates whether the value is a known member of the ErrorPhase enum.

type ErrorResponse

type ErrorResponse struct {
	Error Error `json:"error"`
}

ErrorResponse defines model for ErrorResponse.

type Event

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

Event defines model for Event.

func (Event) AsMessageEvent

func (t Event) AsMessageEvent() (MessageEvent, error)

AsMessageEvent returns the union data inside the Event as a MessageEvent

func (Event) AsRunEvent

func (t Event) AsRunEvent() (RunEvent, error)

AsRunEvent returns the union data inside the Event as a RunEvent

func (Event) AsSandboxEvent

func (t Event) AsSandboxEvent() (SandboxEvent, error)

AsSandboxEvent returns the union data inside the Event as a SandboxEvent

func (Event) AsToolCallEvent

func (t Event) AsToolCallEvent() (ToolCallEvent, error)

AsToolCallEvent returns the union data inside the Event as a ToolCallEvent

func (Event) Discriminator

func (t Event) Discriminator() (string, error)

func (*Event) FromMessageEvent

func (t *Event) FromMessageEvent(v MessageEvent) error

FromMessageEvent overwrites any union data inside the Event as the provided MessageEvent

func (*Event) FromRunEvent

func (t *Event) FromRunEvent(v RunEvent) error

FromRunEvent overwrites any union data inside the Event as the provided RunEvent

func (*Event) FromSandboxEvent

func (t *Event) FromSandboxEvent(v SandboxEvent) error

FromSandboxEvent overwrites any union data inside the Event as the provided SandboxEvent

func (*Event) FromToolCallEvent

func (t *Event) FromToolCallEvent(v ToolCallEvent) error

FromToolCallEvent overwrites any union data inside the Event as the provided ToolCallEvent

func (Event) MarshalJSON

func (t Event) MarshalJSON() ([]byte, error)

func (*Event) MergeMessageEvent

func (t *Event) MergeMessageEvent(v MessageEvent) error

MergeMessageEvent performs a merge with any union data inside the Event, using the provided MessageEvent

func (*Event) MergeRunEvent

func (t *Event) MergeRunEvent(v RunEvent) error

MergeRunEvent performs a merge with any union data inside the Event, using the provided RunEvent

func (*Event) MergeSandboxEvent

func (t *Event) MergeSandboxEvent(v SandboxEvent) error

MergeSandboxEvent performs a merge with any union data inside the Event, using the provided SandboxEvent

func (*Event) MergeToolCallEvent

func (t *Event) MergeToolCallEvent(v ToolCallEvent) error

MergeToolCallEvent performs a merge with any union data inside the Event, using the provided ToolCallEvent

func (*Event) UnmarshalJSON

func (t *Event) UnmarshalJSON(b []byte) error

func (Event) ValueByDiscriminator

func (t Event) ValueByDiscriminator() (interface{}, error)

type EventPage

type EventPage struct {
	HasMore    bool    `json:"has_more"`
	Items      []Event `json:"items"`
	NextCursor string  `json:"next_cursor"`
}

EventPage defines model for EventPage.

type GetEventsHTTPResponse

type GetEventsHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *EventPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorResponse
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *ErrorResponse
	// JSON415 the response for an HTTP 415 `application/json` response
	JSON415 *ErrorResponse
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ErrorResponse
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ErrorResponse
}

func ParseGetEventsHTTPResponse

func ParseGetEventsHTTPResponse(rsp *http.Response) (*GetEventsHTTPResponse, error)

ParseGetEventsHTTPResponse parses an HTTP response from a GetEventsWithResponse call

func (GetEventsHTTPResponse) ContentType

func (r GetEventsHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetEventsHTTPResponse) GetBody

func (r GetEventsHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetEventsHTTPResponse) GetJSON200

func (r GetEventsHTTPResponse) GetJSON200() *EventPage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetEventsHTTPResponse) GetJSON400

func (r GetEventsHTTPResponse) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetEventsHTTPResponse) GetJSON401

func (r GetEventsHTTPResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetEventsHTTPResponse) GetJSON404

func (r GetEventsHTTPResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetEventsHTTPResponse) GetJSON409

func (r GetEventsHTTPResponse) GetJSON409() *ErrorResponse

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (GetEventsHTTPResponse) GetJSON413

func (r GetEventsHTTPResponse) GetJSON413() *ErrorResponse

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (GetEventsHTTPResponse) GetJSON415

func (r GetEventsHTTPResponse) GetJSON415() *ErrorResponse

GetJSON415 returns the response for an HTTP 415 `application/json` response

func (GetEventsHTTPResponse) GetJSON422

func (r GetEventsHTTPResponse) GetJSON422() *ErrorResponse

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetEventsHTTPResponse) GetJSON503

func (r GetEventsHTTPResponse) GetJSON503() *ErrorResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (GetEventsHTTPResponse) Status

func (r GetEventsHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (GetEventsHTTPResponse) StatusCode

func (r GetEventsHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetEventsParams

type GetEventsParams struct {
	After *string `form:"after,omitempty" json:"after,omitempty"`
	Limit *int    `form:"limit,omitempty" json:"limit,omitempty"`
}

GetEventsParams defines parameters for GetEvents.

type GetHistoryHTTPResponse

type GetHistoryHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *HistoryPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorResponse
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *ErrorResponse
	// JSON415 the response for an HTTP 415 `application/json` response
	JSON415 *ErrorResponse
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ErrorResponse
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ErrorResponse
}

func ParseGetHistoryHTTPResponse

func ParseGetHistoryHTTPResponse(rsp *http.Response) (*GetHistoryHTTPResponse, error)

ParseGetHistoryHTTPResponse parses an HTTP response from a GetHistoryWithResponse call

func (GetHistoryHTTPResponse) ContentType

func (r GetHistoryHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetHistoryHTTPResponse) GetBody

func (r GetHistoryHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetHistoryHTTPResponse) GetJSON200

func (r GetHistoryHTTPResponse) GetJSON200() *HistoryPage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetHistoryHTTPResponse) GetJSON400

func (r GetHistoryHTTPResponse) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetHistoryHTTPResponse) GetJSON401

func (r GetHistoryHTTPResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetHistoryHTTPResponse) GetJSON404

func (r GetHistoryHTTPResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetHistoryHTTPResponse) GetJSON409

func (r GetHistoryHTTPResponse) GetJSON409() *ErrorResponse

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (GetHistoryHTTPResponse) GetJSON413

func (r GetHistoryHTTPResponse) GetJSON413() *ErrorResponse

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (GetHistoryHTTPResponse) GetJSON415

func (r GetHistoryHTTPResponse) GetJSON415() *ErrorResponse

GetJSON415 returns the response for an HTTP 415 `application/json` response

func (GetHistoryHTTPResponse) GetJSON422

func (r GetHistoryHTTPResponse) GetJSON422() *ErrorResponse

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetHistoryHTTPResponse) GetJSON503

func (r GetHistoryHTTPResponse) GetJSON503() *ErrorResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (GetHistoryHTTPResponse) Status

func (r GetHistoryHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (GetHistoryHTTPResponse) StatusCode

func (r GetHistoryHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHistoryParams

type GetHistoryParams struct {
	MessageExternalKey *string             `form:"message_external_key,omitempty" json:"message_external_key,omitempty"`
	Limit              *int                `form:"limit,omitempty" json:"limit,omitempty"`
	Cursor             *string             `form:"cursor,omitempty" json:"cursor,omitempty"`
	RunID              *openapi_types.UUID `form:"run_id,omitempty" json:"run_id,omitempty"`
}

GetHistoryParams defines parameters for GetHistory.

type GetRunHTTPResponse

type GetRunHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Run
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorResponse
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *ErrorResponse
	// JSON415 the response for an HTTP 415 `application/json` response
	JSON415 *ErrorResponse
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ErrorResponse
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ErrorResponse
}

func ParseGetRunHTTPResponse

func ParseGetRunHTTPResponse(rsp *http.Response) (*GetRunHTTPResponse, error)

ParseGetRunHTTPResponse parses an HTTP response from a GetRunWithResponse call

func (GetRunHTTPResponse) ContentType

func (r GetRunHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetRunHTTPResponse) GetBody

func (r GetRunHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetRunHTTPResponse) GetJSON200

func (r GetRunHTTPResponse) GetJSON200() *Run

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetRunHTTPResponse) GetJSON400

func (r GetRunHTTPResponse) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetRunHTTPResponse) GetJSON401

func (r GetRunHTTPResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetRunHTTPResponse) GetJSON404

func (r GetRunHTTPResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetRunHTTPResponse) GetJSON409

func (r GetRunHTTPResponse) GetJSON409() *ErrorResponse

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (GetRunHTTPResponse) GetJSON413

func (r GetRunHTTPResponse) GetJSON413() *ErrorResponse

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (GetRunHTTPResponse) GetJSON415

func (r GetRunHTTPResponse) GetJSON415() *ErrorResponse

GetJSON415 returns the response for an HTTP 415 `application/json` response

func (GetRunHTTPResponse) GetJSON422

func (r GetRunHTTPResponse) GetJSON422() *ErrorResponse

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetRunHTTPResponse) GetJSON503

func (r GetRunHTTPResponse) GetJSON503() *ErrorResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (GetRunHTTPResponse) Status

func (r GetRunHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (GetRunHTTPResponse) StatusCode

func (r GetRunHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSessionHTTPResponse

type GetSessionHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Session
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorResponse
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *ErrorResponse
	// JSON415 the response for an HTTP 415 `application/json` response
	JSON415 *ErrorResponse
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ErrorResponse
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ErrorResponse
}

func ParseGetSessionHTTPResponse

func ParseGetSessionHTTPResponse(rsp *http.Response) (*GetSessionHTTPResponse, error)

ParseGetSessionHTTPResponse parses an HTTP response from a GetSessionWithResponse call

func (GetSessionHTTPResponse) ContentType

func (r GetSessionHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetSessionHTTPResponse) GetBody

func (r GetSessionHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSessionHTTPResponse) GetJSON200

func (r GetSessionHTTPResponse) GetJSON200() *Session

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetSessionHTTPResponse) GetJSON400

func (r GetSessionHTTPResponse) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetSessionHTTPResponse) GetJSON401

func (r GetSessionHTTPResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetSessionHTTPResponse) GetJSON404

func (r GetSessionHTTPResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetSessionHTTPResponse) GetJSON409

func (r GetSessionHTTPResponse) GetJSON409() *ErrorResponse

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (GetSessionHTTPResponse) GetJSON413

func (r GetSessionHTTPResponse) GetJSON413() *ErrorResponse

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (GetSessionHTTPResponse) GetJSON415

func (r GetSessionHTTPResponse) GetJSON415() *ErrorResponse

GetJSON415 returns the response for an HTTP 415 `application/json` response

func (GetSessionHTTPResponse) GetJSON422

func (r GetSessionHTTPResponse) GetJSON422() *ErrorResponse

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (GetSessionHTTPResponse) GetJSON503

func (r GetSessionHTTPResponse) GetJSON503() *ErrorResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (GetSessionHTTPResponse) Status

func (r GetSessionHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (GetSessionHTTPResponse) StatusCode

func (r GetSessionHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HealthHTTPResponse

type HealthHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *HealthResponse
}

func ParseHealthHTTPResponse

func ParseHealthHTTPResponse(rsp *http.Response) (*HealthHTTPResponse, error)

ParseHealthHTTPResponse parses an HTTP response from a HealthWithResponse call

func (HealthHTTPResponse) ContentType

func (r HealthHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (HealthHTTPResponse) GetBody

func (r HealthHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (HealthHTTPResponse) GetJSON200

func (r HealthHTTPResponse) GetJSON200() *HealthResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (HealthHTTPResponse) Status

func (r HealthHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (HealthHTTPResponse) StatusCode

func (r HealthHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HealthResponse

type HealthResponse struct {
	Status HealthResponseStatus `json:"status"`
}

HealthResponse defines model for HealthResponse.

type HealthResponseStatus

type HealthResponseStatus string

HealthResponseStatus defines model for HealthResponse.Status.

const (
	Ok HealthResponseStatus = "ok"
)

Defines values for HealthResponseStatus.

func (HealthResponseStatus) Valid

func (e HealthResponseStatus) Valid() bool

Valid indicates whether the value is a known member of the HealthResponseStatus enum.

type HistoryPage

type HistoryPage struct {
	EventCursor string                   `json:"event_cursor"`
	Items       []HistoryPage_Items_Item `json:"items"`
	NextCursor  *string                  `json:"next_cursor"`
}

HistoryPage defines model for HistoryPage.

type HistoryPage_Items_Item

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

HistoryPage_Items_Item defines model for HistoryPage.items.Item.

func (HistoryPage_Items_Item) AsMessageItem

func (t HistoryPage_Items_Item) AsMessageItem() (MessageItem, error)

AsMessageItem returns the union data inside the HistoryPage_Items_Item as a MessageItem

func (HistoryPage_Items_Item) AsToolItem

func (t HistoryPage_Items_Item) AsToolItem() (ToolItem, error)

AsToolItem returns the union data inside the HistoryPage_Items_Item as a ToolItem

func (HistoryPage_Items_Item) Discriminator

func (t HistoryPage_Items_Item) Discriminator() (string, error)

func (*HistoryPage_Items_Item) FromMessageItem

func (t *HistoryPage_Items_Item) FromMessageItem(v MessageItem) error

FromMessageItem overwrites any union data inside the HistoryPage_Items_Item as the provided MessageItem

func (*HistoryPage_Items_Item) FromToolItem

func (t *HistoryPage_Items_Item) FromToolItem(v ToolItem) error

FromToolItem overwrites any union data inside the HistoryPage_Items_Item as the provided ToolItem

func (HistoryPage_Items_Item) MarshalJSON

func (t HistoryPage_Items_Item) MarshalJSON() ([]byte, error)

func (*HistoryPage_Items_Item) MergeMessageItem

func (t *HistoryPage_Items_Item) MergeMessageItem(v MessageItem) error

MergeMessageItem performs a merge with any union data inside the HistoryPage_Items_Item, using the provided MessageItem

func (*HistoryPage_Items_Item) MergeToolItem

func (t *HistoryPage_Items_Item) MergeToolItem(v ToolItem) error

MergeToolItem performs a merge with any union data inside the HistoryPage_Items_Item, using the provided ToolItem

func (*HistoryPage_Items_Item) UnmarshalJSON

func (t *HistoryPage_Items_Item) UnmarshalJSON(b []byte) error

func (HistoryPage_Items_Item) ValueByDiscriminator

func (t HistoryPage_Items_Item) ValueByDiscriminator() (interface{}, error)

type HookResult

type HookResult struct {
	DeadlineAt         *time.Time                   `json:"deadline_at"`
	Error              *Error                       `json:"error"`
	ExitCode           *int                         `json:"exit_code"`
	FinishedAt         *time.Time                   `json:"finished_at"`
	ID                 openapi_types.UUID           `json:"id"`
	Name               HookResultName               `json:"name"`
	Output             *HookResult_Output           `json:"output"`
	OutputCompleteness HookResultOutputCompleteness `json:"output_completeness"`
	Signal             *int                         `json:"signal"`
	StartedAt          *time.Time                   `json:"started_at"`
	Status             HookResultStatus             `json:"status"`
	TruncationReason   *HookResultTruncationReason  `json:"truncation_reason"`
}

HookResult defines model for HookResult.

type HookResultName

type HookResultName string

HookResultName defines model for HookResult.Name.

const (
	HookResultNameAfterCreate  HookResultName = "after_create"
	HookResultNameAfterRun     HookResultName = "after_run"
	HookResultNameBeforeRemove HookResultName = "before_remove"
	HookResultNameBeforeRun    HookResultName = "before_run"
)

Defines values for HookResultName.

func (HookResultName) Valid

func (e HookResultName) Valid() bool

Valid indicates whether the value is a known member of the HookResultName enum.

type HookResultOutputCompleteness

type HookResultOutputCompleteness string

HookResultOutputCompleteness defines model for HookResult.OutputCompleteness.

const (
	HookResultOutputCompletenessComplete    HookResultOutputCompleteness = "complete"
	HookResultOutputCompletenessTruncated   HookResultOutputCompleteness = "truncated"
	HookResultOutputCompletenessUnavailable HookResultOutputCompleteness = "unavailable"
	HookResultOutputCompletenessUnknown     HookResultOutputCompleteness = "unknown"
)

Defines values for HookResultOutputCompleteness.

func (HookResultOutputCompleteness) Valid

Valid indicates whether the value is a known member of the HookResultOutputCompleteness enum.

type HookResultStatus

type HookResultStatus string

HookResultStatus defines model for HookResult.Status.

const (
	HookResultStatusCancelled HookResultStatus = "cancelled"
	HookResultStatusCompleted HookResultStatus = "completed"
	HookResultStatusFailed    HookResultStatus = "failed"
	HookResultStatusPending   HookResultStatus = "pending"
	HookResultStatusRunning   HookResultStatus = "running"
	HookResultStatusSkipped   HookResultStatus = "skipped"
)

Defines values for HookResultStatus.

func (HookResultStatus) Valid

func (e HookResultStatus) Valid() bool

Valid indicates whether the value is a known member of the HookResultStatus enum.

type HookResultTruncationReason

type HookResultTruncationReason string

HookResultTruncationReason defines model for HookResult.TruncationReason.

const (
	HookResultTruncationReasonOrpheusLimit HookResultTruncationReason = "orpheus_limit"
)

Defines values for HookResultTruncationReason.

func (HookResultTruncationReason) Valid

func (e HookResultTruncationReason) Valid() bool

Valid indicates whether the value is a known member of the HookResultTruncationReason enum.

type HookResult_Output

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

HookResult_Output defines model for HookResult.Output.

func (HookResult_Output) AsTextResult

func (t HookResult_Output) AsTextResult() (TextResult, error)

AsTextResult returns the union data inside the HookResult_Output as a TextResult

func (HookResult_Output) AsTruncatedResult

func (t HookResult_Output) AsTruncatedResult() (TruncatedResult, error)

AsTruncatedResult returns the union data inside the HookResult_Output as a TruncatedResult

func (*HookResult_Output) FromTextResult

func (t *HookResult_Output) FromTextResult(v TextResult) error

FromTextResult overwrites any union data inside the HookResult_Output as the provided TextResult

func (*HookResult_Output) FromTruncatedResult

func (t *HookResult_Output) FromTruncatedResult(v TruncatedResult) error

FromTruncatedResult overwrites any union data inside the HookResult_Output as the provided TruncatedResult

func (HookResult_Output) MarshalJSON

func (t HookResult_Output) MarshalJSON() ([]byte, error)

func (*HookResult_Output) MergeTextResult

func (t *HookResult_Output) MergeTextResult(v TextResult) error

MergeTextResult performs a merge with any union data inside the HookResult_Output, using the provided TextResult

func (*HookResult_Output) MergeTruncatedResult

func (t *HookResult_Output) MergeTruncatedResult(v TruncatedResult) error

MergeTruncatedResult performs a merge with any union data inside the HookResult_Output, using the provided TruncatedResult

func (*HookResult_Output) UnmarshalJSON

func (t *HookResult_Output) UnmarshalJSON(b []byte) error

type HooksConfiguration

type HooksConfiguration struct {
	AfterCreate    *string `json:"after_create,omitempty"`
	AfterRun       *string `json:"after_run,omitempty"`
	BeforeRemove   *string `json:"before_remove,omitempty"`
	BeforeRun      *string `json:"before_run,omitempty"`
	TimeoutSeconds int     `json:"timeout_seconds"`
}

HooksConfiguration defines model for HooksConfiguration.

type HooksInput

type HooksInput struct {
	// AfterCreate Executable script text with a shebang; runs once after workspace creation.
	AfterCreate *string `json:"after_create,omitempty"`

	// AfterRun Executable script text with a shebang; runs after confirmed agent completion, before pause.
	AfterRun *string `json:"after_run,omitempty"`

	// BeforeRemove Accepted for future explicit sandbox removal; never called by this API version.
	BeforeRemove *string `json:"before_remove,omitempty"`

	// BeforeRun Executable script text with a shebang; runs before every assignment.
	BeforeRun *string `json:"before_run,omitempty"`

	// TimeoutSeconds Timeout for each hook invocation.
	TimeoutSeconds *int `json:"timeout_seconds,omitempty"`
}

HooksInput defines model for HooksInput.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type JSONResult

type JSONResult struct {
	OriginalBytes *int            `json:"original_bytes"`
	Type          JSONResultType  `json:"type"`
	Value         json.RawMessage `json:"value"`
}

JSONResult defines model for JSONResult.

type JSONResultType

type JSONResultType string

JSONResultType defines model for JSONResult.Type.

const (
	JSONResultTypeJSON JSONResultType = "json"
)

Defines values for JSONResultType.

func (JSONResultType) Valid

func (e JSONResultType) Valid() bool

Valid indicates whether the value is a known member of the JSONResultType enum.

type Limits

type Limits struct {
	// MaxSessionTokens Session-wide input and output token budget. Omission uses DEFAULT_MAX_SESSION_TOKENS (100000000 by default); explicit null is invalid.
	MaxSessionTokens int64 `json:"max_session_tokens"`

	// RunTimeoutSeconds Agent execution deadline, independent of the periodically renewed sandbox timeout. AgentBox plan limits on uninterrupted sandbox lifetime still apply.
	RunTimeoutSeconds int `json:"run_timeout_seconds"`
}

Limits defines model for Limits.

type LimitsInput

type LimitsInput struct {
	// MaxSessionTokens Session-wide input and output token budget. Omission uses DEFAULT_MAX_SESSION_TOKENS (100000000 by default); explicit null is invalid.
	MaxSessionTokens *int64 `json:"max_session_tokens,omitempty"`

	// RunTimeoutSeconds Agent execution deadline, independent of the periodically renewed sandbox timeout. AgentBox plan limits on uninterrupted sandbox lifetime still apply.
	RunTimeoutSeconds *int `json:"run_timeout_seconds,omitempty"`
}

LimitsInput defines model for LimitsInput.

type ListAllRunsHTTPResponse

type ListAllRunsHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RunPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorResponse
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *ErrorResponse
	// JSON415 the response for an HTTP 415 `application/json` response
	JSON415 *ErrorResponse
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ErrorResponse
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ErrorResponse
}

func ParseListAllRunsHTTPResponse

func ParseListAllRunsHTTPResponse(rsp *http.Response) (*ListAllRunsHTTPResponse, error)

ParseListAllRunsHTTPResponse parses an HTTP response from a ListAllRunsWithResponse call

func (ListAllRunsHTTPResponse) ContentType

func (r ListAllRunsHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListAllRunsHTTPResponse) GetBody

func (r ListAllRunsHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListAllRunsHTTPResponse) GetJSON200

func (r ListAllRunsHTTPResponse) GetJSON200() *RunPage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListAllRunsHTTPResponse) GetJSON400

func (r ListAllRunsHTTPResponse) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListAllRunsHTTPResponse) GetJSON401

func (r ListAllRunsHTTPResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListAllRunsHTTPResponse) GetJSON404

func (r ListAllRunsHTTPResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListAllRunsHTTPResponse) GetJSON409

func (r ListAllRunsHTTPResponse) GetJSON409() *ErrorResponse

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ListAllRunsHTTPResponse) GetJSON413

func (r ListAllRunsHTTPResponse) GetJSON413() *ErrorResponse

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (ListAllRunsHTTPResponse) GetJSON415

func (r ListAllRunsHTTPResponse) GetJSON415() *ErrorResponse

GetJSON415 returns the response for an HTTP 415 `application/json` response

func (ListAllRunsHTTPResponse) GetJSON422

func (r ListAllRunsHTTPResponse) GetJSON422() *ErrorResponse

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (ListAllRunsHTTPResponse) GetJSON503

func (r ListAllRunsHTTPResponse) GetJSON503() *ErrorResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ListAllRunsHTTPResponse) Status

func (r ListAllRunsHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (ListAllRunsHTTPResponse) StatusCode

func (r ListAllRunsHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListAllRunsParams

type ListAllRunsParams struct {
	Namespace        *string                 `form:"namespace,omitempty" json:"namespace,omitempty"`
	ExternalKey      *string                 `form:"external_key,omitempty" json:"external_key,omitempty"`
	InputFingerprint *string                 `form:"input_fingerprint,omitempty" json:"input_fingerprint,omitempty"`
	Status           *RunStatus              `form:"status,omitempty" json:"status,omitempty"`
	Order            *ListAllRunsParamsOrder `form:"order,omitempty" json:"order,omitempty"`
	Limit            *int                    `form:"limit,omitempty" json:"limit,omitempty"`
	Cursor           *string                 `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListAllRunsParams defines parameters for ListAllRuns.

type ListAllRunsParamsOrder

type ListAllRunsParamsOrder string

ListAllRunsParamsOrder defines parameters for ListAllRuns.

const (
	ListAllRunsParamsOrderAsc  ListAllRunsParamsOrder = "asc"
	ListAllRunsParamsOrderDesc ListAllRunsParamsOrder = "desc"
)

Defines values for ListAllRunsParamsOrder.

func (ListAllRunsParamsOrder) Valid

func (e ListAllRunsParamsOrder) Valid() bool

Valid indicates whether the value is a known member of the ListAllRunsParamsOrder enum.

type ListRunsHTTPResponse

type ListRunsHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *RunPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorResponse
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *ErrorResponse
	// JSON415 the response for an HTTP 415 `application/json` response
	JSON415 *ErrorResponse
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ErrorResponse
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ErrorResponse
}

func ParseListRunsHTTPResponse

func ParseListRunsHTTPResponse(rsp *http.Response) (*ListRunsHTTPResponse, error)

ParseListRunsHTTPResponse parses an HTTP response from a ListRunsWithResponse call

func (ListRunsHTTPResponse) ContentType

func (r ListRunsHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListRunsHTTPResponse) GetBody

func (r ListRunsHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListRunsHTTPResponse) GetJSON200

func (r ListRunsHTTPResponse) GetJSON200() *RunPage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListRunsHTTPResponse) GetJSON400

func (r ListRunsHTTPResponse) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListRunsHTTPResponse) GetJSON401

func (r ListRunsHTTPResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListRunsHTTPResponse) GetJSON404

func (r ListRunsHTTPResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListRunsHTTPResponse) GetJSON409

func (r ListRunsHTTPResponse) GetJSON409() *ErrorResponse

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ListRunsHTTPResponse) GetJSON413

func (r ListRunsHTTPResponse) GetJSON413() *ErrorResponse

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (ListRunsHTTPResponse) GetJSON415

func (r ListRunsHTTPResponse) GetJSON415() *ErrorResponse

GetJSON415 returns the response for an HTTP 415 `application/json` response

func (ListRunsHTTPResponse) GetJSON422

func (r ListRunsHTTPResponse) GetJSON422() *ErrorResponse

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (ListRunsHTTPResponse) GetJSON503

func (r ListRunsHTTPResponse) GetJSON503() *ErrorResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ListRunsHTTPResponse) Status

func (r ListRunsHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (ListRunsHTTPResponse) StatusCode

func (r ListRunsHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListRunsParams

type ListRunsParams struct {
	InputFingerprint *string              `form:"input_fingerprint,omitempty" json:"input_fingerprint,omitempty"`
	Status           *RunStatus           `form:"status,omitempty" json:"status,omitempty"`
	Order            *ListRunsParamsOrder `form:"order,omitempty" json:"order,omitempty"`
	Limit            *int                 `form:"limit,omitempty" json:"limit,omitempty"`
	Cursor           *string              `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListRunsParams defines parameters for ListRuns.

type ListRunsParamsOrder

type ListRunsParamsOrder string

ListRunsParamsOrder defines parameters for ListRuns.

const (
	ListRunsParamsOrderAsc  ListRunsParamsOrder = "asc"
	ListRunsParamsOrderDesc ListRunsParamsOrder = "desc"
)

Defines values for ListRunsParamsOrder.

func (ListRunsParamsOrder) Valid

func (e ListRunsParamsOrder) Valid() bool

Valid indicates whether the value is a known member of the ListRunsParamsOrder enum.

type ListSessionsHTTPResponse

type ListSessionsHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SessionPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorResponse
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *ErrorResponse
	// JSON415 the response for an HTTP 415 `application/json` response
	JSON415 *ErrorResponse
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ErrorResponse
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ErrorResponse
}

func ParseListSessionsHTTPResponse

func ParseListSessionsHTTPResponse(rsp *http.Response) (*ListSessionsHTTPResponse, error)

ParseListSessionsHTTPResponse parses an HTTP response from a ListSessionsWithResponse call

func (ListSessionsHTTPResponse) ContentType

func (r ListSessionsHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListSessionsHTTPResponse) GetBody

func (r ListSessionsHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionsHTTPResponse) GetJSON200

func (r ListSessionsHTTPResponse) GetJSON200() *SessionPage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListSessionsHTTPResponse) GetJSON400

func (r ListSessionsHTTPResponse) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListSessionsHTTPResponse) GetJSON401

func (r ListSessionsHTTPResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListSessionsHTTPResponse) GetJSON404

func (r ListSessionsHTTPResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListSessionsHTTPResponse) GetJSON409

func (r ListSessionsHTTPResponse) GetJSON409() *ErrorResponse

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (ListSessionsHTTPResponse) GetJSON413

func (r ListSessionsHTTPResponse) GetJSON413() *ErrorResponse

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (ListSessionsHTTPResponse) GetJSON415

func (r ListSessionsHTTPResponse) GetJSON415() *ErrorResponse

GetJSON415 returns the response for an HTTP 415 `application/json` response

func (ListSessionsHTTPResponse) GetJSON422

func (r ListSessionsHTTPResponse) GetJSON422() *ErrorResponse

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (ListSessionsHTTPResponse) GetJSON503

func (r ListSessionsHTTPResponse) GetJSON503() *ErrorResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ListSessionsHTTPResponse) Status

func (r ListSessionsHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (ListSessionsHTTPResponse) StatusCode

func (r ListSessionsHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionsParams

type ListSessionsParams struct {
	Namespace   *string                  `form:"namespace,omitempty" json:"namespace,omitempty"`
	ExternalKey *string                  `form:"external_key,omitempty" json:"external_key,omitempty"`
	Status      *RunStatus               `form:"status,omitempty" json:"status,omitempty"`
	Order       *ListSessionsParamsOrder `form:"order,omitempty" json:"order,omitempty"`
	Limit       *int                     `form:"limit,omitempty" json:"limit,omitempty"`
	Cursor      *string                  `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListSessionsParams defines parameters for ListSessions.

type ListSessionsParamsOrder

type ListSessionsParamsOrder string

ListSessionsParamsOrder defines parameters for ListSessions.

const (
	ListSessionsParamsOrderAsc  ListSessionsParamsOrder = "asc"
	ListSessionsParamsOrderDesc ListSessionsParamsOrder = "desc"
)

Defines values for ListSessionsParamsOrder.

func (ListSessionsParamsOrder) Valid

func (e ListSessionsParamsOrder) Valid() bool

Valid indicates whether the value is a known member of the ListSessionsParamsOrder enum.

type Message

type Message struct {
	CreatedAt      time.Time              `json:"created_at"`
	DeliveryStatus *MessageDeliveryStatus `json:"delivery_status"`
	Error          *Error                 `json:"error"`

	// ExternalKey External key supplied for an incoming message; null for agent messages. Opaque identifier, 1–512 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.
	ExternalKey        *string            `json:"external_key"`
	ID                 openapi_types.UUID `json:"id"`
	Kind               *MessageKind       `json:"kind"`
	Position           *Position          `json:"position"`
	RegisteredSequence string             `json:"registered_sequence"`
	Role               MessageRole        `json:"role"`
	RunID              openapi_types.UUID `json:"run_id"`
	SessionID          openapi_types.UUID `json:"session_id"`
	Text               string             `json:"text"`
}

Message defines model for Message.

type MessageDeliveryStatus

type MessageDeliveryStatus string

MessageDeliveryStatus defines model for Message.DeliveryStatus.

const (
	MessageDeliveryStatusDelivered MessageDeliveryStatus = "delivered"
	MessageDeliveryStatusPending   MessageDeliveryStatus = "pending"
	MessageDeliveryStatusRejected  MessageDeliveryStatus = "rejected"
	MessageDeliveryStatusSending   MessageDeliveryStatus = "sending"
	MessageDeliveryStatusUncertain MessageDeliveryStatus = "uncertain"
)

Defines values for MessageDeliveryStatus.

func (MessageDeliveryStatus) Valid

func (e MessageDeliveryStatus) Valid() bool

Valid indicates whether the value is a known member of the MessageDeliveryStatus enum.

type MessageEvent

type MessageEvent struct {
	CreatedAt time.Time          `json:"created_at"`
	Data      Message            `json:"data"`
	ID        string             `json:"id"`
	SessionID openapi_types.UUID `json:"session_id"`
	Type      MessageEventType   `json:"type"`
}

MessageEvent defines model for MessageEvent.

type MessageEventType

type MessageEventType string

MessageEventType defines model for MessageEvent.Type.

const (
	MessageUpdated MessageEventType = "message.updated"
)

Defines values for MessageEventType.

func (MessageEventType) Valid

func (e MessageEventType) Valid() bool

Valid indicates whether the value is a known member of the MessageEventType enum.

type MessageItem

type MessageItem struct {
	Message Message         `json:"message"`
	Type    MessageItemType `json:"type"`
}

MessageItem defines model for MessageItem.

type MessageItemType

type MessageItemType string

MessageItemType defines model for MessageItem.Type.

const (
	MessageItemTypeMessage MessageItemType = "message"
)

Defines values for MessageItemType.

func (MessageItemType) Valid

func (e MessageItemType) Valid() bool

Valid indicates whether the value is a known member of the MessageItemType enum.

type MessageKind

type MessageKind string

MessageKind defines model for Message.Kind.

const (
	Answer   MessageKind = "answer"
	Progress MessageKind = "progress"
)

Defines values for MessageKind.

func (MessageKind) Valid

func (e MessageKind) Valid() bool

Valid indicates whether the value is a known member of the MessageKind enum.

type MessageRole

type MessageRole string

MessageRole defines model for Message.Role.

const (
	Assistant MessageRole = "assistant"
	User      MessageRole = "user"
)

Defines values for MessageRole.

func (MessageRole) Valid

func (e MessageRole) Valid() bool

Valid indicates whether the value is a known member of the MessageRole enum.

type Position

type Position struct {
	ItemIndex int `json:"item_index"`
	RunNumber int `json:"run_number"`
}

Position defines model for Position.

type ReadyHTTPResponse

type ReadyHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *HealthResponse
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *UnavailableResponse
}

func ParseReadyHTTPResponse

func ParseReadyHTTPResponse(rsp *http.Response) (*ReadyHTTPResponse, error)

ParseReadyHTTPResponse parses an HTTP response from a ReadyWithResponse call

func (ReadyHTTPResponse) ContentType

func (r ReadyHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ReadyHTTPResponse) GetBody

func (r ReadyHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ReadyHTTPResponse) GetJSON200

func (r ReadyHTTPResponse) GetJSON200() *HealthResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ReadyHTTPResponse) GetJSON503

func (r ReadyHTTPResponse) GetJSON503() *UnavailableResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (ReadyHTTPResponse) Status

func (r ReadyHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (ReadyHTTPResponse) StatusCode

func (r ReadyHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type Run

type Run struct {
	AgentError        *Error          `json:"agent_error"`
	AgentStatus       *RunAgentStatus `json:"agent_status"`
	CancelRequestedAt *time.Time      `json:"cancel_requested_at"`
	CreatedAt         time.Time       `json:"created_at"`
	DeadlineAt        *time.Time      `json:"deadline_at"`

	// EnvFrom Sorted orchestrator environment variable names supplied for this run.
	EnvFrom []string `json:"env_from"`

	// EnvNames Sorted names of explicit variables supplied for this run; values are never returned.
	EnvNames           []string           `json:"env_names"`
	Error              *Error             `json:"error"`
	ExecutionStartedAt *time.Time         `json:"execution_started_at"`
	FinalMessage       *Message           `json:"final_message"`
	FinishedAt         *time.Time         `json:"finished_at"`
	Hooks              []HookResult       `json:"hooks"`
	ID                 openapi_types.UUID `json:"id"`

	// InputFingerprint Input snapshot version supplied when the run was accepted. Opaque identifier, 1–256 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.
	InputFingerprint *string            `json:"input_fingerprint"`
	Number           int                `json:"number"`
	Observation      *RunObservation    `json:"observation"`
	Phase            *RunPhase          `json:"phase"`
	SessionID        openapi_types.UUID `json:"session_id"`
	Status           RunStatus          `json:"status"`

	// StopMethod How cancellation stopped agent execution. Null until confirmed, or if the run was cancelled before the first dispatch attempt, including user-requested cancellation.
	StopMethod *RunStopMethod `json:"stop_method"`
	StopReason *RunStopReason `json:"stop_reason"`

	// Usage Last reported token consumption; missed reports are not reconstructed from history. Cached input and reasoning output are already included.
	Usage Usage `json:"usage"`
}

Run defines model for Run.

type RunAgentStatus

type RunAgentStatus string

RunAgentStatus defines model for Run.AgentStatus.

const (
	RunAgentStatusCancelled RunAgentStatus = "cancelled"
	RunAgentStatusCompleted RunAgentStatus = "completed"
	RunAgentStatusFailed    RunAgentStatus = "failed"
)

Defines values for RunAgentStatus.

func (RunAgentStatus) Valid

func (e RunAgentStatus) Valid() bool

Valid indicates whether the value is a known member of the RunAgentStatus enum.

type RunEvent

type RunEvent struct {
	CreatedAt time.Time          `json:"created_at"`
	Data      Run                `json:"data"`
	ID        string             `json:"id"`
	SessionID openapi_types.UUID `json:"session_id"`
	Type      RunEventType       `json:"type"`
}

RunEvent defines model for RunEvent.

type RunEventType

type RunEventType string

RunEventType defines model for RunEvent.Type.

const (
	RunUpdated RunEventType = "run.updated"
)

Defines values for RunEventType.

func (RunEventType) Valid

func (e RunEventType) Valid() bool

Valid indicates whether the value is a known member of the RunEventType enum.

type RunObservation

type RunObservation string

RunObservation defines model for Run.Observation.

const (
	RunObservationAttached     RunObservation = "attached"
	RunObservationReconnecting RunObservation = "reconnecting"
	RunObservationUncertain    RunObservation = "uncertain"
)

Defines values for RunObservation.

func (RunObservation) Valid

func (e RunObservation) Valid() bool

Valid indicates whether the value is a known member of the RunObservation enum.

type RunPage

type RunPage struct {
	Items      []Run   `json:"items"`
	NextCursor *string `json:"next_cursor"`
}

RunPage defines model for RunPage.

type RunPhase

type RunPhase string

RunPhase defines model for Run.Phase.

const (
	RunPhaseAfterCreate RunPhase = "after_create"
	RunPhaseAfterRun    RunPhase = "after_run"
	RunPhaseAgent       RunPhase = "agent"
	RunPhaseBeforeRun   RunPhase = "before_run"
	RunPhasePreparation RunPhase = "preparation"
)

Defines values for RunPhase.

func (RunPhase) Valid

func (e RunPhase) Valid() bool

Valid indicates whether the value is a known member of the RunPhase enum.

type RunStatus

type RunStatus string

RunStatus defines model for RunStatus.

const (
	RunStatusAccepted   RunStatus = "accepted"
	RunStatusCancelled  RunStatus = "cancelled"
	RunStatusCancelling RunStatus = "cancelling"
	RunStatusCompleted  RunStatus = "completed"
	RunStatusFailed     RunStatus = "failed"
	RunStatusFinalizing RunStatus = "finalizing"
	RunStatusRunning    RunStatus = "running"
	RunStatusStarting   RunStatus = "starting"
)

Defines values for RunStatus.

func (RunStatus) Valid

func (e RunStatus) Valid() bool

Valid indicates whether the value is a known member of the RunStatus enum.

type RunStopMethod

type RunStopMethod string

RunStopMethod defines model for Run.StopMethod.

const (
	Forced   RunStopMethod = "forced"
	Graceful RunStopMethod = "graceful"
)

Defines values for RunStopMethod.

func (RunStopMethod) Valid

func (e RunStopMethod) Valid() bool

Valid indicates whether the value is a known member of the RunStopMethod enum.

type RunStopReason

type RunStopReason string

RunStopReason defines model for Run.StopReason.

const (
	RunTimeout  RunStopReason = "run_timeout"
	TokenLimit  RunStopReason = "token_limit"
	UserRequest RunStopReason = "user_request"
)

Defines values for RunStopReason.

func (RunStopReason) Valid

func (e RunStopReason) Valid() bool

Valid indicates whether the value is a known member of the RunStopReason enum.

type SandboxConfiguration

type SandboxConfiguration struct {
	EnvFrom  []string `json:"env_from"`
	EnvNames []string `json:"env_names"`
	Template string   `json:"template"`
}

SandboxConfiguration defines model for SandboxConfiguration.

type SandboxEvent

type SandboxEvent struct {
	CreatedAt time.Time          `json:"created_at"`
	Data      SandboxState       `json:"data"`
	ID        string             `json:"id"`
	SessionID openapi_types.UUID `json:"session_id"`
	Type      SandboxEventType   `json:"type"`
}

SandboxEvent defines model for SandboxEvent.

type SandboxEventType

type SandboxEventType string

SandboxEventType defines model for SandboxEvent.Type.

const (
	SandboxUpdated SandboxEventType = "sandbox.updated"
)

Defines values for SandboxEventType.

func (SandboxEventType) Valid

func (e SandboxEventType) Valid() bool

Valid indicates whether the value is a known member of the SandboxEventType enum.

type SandboxInput

type SandboxInput struct {
	Env      *map[string]string `json:"env,omitempty"`
	EnvFrom  *[]string          `json:"env_from,omitempty"`
	Template string             `json:"template"`
}

SandboxInput defines model for SandboxInput.

type SandboxState

type SandboxState struct {
	Error *Error `json:"error"`

	// ID AgentBox sandbox ID, if known. A retained ID does not guarantee that an unavailable sandbox is accessible.
	ID             *string           `json:"id"`
	LastKnownState *string           `json:"last_known_state"`
	State          SandboxStateState `json:"state"`

	// Workspace Absolute workspace path resolved during sandbox preparation, if known.
	Workspace *string `json:"workspace"`
}

SandboxState defines model for SandboxState.

type SandboxStateState

type SandboxStateState string

SandboxStateState defines model for SandboxState.State.

const (
	SandboxStateStateNotCreated   SandboxStateState = "not_created"
	SandboxStateStatePaused       SandboxStateState = "paused"
	SandboxStateStatePausing      SandboxStateState = "pausing"
	SandboxStateStateProvisioning SandboxStateState = "provisioning"
	SandboxStateStateReady        SandboxStateState = "ready"
	SandboxStateStateResuming     SandboxStateState = "resuming"
	SandboxStateStateUnavailable  SandboxStateState = "unavailable"
)

Defines values for SandboxStateState.

func (SandboxStateState) Valid

func (e SandboxStateState) Valid() bool

Valid indicates whether the value is a known member of the SandboxStateState enum.

type SendMessage

type SendMessage struct {
	Message TextMessage `json:"message"`
}

SendMessage defines model for SendMessage.

type SendMessageHTTPResponse

type SendMessageHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *Accepted
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorResponse
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *ErrorResponse
	// JSON415 the response for an HTTP 415 `application/json` response
	JSON415 *ErrorResponse
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ErrorResponse
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ErrorResponse
	// Headers202 the parsed response headers for an HTTP 202 response
	Headers202 *SendMessageHTTPResponse202Headers
}

func ParseSendMessageHTTPResponse

func ParseSendMessageHTTPResponse(rsp *http.Response) (*SendMessageHTTPResponse, error)

ParseSendMessageHTTPResponse parses an HTTP response from a SendMessageWithResponse call

func (SendMessageHTTPResponse) ContentType

func (r SendMessageHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SendMessageHTTPResponse) GetBody

func (r SendMessageHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SendMessageHTTPResponse) GetJSON202

func (r SendMessageHTTPResponse) GetJSON202() *Accepted

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (SendMessageHTTPResponse) GetJSON400

func (r SendMessageHTTPResponse) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (SendMessageHTTPResponse) GetJSON401

func (r SendMessageHTTPResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (SendMessageHTTPResponse) GetJSON404

func (r SendMessageHTTPResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (SendMessageHTTPResponse) GetJSON409

func (r SendMessageHTTPResponse) GetJSON409() *ErrorResponse

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (SendMessageHTTPResponse) GetJSON413

func (r SendMessageHTTPResponse) GetJSON413() *ErrorResponse

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (SendMessageHTTPResponse) GetJSON415

func (r SendMessageHTTPResponse) GetJSON415() *ErrorResponse

GetJSON415 returns the response for an HTTP 415 `application/json` response

func (SendMessageHTTPResponse) GetJSON422

func (r SendMessageHTTPResponse) GetJSON422() *ErrorResponse

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (SendMessageHTTPResponse) GetJSON503

func (r SendMessageHTTPResponse) GetJSON503() *ErrorResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (SendMessageHTTPResponse) Status

func (r SendMessageHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (SendMessageHTTPResponse) StatusCode

func (r SendMessageHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SendMessageHTTPResponse202Headers

type SendMessageHTTPResponse202Headers struct {
	Location string
}

SendMessageHTTPResponse202Headers the declared response headers of an HTTP 202 response for SendMessage

type SendMessageJSONRequestBody

type SendMessageJSONRequestBody = SendMessage

SendMessageJSONRequestBody defines body for SendMessage for application/json ContentType.

type SendMessageParams

type SendMessageParams struct {
	IdempotencyKey *string `json:"Idempotency-Key,omitempty"`
}

SendMessageParams defines parameters for SendMessage.

type Session

type Session struct {
	ActiveRunID   *openapi_types.UUID `json:"active_run_id"`
	Configuration Configuration       `json:"configuration"`
	CreatedAt     time.Time           `json:"created_at"`
	Error         *Error              `json:"error"`

	// ExternalKey Source-qualified external object key; not unique across sessions. Opaque identifier, 1–512 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.
	ExternalKey  *string            `json:"external_key"`
	FinalMessage *Message           `json:"final_message"`
	ID           openapi_types.UUID `json:"id"`
	LastRunID    openapi_types.UUID `json:"last_run_id"`

	// Namespace Logical integration or workflow name. Opaque identifier, 1–128 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.
	Namespace *string       `json:"namespace"`
	Phase     *SessionPhase `json:"phase"`
	Sandbox   SandboxState  `json:"sandbox"`
	Status    RunStatus     `json:"status"`

	// Usage Last reported token consumption; missed reports are not reconstructed from history. Cached input and reasoning output are already included.
	Usage Usage `json:"usage"`
}

Session defines model for Session.

type SessionPage

type SessionPage struct {
	Items      []Session `json:"items"`
	NextCursor *string   `json:"next_cursor"`
}

SessionPage defines model for SessionPage.

type SessionPhase

type SessionPhase string

SessionPhase defines model for Session.Phase.

const (
	SessionPhaseAfterCreate SessionPhase = "after_create"
	SessionPhaseAfterRun    SessionPhase = "after_run"
	SessionPhaseAgent       SessionPhase = "agent"
	SessionPhaseBeforeRun   SessionPhase = "before_run"
	SessionPhasePreparation SessionPhase = "preparation"
)

Defines values for SessionPhase.

func (SessionPhase) Valid

func (e SessionPhase) Valid() bool

Valid indicates whether the value is a known member of the SessionPhase enum.

type StreamEventsHTTPResponse

type StreamEventsHTTPResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorResponse
	// JSON413 the response for an HTTP 413 `application/json` response
	JSON413 *ErrorResponse
	// JSON415 the response for an HTTP 415 `application/json` response
	JSON415 *ErrorResponse
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *ErrorResponse
	// JSON503 the response for an HTTP 503 `application/json` response
	JSON503 *ErrorResponse
}

func ParseStreamEventsHTTPResponse

func ParseStreamEventsHTTPResponse(rsp *http.Response) (*StreamEventsHTTPResponse, error)

ParseStreamEventsHTTPResponse parses an HTTP response from a StreamEventsWithResponse call

func (StreamEventsHTTPResponse) ContentType

func (r StreamEventsHTTPResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (StreamEventsHTTPResponse) GetBody

func (r StreamEventsHTTPResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (StreamEventsHTTPResponse) GetJSON400

func (r StreamEventsHTTPResponse) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (StreamEventsHTTPResponse) GetJSON401

func (r StreamEventsHTTPResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (StreamEventsHTTPResponse) GetJSON404

func (r StreamEventsHTTPResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (StreamEventsHTTPResponse) GetJSON409

func (r StreamEventsHTTPResponse) GetJSON409() *ErrorResponse

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (StreamEventsHTTPResponse) GetJSON413

func (r StreamEventsHTTPResponse) GetJSON413() *ErrorResponse

GetJSON413 returns the response for an HTTP 413 `application/json` response

func (StreamEventsHTTPResponse) GetJSON415

func (r StreamEventsHTTPResponse) GetJSON415() *ErrorResponse

GetJSON415 returns the response for an HTTP 415 `application/json` response

func (StreamEventsHTTPResponse) GetJSON422

func (r StreamEventsHTTPResponse) GetJSON422() *ErrorResponse

GetJSON422 returns the response for an HTTP 422 `application/json` response

func (StreamEventsHTTPResponse) GetJSON503

func (r StreamEventsHTTPResponse) GetJSON503() *ErrorResponse

GetJSON503 returns the response for an HTTP 503 `application/json` response

func (StreamEventsHTTPResponse) Status

func (r StreamEventsHTTPResponse) Status() string

Status returns HTTPResponse.Status

func (StreamEventsHTTPResponse) StatusCode

func (r StreamEventsHTTPResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type StreamEventsParams

type StreamEventsParams struct {
	After       *string `form:"after,omitempty" json:"after,omitempty"`
	LastEventID *string `json:"last-event-id,omitempty"`
}

StreamEventsParams defines parameters for StreamEvents.

type TextMessage

type TextMessage struct {
	// ExternalKey External message or event key; not unique and not sent to the harness. Opaque identifier, 1–512 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.
	ExternalKey *string `json:"external_key,omitempty"`
	Text        string  `json:"text"`
}

TextMessage defines model for TextMessage.

type TextResult

type TextResult struct {
	ExitCode      *int           `json:"exit_code,omitempty"`
	OriginalBytes *int           `json:"original_bytes"`
	Text          string         `json:"text"`
	Type          TextResultType `json:"type"`
}

TextResult defines model for TextResult.

type TextResultType

type TextResultType string

TextResultType defines model for TextResult.Type.

const (
	TextResultTypeText TextResultType = "text"
)

Defines values for TextResultType.

func (TextResultType) Valid

func (e TextResultType) Valid() bool

Valid indicates whether the value is a known member of the TextResultType enum.

type ToolCall

type ToolCall struct {
	CreatedAt          time.Time                  `json:"created_at"`
	ID                 openapi_types.UUID         `json:"id"`
	Input              json.RawMessage            `json:"input"`
	Name               string                     `json:"name"`
	OutputCompleteness ToolCallOutputCompleteness `json:"output_completeness"`
	Position           *Position                  `json:"position"`
	RegisteredSequence string                     `json:"registered_sequence"`
	Result             *ToolResult                `json:"result"`
	RunID              openapi_types.UUID         `json:"run_id"`
	SessionID          openapi_types.UUID         `json:"session_id"`
	Status             ToolCallStatus             `json:"status"`
	TruncationReason   *ToolCallTruncationReason  `json:"truncation_reason"`
}

ToolCall defines model for ToolCall.

type ToolCallEvent

type ToolCallEvent struct {
	CreatedAt time.Time          `json:"created_at"`
	Data      ToolCall           `json:"data"`
	ID        string             `json:"id"`
	SessionID openapi_types.UUID `json:"session_id"`
	Type      ToolCallEventType  `json:"type"`
}

ToolCallEvent defines model for ToolCallEvent.

type ToolCallEventType

type ToolCallEventType string

ToolCallEventType defines model for ToolCallEvent.Type.

const (
	ToolCallUpdated ToolCallEventType = "tool_call.updated"
)

Defines values for ToolCallEventType.

func (ToolCallEventType) Valid

func (e ToolCallEventType) Valid() bool

Valid indicates whether the value is a known member of the ToolCallEventType enum.

type ToolCallOutputCompleteness

type ToolCallOutputCompleteness string

ToolCallOutputCompleteness defines model for ToolCall.OutputCompleteness.

const (
	ToolCallOutputCompletenessComplete    ToolCallOutputCompleteness = "complete"
	ToolCallOutputCompletenessTruncated   ToolCallOutputCompleteness = "truncated"
	ToolCallOutputCompletenessUnavailable ToolCallOutputCompleteness = "unavailable"
	ToolCallOutputCompletenessUnknown     ToolCallOutputCompleteness = "unknown"
)

Defines values for ToolCallOutputCompleteness.

func (ToolCallOutputCompleteness) Valid

func (e ToolCallOutputCompleteness) Valid() bool

Valid indicates whether the value is a known member of the ToolCallOutputCompleteness enum.

type ToolCallStatus

type ToolCallStatus string

ToolCallStatus defines model for ToolCall.Status.

const (
	ToolCallStatusCancelled ToolCallStatus = "cancelled"
	ToolCallStatusCompleted ToolCallStatus = "completed"
	ToolCallStatusFailed    ToolCallStatus = "failed"
	ToolCallStatusRunning   ToolCallStatus = "running"
	ToolCallStatusUnknown   ToolCallStatus = "unknown"
)

Defines values for ToolCallStatus.

func (ToolCallStatus) Valid

func (e ToolCallStatus) Valid() bool

Valid indicates whether the value is a known member of the ToolCallStatus enum.

type ToolCallTruncationReason

type ToolCallTruncationReason string

ToolCallTruncationReason defines model for ToolCall.TruncationReason.

const (
	ToolCallTruncationReasonHarnessLimit ToolCallTruncationReason = "harness_limit"
	ToolCallTruncationReasonOrpheusLimit ToolCallTruncationReason = "orpheus_limit"
)

Defines values for ToolCallTruncationReason.

func (ToolCallTruncationReason) Valid

func (e ToolCallTruncationReason) Valid() bool

Valid indicates whether the value is a known member of the ToolCallTruncationReason enum.

type ToolItem

type ToolItem struct {
	ToolCall ToolCall     `json:"tool_call"`
	Type     ToolItemType `json:"type"`
}

ToolItem defines model for ToolItem.

type ToolItemType

type ToolItemType string

ToolItemType defines model for ToolItem.Type.

const (
	ToolItemTypeToolCall ToolItemType = "tool_call"
)

Defines values for ToolItemType.

func (ToolItemType) Valid

func (e ToolItemType) Valid() bool

Valid indicates whether the value is a known member of the ToolItemType enum.

type ToolResult

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

ToolResult defines model for ToolResult.

func (ToolResult) AsJSONResult

func (t ToolResult) AsJSONResult() (JSONResult, error)

AsJSONResult returns the union data inside the ToolResult as a JSONResult

func (ToolResult) AsTextResult

func (t ToolResult) AsTextResult() (TextResult, error)

AsTextResult returns the union data inside the ToolResult as a TextResult

func (ToolResult) AsTruncatedResult

func (t ToolResult) AsTruncatedResult() (TruncatedResult, error)

AsTruncatedResult returns the union data inside the ToolResult as a TruncatedResult

func (ToolResult) Discriminator

func (t ToolResult) Discriminator() (string, error)

func (*ToolResult) FromJSONResult

func (t *ToolResult) FromJSONResult(v JSONResult) error

FromJSONResult overwrites any union data inside the ToolResult as the provided JSONResult

func (*ToolResult) FromTextResult

func (t *ToolResult) FromTextResult(v TextResult) error

FromTextResult overwrites any union data inside the ToolResult as the provided TextResult

func (*ToolResult) FromTruncatedResult

func (t *ToolResult) FromTruncatedResult(v TruncatedResult) error

FromTruncatedResult overwrites any union data inside the ToolResult as the provided TruncatedResult

func (ToolResult) MarshalJSON

func (t ToolResult) MarshalJSON() ([]byte, error)

func (*ToolResult) MergeJSONResult

func (t *ToolResult) MergeJSONResult(v JSONResult) error

MergeJSONResult performs a merge with any union data inside the ToolResult, using the provided JSONResult

func (*ToolResult) MergeTextResult

func (t *ToolResult) MergeTextResult(v TextResult) error

MergeTextResult performs a merge with any union data inside the ToolResult, using the provided TextResult

func (*ToolResult) MergeTruncatedResult

func (t *ToolResult) MergeTruncatedResult(v TruncatedResult) error

MergeTruncatedResult performs a merge with any union data inside the ToolResult, using the provided TruncatedResult

func (*ToolResult) UnmarshalJSON

func (t *ToolResult) UnmarshalJSON(b []byte) error

func (ToolResult) ValueByDiscriminator

func (t ToolResult) ValueByDiscriminator() (interface{}, error)

type TruncatedResult

type TruncatedResult struct {
	ExitCode      *int                       `json:"exit_code,omitempty"`
	Head          string                     `json:"head"`
	OriginalBytes *int                       `json:"original_bytes"`
	SourceType    *TruncatedResultSourceType `json:"source_type,omitempty"`
	Tail          string                     `json:"tail"`
	Type          TruncatedResultType        `json:"type"`
}

TruncatedResult defines model for TruncatedResult.

type TruncatedResultSourceType

type TruncatedResultSourceType string

TruncatedResultSourceType defines model for TruncatedResult.SourceType.

const (
	TruncatedResultSourceTypeJSON TruncatedResultSourceType = "json"
	TruncatedResultSourceTypeText TruncatedResultSourceType = "text"
)

Defines values for TruncatedResultSourceType.

func (TruncatedResultSourceType) Valid

func (e TruncatedResultSourceType) Valid() bool

Valid indicates whether the value is a known member of the TruncatedResultSourceType enum.

type TruncatedResultType

type TruncatedResultType string

TruncatedResultType defines model for TruncatedResult.Type.

const (
	TruncatedText TruncatedResultType = "truncated_text"
)

Defines values for TruncatedResultType.

func (TruncatedResultType) Valid

func (e TruncatedResultType) Valid() bool

Valid indicates whether the value is a known member of the TruncatedResultType enum.

type UnavailableResponse

type UnavailableResponse struct {
	Status UnavailableResponseStatus `json:"status"`
}

UnavailableResponse defines model for UnavailableResponse.

type UnavailableResponseStatus

type UnavailableResponseStatus string

UnavailableResponseStatus defines model for UnavailableResponse.Status.

const (
	UnavailableResponseStatusUnavailable UnavailableResponseStatus = "unavailable"
)

Defines values for UnavailableResponseStatus.

func (UnavailableResponseStatus) Valid

func (e UnavailableResponseStatus) Valid() bool

Valid indicates whether the value is a known member of the UnavailableResponseStatus enum.

type Usage

type Usage struct {
	InputTokens  int64 `json:"input_tokens"`
	OutputTokens int64 `json:"output_tokens"`
	TotalTokens  int64 `json:"total_tokens"`
}

Usage Last reported token consumption; missed reports are not reconstructed from history. Cached input and reasoning output are already included.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL