client

package
v0.45.2 Latest Latest
Warning

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

Go to latest
Published: Nov 7, 2026 License: MIT Imports: 11 Imported by: 0

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 holds Peen's generated HTTP API client.

It is generated from the same `api/api.yml` document the server is generated from, so a caller and the service cannot drift: a change to the contract regenerates both or neither. Use this rather than hand-rolling requests against the documented paths.

For an in-process caller, `pkg/peen` is the supported entry point and needs no HTTP at all. This package is for talking to a Peen that runs somewhere else.

Pass the server's REST base, such as "http://127.0.0.1:8080/api/v1", to NewClient. Peen mounts REST under /api/v1 and the WebSocket separately under /ws/v1; this client only talks to the former.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCancelSessionAgentRunRequest

func NewCancelSessionAgentRunRequest(server string, agentRunId AgentRunID, params *CancelSessionAgentRunParams) (*http.Request, error)

NewCancelSessionAgentRunRequest constructs an http.Request for the CancelSessionAgentRun method

func NewCancelSessionRequest

func NewCancelSessionRequest(server string, params *CancelSessionParams) (*http.Request, error)

NewCancelSessionRequest constructs an http.Request for the CancelSession method

func NewDeleteSessionLearnedFileRequest added in v0.37.0

func NewDeleteSessionLearnedFileRequest(server string, params *DeleteSessionLearnedFileParams) (*http.Request, error)

NewDeleteSessionLearnedFileRequest constructs an http.Request for the DeleteSessionLearnedFile method

func NewGetSessionAgentRunCompactionRequest added in v0.11.0

func NewGetSessionAgentRunCompactionRequest(server string, agentRunId AgentRunID, compactionId CompactionID, params *GetSessionAgentRunCompactionParams) (*http.Request, error)

NewGetSessionAgentRunCompactionRequest constructs an http.Request for the GetSessionAgentRunCompaction method

func NewGetSessionAgentRunRequest added in v0.4.0

func NewGetSessionAgentRunRequest(server string, agentRunId AgentRunID, params *GetSessionAgentRunParams) (*http.Request, error)

NewGetSessionAgentRunRequest constructs an http.Request for the GetSessionAgentRun method

func NewGetSessionCompactionRequest added in v0.4.0

func NewGetSessionCompactionRequest(server string, compactionId CompactionID, params *GetSessionCompactionParams) (*http.Request, error)

NewGetSessionCompactionRequest constructs an http.Request for the GetSessionCompaction method

func NewGetSessionContextSnapshotRequest added in v0.4.0

func NewGetSessionContextSnapshotRequest(server string, contextHash ContextHash, params *GetSessionContextSnapshotParams) (*http.Request, error)

NewGetSessionContextSnapshotRequest constructs an http.Request for the GetSessionContextSnapshot method

func NewGetSessionLearnedFileRequest added in v0.37.0

func NewGetSessionLearnedFileRequest(server string, params *GetSessionLearnedFileParams) (*http.Request, error)

NewGetSessionLearnedFileRequest constructs an http.Request for the GetSessionLearnedFile method

func NewGetSessionMCPStatusRequest added in v0.38.0

func NewGetSessionMCPStatusRequest(server string, params *GetSessionMCPStatusParams) (*http.Request, error)

NewGetSessionMCPStatusRequest constructs an http.Request for the GetSessionMCPStatus method

func NewGetSessionPromptSnapshotRequest added in v0.4.0

func NewGetSessionPromptSnapshotRequest(server string, promptHash PromptHash, params *GetSessionPromptSnapshotParams) (*http.Request, error)

NewGetSessionPromptSnapshotRequest constructs an http.Request for the GetSessionPromptSnapshot method

func NewGetSessionRequest

func NewGetSessionRequest(server string, params *GetSessionParams) (*http.Request, error)

NewGetSessionRequest constructs an http.Request for the GetSession method

func NewListAgentSpacesRequest added in v0.19.0

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

NewListAgentSpacesRequest constructs an http.Request for the ListAgentSpaces method

func NewListMessagesRequest

func NewListMessagesRequest(server string, params *ListMessagesParams) (*http.Request, error)

NewListMessagesRequest constructs an http.Request for the ListMessages method

func NewListModelsRequest added in v0.12.0

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

NewListModelsRequest constructs an http.Request for the ListModels method

func NewListSessionAgentRunCompactionsRequest added in v0.11.0

func NewListSessionAgentRunCompactionsRequest(server string, agentRunId AgentRunID, params *ListSessionAgentRunCompactionsParams) (*http.Request, error)

NewListSessionAgentRunCompactionsRequest constructs an http.Request for the ListSessionAgentRunCompactions method

func NewListSessionAgentRunEventsRequest

func NewListSessionAgentRunEventsRequest(server string, agentRunId AgentRunID, params *ListSessionAgentRunEventsParams) (*http.Request, error)

NewListSessionAgentRunEventsRequest constructs an http.Request for the ListSessionAgentRunEvents method

func NewListSessionAgentRunMessagesRequest added in v0.11.0

func NewListSessionAgentRunMessagesRequest(server string, agentRunId AgentRunID, params *ListSessionAgentRunMessagesParams) (*http.Request, error)

NewListSessionAgentRunMessagesRequest constructs an http.Request for the ListSessionAgentRunMessages method

func NewListSessionAgentRunsRequest

func NewListSessionAgentRunsRequest(server string, params *ListSessionAgentRunsParams) (*http.Request, error)

NewListSessionAgentRunsRequest constructs an http.Request for the ListSessionAgentRuns method

func NewListSessionAgentSpaceDecisionsRequest added in v0.19.0

func NewListSessionAgentSpaceDecisionsRequest(server string, params *ListSessionAgentSpaceDecisionsParams) (*http.Request, error)

NewListSessionAgentSpaceDecisionsRequest constructs an http.Request for the ListSessionAgentSpaceDecisions method

func NewListSessionCompactionsRequest added in v0.4.0

func NewListSessionCompactionsRequest(server string, params *ListSessionCompactionsParams) (*http.Request, error)

NewListSessionCompactionsRequest constructs an http.Request for the ListSessionCompactions method

func NewListSessionEventsRequest

func NewListSessionEventsRequest(server string, params *ListSessionEventsParams) (*http.Request, error)

NewListSessionEventsRequest constructs an http.Request for the ListSessionEvents method

func NewListSessionFeedRequest added in v0.26.0

func NewListSessionFeedRequest(server string, params *ListSessionFeedParams) (*http.Request, error)

NewListSessionFeedRequest constructs an http.Request for the ListSessionFeed method

func NewListSessionJobSignalRequestsRequest added in v0.4.0

func NewListSessionJobSignalRequestsRequest(server string, jobId JobID, params *ListSessionJobSignalRequestsParams) (*http.Request, error)

NewListSessionJobSignalRequestsRequest constructs an http.Request for the ListSessionJobSignalRequests method

func NewListSessionJobsRequest

func NewListSessionJobsRequest(server string, params *ListSessionJobsParams) (*http.Request, error)

NewListSessionJobsRequest constructs an http.Request for the ListSessionJobs method

func NewListSessionLearnedFilesRequest added in v0.37.0

func NewListSessionLearnedFilesRequest(server string, params *ListSessionLearnedFilesParams) (*http.Request, error)

NewListSessionLearnedFilesRequest constructs an http.Request for the ListSessionLearnedFiles method

func NewListSessionModelRunCallsRequest added in v0.4.0

func NewListSessionModelRunCallsRequest(server string, modelRunId ModelRunID, params *ListSessionModelRunCallsParams) (*http.Request, error)

NewListSessionModelRunCallsRequest constructs an http.Request for the ListSessionModelRunCalls method

func NewListSessionModelRunsRequest added in v0.4.0

func NewListSessionModelRunsRequest(server string, params *ListSessionModelRunsParams) (*http.Request, error)

NewListSessionModelRunsRequest constructs an http.Request for the ListSessionModelRuns method

func NewListSessionNoticesRequest added in v0.4.0

func NewListSessionNoticesRequest(server string, params *ListSessionNoticesParams) (*http.Request, error)

NewListSessionNoticesRequest constructs an http.Request for the ListSessionNotices method

func NewListSessionTurnsRequest added in v0.4.0

func NewListSessionTurnsRequest(server string, params *ListSessionTurnsParams) (*http.Request, error)

NewListSessionTurnsRequest constructs an http.Request for the ListSessionTurns method

func NewListSessionWorkersRequest added in v0.8.0

func NewListSessionWorkersRequest(server string, params *ListSessionWorkersParams) (*http.Request, error)

NewListSessionWorkersRequest constructs an http.Request for the ListSessionWorkers method

func NewListSessionsRequest added in v0.8.0

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

NewListSessionsRequest constructs an http.Request for the ListSessions method

func NewListWorkspaceRootsRequest added in v0.13.0

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

NewListWorkspaceRootsRequest constructs an http.Request for the ListWorkspaceRoots method

func NewOpenSessionRequest added in v0.8.0

func NewOpenSessionRequest(server string, body OpenSessionJSONRequestBody) (*http.Request, error)

NewOpenSessionRequest calls the generic OpenSession builder with application/json body

func NewOpenSessionRequestWithBody added in v0.8.0

func NewOpenSessionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

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

func NewOpenSystemSessionRequest added in v0.45.0

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

NewOpenSystemSessionRequest constructs an http.Request for the OpenSystemSession method

func NewPublishSessionNoticeRequest added in v0.4.0

func NewPublishSessionNoticeRequest(server string, params *PublishSessionNoticeParams, body PublishSessionNoticeJSONRequestBody) (*http.Request, error)

NewPublishSessionNoticeRequest calls the generic PublishSessionNotice builder with application/json body

func NewPublishSessionNoticeRequestWithBody added in v0.4.0

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

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

func NewReadSessionJobOutputRequest

func NewReadSessionJobOutputRequest(server string, jobId JobID, params *ReadSessionJobOutputParams) (*http.Request, error)

NewReadSessionJobOutputRequest constructs an http.Request for the ReadSessionJobOutput method

func NewReconfigureSessionRequest added in v0.8.0

func NewReconfigureSessionRequest(server string, params *ReconfigureSessionParams, body ReconfigureSessionJSONRequestBody) (*http.Request, error)

NewReconfigureSessionRequest calls the generic ReconfigureSession builder with application/json body

func NewReconfigureSessionRequestWithBody added in v0.8.0

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

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

func NewSignalSessionJobRequest

func NewSignalSessionJobRequest(server string, jobId JobID, params *SignalSessionJobParams, body SignalSessionJobJSONRequestBody) (*http.Request, error)

NewSignalSessionJobRequest calls the generic SignalSessionJob builder with application/json body

func NewSignalSessionJobRequestWithBody

func NewSignalSessionJobRequestWithBody(server string, jobId JobID, params *SignalSessionJobParams, contentType string, body io.Reader) (*http.Request, error)

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

Types

type AgentRun

type AgentRun struct {
	AgentRunId            openapi_types.UUID  `json:"agentRunId"`
	AllowedTools          []interface{}       `json:"allowedTools"`
	CancelRequested       bool                `json:"cancelRequested"`
	CompletionTokenCount  int64               `json:"completionTokenCount"`
	Definition            AgentRunDefinition  `json:"definition"`
	Depth                 int64               `json:"depth"`
	EndedAt               *time.Time          `json:"endedAt,omitempty"`
	EventCount            int64               `json:"eventCount"`
	FailureClassification string              `json:"failureClassification"`
	FailureDetail         string              `json:"failureDetail"`
	FinishReason          string              `json:"finishReason"`
	Instructions          string              `json:"instructions"`
	Model                 string              `json:"model"`
	ModelReference        string              `json:"modelReference"`
	Name                  string              `json:"name"`
	ParentAgentRunId      *openapi_types.UUID `json:"parentAgentRunId,omitempty"`
	ParentToolCallId      *string             `json:"parentToolCallId,omitempty"`
	ParentTurnId          openapi_types.UUID  `json:"parentTurnId"`

	// Paused True while the run is running but its work is paused by a Stop, a crash, or a failure. A message to the run resumes it.
	Paused           *bool `json:"paused,omitempty"`
	PromptTokenCount int64 `json:"promptTokenCount"`

	// Question The question a waiting run asked. Absent otherwise.
	Question         *string            `json:"question,omitempty"`
	RequestId        openapi_types.UUID `json:"requestId"`
	ResponseMessages []interface{}      `json:"responseMessages"`
	ResponseText     string             `json:"responseText"`
	ResponseThinking string             `json:"responseThinking"`
	SessionId        openapi_types.UUID `json:"sessionId"`
	StartedAt        time.Time          `json:"startedAt"`
	State            AgentRunState      `json:"state"`
	SystemPrompt     string             `json:"systemPrompt"`
	Task             string             `json:"task"`

	// Waiting True while the run is running and waits for an answer to the question it asked.
	Waiting bool `json:"waiting"`

	// WorkerGenerationId Worker generation currently running, or last to run, this child agent.
	WorkerGenerationId *string `json:"workerGenerationId,omitempty"`

	// Workspace Current directory checkpointed by the child agent.
	Workspace string `json:"workspace"`
}

AgentRun defines model for AgentRun.

type AgentRunCancelResponse

type AgentRunCancelResponse struct {
	AgentRunId openapi_types.UUID `json:"agentRunId"`

	// CancelRequested True when this request found a running agent and signalled it. Cancelling an unknown, completed, or already cancelled run is not an error and reports false with the current state.
	CancelRequested bool                        `json:"cancelRequested"`
	State           AgentRunCancelResponseState `json:"state"`
}

AgentRunCancelResponse defines model for AgentRunCancelResponse.

type AgentRunCancelResponseState

type AgentRunCancelResponseState string

AgentRunCancelResponseState defines model for AgentRunCancelResponse.State.

const (
	AgentRunCancelResponseStateCancelled   AgentRunCancelResponseState = "cancelled"
	AgentRunCancelResponseStateCompleted   AgentRunCancelResponseState = "completed"
	AgentRunCancelResponseStateFailed      AgentRunCancelResponseState = "failed"
	AgentRunCancelResponseStateInterrupted AgentRunCancelResponseState = "interrupted"
	AgentRunCancelResponseStateRunning     AgentRunCancelResponseState = "running"
)

Defines values for AgentRunCancelResponseState.

func (AgentRunCancelResponseState) Valid

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

type AgentRunCompaction added in v0.11.0

type AgentRunCompaction struct {
	AgentRunId         openapi_types.UUID `json:"agentRunId"`
	CreatedAt          time.Time          `json:"createdAt"`
	DirectFromSequence int64              `json:"directFromSequence"`
	DirectToSequence   int64              `json:"directToSequence"`
	FromMessageId      openapi_types.UUID `json:"fromMessageId"`
	FromSequence       int64              `json:"fromSequence"`
	Id                 openapi_types.UUID `json:"id"`
	InputTokenCount    int64              `json:"inputTokenCount"`
	Model              string             `json:"model"`

	// ParentCompactionId The direct predecessor this compaction supersedes, or null for the first compaction in the chain.
	ParentCompactionId *openapi_types.UUID `json:"parentCompactionId,omitempty"`
	PromptHash         string              `json:"promptHash"`
	SessionId          openapi_types.UUID  `json:"sessionId"`
	SourceMessageCount int64               `json:"sourceMessageCount"`
	Summary            string              `json:"summary"`
	SummaryTokenCount  int64               `json:"summaryTokenCount"`
	ToMessageId        openapi_types.UUID  `json:"toMessageId"`
	ToSequence         int64               `json:"toSequence"`
}

AgentRunCompaction One immutable summary covering a completed prefix of one child agent run's transcript. directFromSequence and directToSequence name only the messages this row covered itself; fromSequence and toSequence span the whole superseded lineage.

type AgentRunCompactionPage added in v0.11.0

type AgentRunCompactionPage struct {
	Compactions []AgentRunCompaction `json:"compactions"`
	HasMore     bool                 `json:"hasMore"`
	Limit       int32                `json:"limit"`
	Offset      int32                `json:"offset"`
}

AgentRunCompactionPage defines model for AgentRunCompactionPage.

type AgentRunDefinition

type AgentRunDefinition string

AgentRunDefinition defines model for AgentRun.Definition.

const (
	AgentRunDefinitionAdHoc  AgentRunDefinition = "ad-hoc"
	AgentRunDefinitionStored AgentRunDefinition = "stored"
)

Defines values for AgentRunDefinition.

func (AgentRunDefinition) Valid

func (e AgentRunDefinition) Valid() bool

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

type AgentRunEvent

type AgentRunEvent struct {
	CreatedAt time.Time `json:"createdAt"`

	// Payload Child step data. Queued, delivered and undelivered message events carry message and an optional acceptanceId UUID linking the same accepted message. Question and answer events carry an optional callId linking the ask tool call. Older stored events omit these IDs.
	Payload  *map[string]interface{} `json:"payload,omitempty"`
	Sequence int64                   `json:"sequence"`
	Type     string                  `json:"type"`
}

AgentRunEvent defines model for AgentRunEvent.

type AgentRunEventPage

type AgentRunEventPage struct {
	AgentRunId openapi_types.UUID `json:"agentRunId"`
	Events     []AgentRunEvent    `json:"events"`
	HasMore    bool               `json:"hasMore"`

	// NextCursor Pass back as cursor to continue from here.
	NextCursor int64                  `json:"nextCursor"`
	State      AgentRunEventPageState `json:"state"`
}

AgentRunEventPage defines model for AgentRunEventPage.

type AgentRunEventPageState

type AgentRunEventPageState string

AgentRunEventPageState defines model for AgentRunEventPage.State.

const (
	AgentRunEventPageStateCancelled   AgentRunEventPageState = "cancelled"
	AgentRunEventPageStateCompleted   AgentRunEventPageState = "completed"
	AgentRunEventPageStateFailed      AgentRunEventPageState = "failed"
	AgentRunEventPageStateInterrupted AgentRunEventPageState = "interrupted"
	AgentRunEventPageStateRunning     AgentRunEventPageState = "running"
)

Defines values for AgentRunEventPageState.

func (AgentRunEventPageState) Valid

func (e AgentRunEventPageState) Valid() bool

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

type AgentRunID

type AgentRunID = openapi_types.UUID

AgentRunID defines model for AgentRunID.

type AgentRunMessage added in v0.11.0

type AgentRunMessage struct {
	AgentRunId openapi_types.UUID `json:"agentRunId"`

	// CompactionId The child compaction that directly covered this message, or null while it is still raw.
	CompactionId *openapi_types.UUID `json:"compactionId,omitempty"`
	Content      string              `json:"content"`
	CreatedAt    time.Time           `json:"createdAt"`
	Id           openapi_types.UUID  `json:"id"`

	// Images The images the message carries, without their bytes, such as an image the child's readFile read. Absent when it has none.
	Images     *[]MessageImageInfo       `json:"images,omitempty"`
	Incomplete bool                      `json:"incomplete"`
	IsError    bool                      `json:"isError"`
	Model      *string                   `json:"model,omitempty"`
	Role       AgentRunMessageRole       `json:"role"`
	Sequence   int64                     `json:"sequence"`
	SessionId  openapi_types.UUID        `json:"sessionId"`
	Thinking   *string                   `json:"thinking,omitempty"`
	ToolCallId *string                   `json:"toolCallId,omitempty"`
	ToolCalls  *[]map[string]interface{} `json:"toolCalls,omitempty"`
}

AgentRunMessage One prompt-visible record in a child agent run's own transcript. It carries no turn: a child belongs to its agent run, not to a session turn's message sequence.

type AgentRunMessagePage added in v0.11.0

type AgentRunMessagePage struct {
	HasMore  bool              `json:"hasMore"`
	Limit    int32             `json:"limit"`
	Messages []AgentRunMessage `json:"messages"`
	Offset   int32             `json:"offset"`
}

AgentRunMessagePage defines model for AgentRunMessagePage.

type AgentRunMessageRole added in v0.11.0

type AgentRunMessageRole string

AgentRunMessageRole defines model for AgentRunMessage.Role.

const (
	AgentRunMessageRoleAssistant AgentRunMessageRole = "assistant"
	AgentRunMessageRoleTool      AgentRunMessageRole = "tool"
	AgentRunMessageRoleUser      AgentRunMessageRole = "user"
)

Defines values for AgentRunMessageRole.

func (AgentRunMessageRole) Valid added in v0.11.0

func (e AgentRunMessageRole) Valid() bool

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

type AgentRunPage

type AgentRunPage struct {
	Agents  []AgentRun `json:"agents"`
	HasMore bool       `json:"hasMore"`
	Limit   int32      `json:"limit"`
	Offset  int32      `json:"offset"`
}

AgentRunPage defines model for AgentRunPage.

type AgentRunState

type AgentRunState string

AgentRunState defines model for AgentRun.State.

const (
	AgentRunStateCancelled   AgentRunState = "cancelled"
	AgentRunStateCompleted   AgentRunState = "completed"
	AgentRunStateFailed      AgentRunState = "failed"
	AgentRunStateInterrupted AgentRunState = "interrupted"
	AgentRunStateRunning     AgentRunState = "running"
)

Defines values for AgentRunState.

func (AgentRunState) Valid

func (e AgentRunState) Valid() bool

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

type AgentSpace added in v0.19.0

type AgentSpace struct {
	// CapabilityWarnings One operator-facing sentence for each risky grant this space makes. Empty for a space that grants nothing risky.
	CapabilityWarnings []string `json:"capabilityWarnings"`

	// Docker How much of the host Docker daemon the space reaches. `full` mounts the controller's Docker socket, which is host root. `readonly` gives the worker a controller-run proxy that answers only read requests (list and inspect containers, images, networks, and volumes, and watch events) with environment values redacted from inspect output. Set only for kind docker.
	Docker *AgentSpaceDocker `json:"docker,omitempty"`

	// HostRootEquivalent True when this space grants access that is effectively host root, which is `docker: full`.
	HostRootEquivalent bool           `json:"hostRootEquivalent"`
	Kind               AgentSpaceKind `json:"kind"`

	// Name What a client names to pick this agent space: `control` or `docker:<profile>`.
	Name string `json:"name"`

	// Network The network the space gives its worker. Set only for kind docker.
	Network *AgentSpaceNetwork `json:"network,omitempty"`

	// Profile The Docker profile behind the space. Set only for kind docker.
	Profile  *string `json:"profile,omitempty"`
	Revision int64   `json:"revision"`

	// Sudo True when the agent may run commands as root inside the worker container. Set only for kind docker.
	Sudo *bool `json:"sudo,omitempty"`
}

AgentSpace defines model for AgentSpace.

type AgentSpaceDocker added in v0.19.0

type AgentSpaceDocker string

AgentSpaceDocker How much of the host Docker daemon the space reaches. `full` mounts the controller's Docker socket, which is host root. `readonly` gives the worker a controller-run proxy that answers only read requests (list and inspect containers, images, networks, and volumes, and watch events) with environment values redacted from inspect output. Set only for kind docker.

const (
	AgentSpaceDockerFull     AgentSpaceDocker = "full"
	AgentSpaceDockerNone     AgentSpaceDocker = "none"
	AgentSpaceDockerReadonly AgentSpaceDocker = "readonly"
)

Defines values for AgentSpaceDocker.

func (AgentSpaceDocker) Valid added in v0.19.0

func (e AgentSpaceDocker) Valid() bool

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

type AgentSpaceKind added in v0.19.0

type AgentSpaceKind string

AgentSpaceKind defines model for AgentSpace.Kind.

const (
	AgentSpaceKindControl AgentSpaceKind = "control"
	AgentSpaceKindDocker  AgentSpaceKind = "docker"
)

Defines values for AgentSpaceKind.

func (AgentSpaceKind) Valid added in v0.19.0

func (e AgentSpaceKind) Valid() bool

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

type AgentSpaceList added in v0.19.0

type AgentSpaceList struct {
	// Default The agent space a session opened without naming one uses.
	Default string       `json:"default"`
	Items   []AgentSpace `json:"items"`
}

AgentSpaceList defines model for AgentSpaceList.

type AgentSpaceNetwork added in v0.19.0

type AgentSpaceNetwork string

AgentSpaceNetwork The network the space gives its worker. Set only for kind docker.

const (
	AgentSpaceNetworkBridge AgentSpaceNetwork = "bridge"
	AgentSpaceNetworkHost   AgentSpaceNetwork = "host"
	AgentSpaceNetworkNone   AgentSpaceNetwork = "none"
)

Defines values for AgentSpaceNetwork.

func (AgentSpaceNetwork) Valid added in v0.19.0

func (e AgentSpaceNetwork) Valid() bool

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

type CancelResponse

type CancelResponse struct {
	CancelRequested bool `json:"cancelRequested"`
}

CancelResponse defines model for CancelResponse.

type CancelSessionAgentRunParams

type CancelSessionAgentRunParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

CancelSessionAgentRunParams defines parameters for CancelSessionAgentRun.

type CancelSessionAgentRunResponse

type CancelSessionAgentRunResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *AgentRunCancelResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers202 the parsed response headers for an HTTP 202 response
	Headers202 *CancelSessionAgentRunResponse202Headers
}

func ParseCancelSessionAgentRunResponse

func ParseCancelSessionAgentRunResponse(rsp *http.Response) (*CancelSessionAgentRunResponse, error)

ParseCancelSessionAgentRunResponse parses an HTTP response from a CancelSessionAgentRunWithResponse call

func (CancelSessionAgentRunResponse) ContentType

func (r CancelSessionAgentRunResponse) ContentType() string

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

func (CancelSessionAgentRunResponse) GetBody

func (r CancelSessionAgentRunResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CancelSessionAgentRunResponse) GetJSON202

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

func (CancelSessionAgentRunResponse) GetJSON400

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

func (CancelSessionAgentRunResponse) GetJSON401

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

func (CancelSessionAgentRunResponse) GetJSON404

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

func (CancelSessionAgentRunResponse) GetJSON500

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CancelSessionAgentRunResponse) Status

Status returns HTTPResponse.Status

func (CancelSessionAgentRunResponse) StatusCode

func (r CancelSessionAgentRunResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CancelSessionAgentRunResponse202Headers

type CancelSessionAgentRunResponse202Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

CancelSessionAgentRunResponse202Headers the declared response headers of an HTTP 202 response for CancelSessionAgentRun

type CancelSessionParams

type CancelSessionParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

CancelSessionParams defines parameters for CancelSession.

type CancelSessionResponse

type CancelSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *CancelResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers202 the parsed response headers for an HTTP 202 response
	Headers202 *CancelSessionResponse202Headers
}

func ParseCancelSessionResponse

func ParseCancelSessionResponse(rsp *http.Response) (*CancelSessionResponse, error)

ParseCancelSessionResponse parses an HTTP response from a CancelSessionWithResponse call

func (CancelSessionResponse) ContentType

func (r CancelSessionResponse) ContentType() string

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

func (CancelSessionResponse) GetBody

func (r CancelSessionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CancelSessionResponse) GetJSON202

func (r CancelSessionResponse) GetJSON202() *CancelResponse

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

func (CancelSessionResponse) GetJSON400

func (r CancelSessionResponse) GetJSON400() *ErrorBadRequest

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

func (CancelSessionResponse) GetJSON401

func (r CancelSessionResponse) GetJSON401() *ErrorUnauthorized

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

func (CancelSessionResponse) GetJSON404

func (r CancelSessionResponse) GetJSON404() *ErrorNotFound

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

func (CancelSessionResponse) GetJSON500

func (r CancelSessionResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CancelSessionResponse) Status

func (r CancelSessionResponse) Status() string

Status returns HTTPResponse.Status

func (CancelSessionResponse) StatusCode

func (r CancelSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CancelSessionResponse202Headers

type CancelSessionResponse202Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

CancelSessionResponse202Headers the declared response headers of an HTTP 202 response for CancelSession

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) CancelSession

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

CancelSession Request cancellation for the active turn

Corresponds with POST /session/cancel (the `CancelSession` operationId).

func (*Client) CancelSessionAgentRun

func (c *Client) CancelSessionAgentRun(ctx context.Context, agentRunId AgentRunID, params *CancelSessionAgentRunParams, reqEditors ...RequestEditorFn) (*http.Response, error)

CancelSessionAgentRun Cancel one child agent run without ending its parent turn

Corresponds with POST /session/agents/{agentRunId}/cancel (the `CancelSessionAgentRun` operationId).

func (*Client) DeleteSessionLearnedFile added in v0.37.0

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

DeleteSessionLearnedFile Delete one learned rule or skill

Removes a learned rule's file, or a learned skill's whole directory. The next turn, child launch, or changeDirectory call no longer loads it. Only files under a learned directory can be deleted this way.

Corresponds with DELETE /session/learned/file (the `DeleteSessionLearnedFile` operationId).

func (*Client) GetSession

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

GetSession Read session details

Corresponds with GET /session (the `GetSession` operationId).

func (*Client) GetSessionAgentRun added in v0.4.0

func (c *Client) GetSessionAgentRun(ctx context.Context, agentRunId AgentRunID, params *GetSessionAgentRunParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetSessionAgentRun Read one durable child agent run

Corresponds with GET /session/agents/{agentRunId} (the `GetSessionAgentRun` operationId).

func (*Client) GetSessionAgentRunCompaction added in v0.11.0

func (c *Client) GetSessionAgentRunCompaction(ctx context.Context, agentRunId AgentRunID, compactionId CompactionID, params *GetSessionAgentRunCompactionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetSessionAgentRunCompaction Read one immutable child compaction record

Corresponds with GET /session/agents/{agentRunId}/compactions/{compactionId} (the `GetSessionAgentRunCompaction` operationId).

func (*Client) GetSessionCompaction added in v0.4.0

func (c *Client) GetSessionCompaction(ctx context.Context, compactionId CompactionID, params *GetSessionCompactionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetSessionCompaction Read one durable compaction record

Corresponds with GET /session/compactions/{compactionId} (the `GetSessionCompaction` operationId).

func (*Client) GetSessionContextSnapshot added in v0.4.0

func (c *Client) GetSessionContextSnapshot(ctx context.Context, contextHash ContextHash, params *GetSessionContextSnapshotParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetSessionContextSnapshot Read a context snapshot referenced by this session

Corresponds with GET /session/context-snapshots/{contextHash} (the `GetSessionContextSnapshot` operationId).

func (*Client) GetSessionLearnedFile added in v0.37.0

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

GetSessionLearnedFile Read one learned rule or skill

Returns a learned rule's file, or a learned skill's SKILL.md, as the agent saved it.

Corresponds with GET /session/learned/file (the `GetSessionLearnedFile` operationId).

func (*Client) GetSessionMCPStatus added in v0.38.0

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

GetSessionMCPStatus Report the session's MCP servers

Returns the MCP servers the session's worker last reported: which started, the tools each offers, and why one failed. The worker reports at the start of every turn, so the answer is what the most recent turn saw, and reportedAt says when that was. A session that has not run a turn with MCP configured has no report yet and answers an empty server list with a null reportedAt.

Corresponds with GET /session/mcp (the `GetSessionMCPStatus` operationId).

func (*Client) GetSessionPromptSnapshot added in v0.4.0

func (c *Client) GetSessionPromptSnapshot(ctx context.Context, promptHash PromptHash, params *GetSessionPromptSnapshotParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetSessionPromptSnapshot Read a prompt snapshot referenced by this session

Corresponds with GET /session/prompt-snapshots/{promptHash} (the `GetSessionPromptSnapshot` operationId).

func (*Client) ListAgentSpaces added in v0.19.0

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

ListAgentSpaces List the agent spaces a client may name

Lists the agent spaces a session may run in: `control`, where the agent runs where Peen runs, which is listed only when the controller cannot reach a Docker daemon, and one `docker:<profile>` space for each Docker profile, including the built-in `default`. A client names an agent space when it opens a workspace and never sends an image, mount, network setting, or capability. Each Docker space reports its grants (`docker`, `network`, `sudo`), and a space that grants host root or other risky access carries capability warnings.

Corresponds with GET /agent-spaces (the `ListAgentSpaces` operationId).

func (*Client) ListMessages

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

ListMessages List stored conversation messages

Corresponds with GET /messages (the `ListMessages` operationId).

func (*Client) ListModels added in v0.12.0

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

ListModels List models discovered from configured connections

Lists the non-secret model metadata Peen confirmed at controller startup. A model's name is the exact connection/model reference a WebSocket message.send frame may use for its one-turn model override.

Corresponds with GET /models (the `ListModels` operationId).

func (*Client) ListSessionAgentRunCompactions added in v0.11.0

func (c *Client) ListSessionAgentRunCompactions(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunCompactionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListSessionAgentRunCompactions List one child agent run's compaction lineage

Corresponds with GET /session/agents/{agentRunId}/compactions (the `ListSessionAgentRunCompactions` operationId).

func (*Client) ListSessionAgentRunEvents

func (c *Client) ListSessionAgentRunEvents(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListSessionAgentRunEvents Follow what one child agent run is doing

Corresponds with GET /session/agents/{agentRunId}/events (the `ListSessionAgentRunEvents` operationId).

func (*Client) ListSessionAgentRunMessages added in v0.11.0

func (c *Client) ListSessionAgentRunMessages(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunMessagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListSessionAgentRunMessages List one child agent run's own durable transcript

A child agent runs a separate model context, so its transcript is stored apart from the session transcript and is never absorbed by a parent-session compaction.

Corresponds with GET /session/agents/{agentRunId}/messages (the `ListSessionAgentRunMessages` operationId).

func (*Client) ListSessionAgentRuns

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

ListSessionAgentRuns List the child agent runs this session has started

Corresponds with GET /session/agents (the `ListSessionAgentRuns` operationId).

func (*Client) ListSessionAgentSpaceDecisions added in v0.19.0

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

ListSessionAgentSpaceDecisions List one session's agent space decision history

Returns the durable record of every agent space change made to one session, newest first. Each entry names the agent space the session moved from, the agent space it moved to, and the reason the caller gave.

Corresponds with GET /session/agent-space-decisions (the `ListSessionAgentSpaceDecisions` operationId).

func (*Client) ListSessionCompactions added in v0.4.0

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

ListSessionCompactions List durable compaction records

Corresponds with GET /session/compactions (the `ListSessionCompactions` operationId).

func (*Client) ListSessionEvents

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

ListSessionEvents List durable protocol events

Corresponds with GET /session/events (the `ListSessionEvents` operationId).

func (*Client) ListSessionFeed added in v0.26.0

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

ListSessionFeed Replay a session's live feed from a sequence

Returns the session's sequenced live frames after `cursor`, oldest first: root protocol events, child agent run steps, and notices. Each item has the same type, data and sequence its live WebSocket frame carried, so a client that reconnects passes the last sequence it applied and continues without a gap or a duplicate. A cursor at or past the head returns an empty page.

Corresponds with GET /session/feed (the `ListSessionFeed` operationId).

func (*Client) ListSessionJobSignalRequests added in v0.4.0

func (c *Client) ListSessionJobSignalRequests(ctx context.Context, jobId JobID, params *ListSessionJobSignalRequestsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListSessionJobSignalRequests List the durable signal-request history for one job

Corresponds with GET /session/jobs/{jobId}/signals (the `ListSessionJobSignalRequests` operationId).

func (*Client) ListSessionJobs

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

ListSessionJobs List the commands this session has started

Corresponds with GET /session/jobs (the `ListSessionJobs` operationId).

func (*Client) ListSessionLearnedFiles added in v0.37.0

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

ListSessionLearnedFiles List the learned rules and skills this session loads

Lists every rule under .agents/learned/rules and every skill under .agents/learned/skills in the session's workspace and in the global learned directory, so a user can review what an auto-evolving agent saved. Each rule says whether it loads on every turn and its estimated token count. Symbolic links are left out. The list is bounded by the harness file limits, so it has no pages.

Corresponds with GET /session/learned (the `ListSessionLearnedFiles` operationId).

func (*Client) ListSessionModelRunCalls added in v0.4.0

func (c *Client) ListSessionModelRunCalls(ctx context.Context, modelRunId ModelRunID, params *ListSessionModelRunCallsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListSessionModelRunCalls Read every provider round for one model invocation

Corresponds with GET /session/model-runs/{modelRunId}/calls (the `ListSessionModelRunCalls` operationId).

func (*Client) ListSessionModelRuns added in v0.4.0

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

ListSessionModelRuns List complete durable model invocations

Corresponds with GET /session/model-runs (the `ListSessionModelRuns` operationId).

func (*Client) ListSessionNotices added in v0.4.0

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

ListSessionNotices List durable outside and worker notices

Corresponds with GET /session/notices (the `ListSessionNotices` operationId).

func (*Client) ListSessionTurns added in v0.4.0

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

ListSessionTurns List durable turns

Corresponds with GET /session/turns (the `ListSessionTurns` operationId).

func (*Client) ListSessionWorkers added in v0.8.0

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

ListSessionWorkers List one session's worker generations

Returns the durable worker generations for one session, newest first. A generation records the worker process that ran a set of turns, the agent space revision it started under, and for a Docker generation its container and repository image digest when one is available.

Corresponds with GET /session/workers (the `ListSessionWorkers` operationId).

func (*Client) ListSessions added in v0.8.0

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

ListSessions List durable workspace sessions

Lists every session this control surface holds. It takes no session header because it is how a client discovers which sessions exist.

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

func (*Client) ListWorkspaceRoots added in v0.13.0

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

ListWorkspaceRoots List workspace roots this controller may open

Lists the operator-configured workspace roots available to this authenticated control surface. A client selects one of these roots when it opens its first session instead of guessing a host path. This is the deliberate, authenticated disclosure of the controller's workspace boundary; rejected workspace opens still disclose no roots.

Corresponds with GET /workspace-roots (the `ListWorkspaceRoots` operationId).

func (*Client) OpenSession added in v0.8.0

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

OpenSession Open or resume the session for a workspace

Resolves a workspace path to its one durable session, creating that session the first time the directory is opened. This is the only operation that creates a session, so a control surface starts with none and a client must name the workspace it wants. Opening the same directory again, by any of its names, resumes the existing session. A path outside every configured workspace root is refused with 403 WORKSPACE_NOT_ALLOWED, and so is a workspace that is, contains, or sits inside the controller's state directory, or is or contains its configuration directory, and an agent space the deployment does not offer is refused with 403 AGENT_SPACE_NOT_ALLOWED. Neither creates a session. A path beneath a configured root whose directory does not exist returns 404 WORKSPACE_NOT_FOUND.

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

Corresponds with POST /sessions/open (the `OpenSession` operationId).

func (*Client) OpenSessionWithBody added in v0.8.0

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

OpenSessionWithBody Open or resume the session for a workspace

Resolves a workspace path to its one durable session, creating that session the first time the directory is opened. This is the only operation that creates a session, so a control surface starts with none and a client must name the workspace it wants. Opening the same directory again, by any of its names, resumes the existing session. A path outside every configured workspace root is refused with 403 WORKSPACE_NOT_ALLOWED, and so is a workspace that is, contains, or sits inside the controller's state directory, or is or contains its configuration directory, and an agent space the deployment does not offer is refused with 403 AGENT_SPACE_NOT_ALLOWED. Neither creates a session. A path beneath a configured root whose directory does not exist returns 404 WORKSPACE_NOT_FOUND.

Takes any type of body and a specified content type.

Corresponds with POST /sessions/open (the `OpenSession` operationId).

func (*Client) OpenSystemSession added in v0.45.0

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

OpenSystemSession Open or resume the system session

Returns the deployment's one system session, creating it the first time, and starts no turn. Send it messages over the WebSocket with `system` set. While `PEEN_SYSTEM_AGENT` is off this answers 403 SYSTEM_AGENT_OFF and creates nothing.

Corresponds with POST /sessions/system (the `OpenSystemSession` operationId).

func (*Client) PublishSessionNotice added in v0.4.0

func (c *Client) PublishSessionNotice(ctx context.Context, params *PublishSessionNoticeParams, body PublishSessionNoticeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PublishSessionNotice Report a durable notice to the session

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

Corresponds with POST /session/notices (the `PublishSessionNotice` operationId).

func (*Client) PublishSessionNoticeWithBody added in v0.4.0

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

PublishSessionNoticeWithBody Report a durable notice to the session

Takes any type of body and a specified content type.

Corresponds with POST /session/notices (the `PublishSessionNotice` operationId).

func (*Client) ReadSessionJobOutput

func (c *Client) ReadSessionJobOutput(ctx context.Context, jobId JobID, params *ReadSessionJobOutputParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ReadSessionJobOutput Read a bounded window of one job's output

Corresponds with GET /session/jobs/{jobId}/output (the `ReadSessionJobOutput` operationId).

func (*Client) ReconfigureSession added in v0.8.0

func (c *Client) ReconfigureSession(ctx context.Context, params *ReconfigureSessionParams, body ReconfigureSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ReconfigureSession Move an idle session to a different agent space

Changes the agent space a session's tools run in and records the decision with the caller's reason. The named agent space must be one the deployment offers; an undefined name is refused with 403. A session with a turn in flight is refused with 409, because changing the environment under running work would attribute that turn's tool calls to an agent space that did not run them. On success the session's current worker is stopped, so the next turn starts a new generation in the new agent space. The client names only an agent space and never sends an image, mount, network setting, or capability.

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

Corresponds with POST /session/reconfigure (the `ReconfigureSession` operationId).

func (*Client) ReconfigureSessionWithBody added in v0.8.0

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

ReconfigureSessionWithBody Move an idle session to a different agent space

Changes the agent space a session's tools run in and records the decision with the caller's reason. The named agent space must be one the deployment offers; an undefined name is refused with 403. A session with a turn in flight is refused with 409, because changing the environment under running work would attribute that turn's tool calls to an agent space that did not run them. On success the session's current worker is stopped, so the next turn starts a new generation in the new agent space. The client names only an agent space and never sends an image, mount, network setting, or capability.

Takes any type of body and a specified content type.

Corresponds with POST /session/reconfigure (the `ReconfigureSession` operationId).

func (*Client) SignalSessionJob

func (c *Client) SignalSessionJob(ctx context.Context, jobId JobID, params *SignalSessionJobParams, body SignalSessionJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SignalSessionJob Stop one running job

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

Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).

func (*Client) SignalSessionJobWithBody

func (c *Client) SignalSessionJobWithBody(ctx context.Context, jobId JobID, params *SignalSessionJobParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SignalSessionJobWithBody Stop one running job

Takes any type of body and a specified content type.

Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).

type ClientInterface

type ClientInterface interface {

	// ListAgentSpaces List the agent spaces a client may name
	//
	// Lists the agent spaces a session may run in: `control`, where the agent runs where Peen runs, which is listed only when the controller cannot reach a Docker daemon, and one `docker:<profile>` space for each Docker profile, including the built-in `default`. A client names an agent space when it opens a workspace and never sends an image, mount, network setting, or capability. Each Docker space reports its grants (`docker`, `network`, `sudo`), and a space that grants host root or other risky access carries capability warnings.
	//
	// Corresponds with GET /agent-spaces (the `ListAgentSpaces` operationId).
	ListAgentSpaces(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListMessages List stored conversation messages
	//
	// Corresponds with GET /messages (the `ListMessages` operationId).
	ListMessages(ctx context.Context, params *ListMessagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListModels List models discovered from configured connections
	//
	// Lists the non-secret model metadata Peen confirmed at controller startup. A model's name is the exact connection/model reference a WebSocket message.send frame may use for its one-turn model override.
	//
	// Corresponds with GET /models (the `ListModels` operationId).
	ListModels(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSession Read session details
	//
	// Corresponds with GET /session (the `GetSession` operationId).
	GetSession(ctx context.Context, params *GetSessionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionAgentSpaceDecisions List one session's agent space decision history
	//
	// Returns the durable record of every agent space change made to one session, newest first. Each entry names the agent space the session moved from, the agent space it moved to, and the reason the caller gave.
	//
	// Corresponds with GET /session/agent-space-decisions (the `ListSessionAgentSpaceDecisions` operationId).
	ListSessionAgentSpaceDecisions(ctx context.Context, params *ListSessionAgentSpaceDecisionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionAgentRuns List the child agent runs this session has started
	//
	// Corresponds with GET /session/agents (the `ListSessionAgentRuns` operationId).
	ListSessionAgentRuns(ctx context.Context, params *ListSessionAgentRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSessionAgentRun Read one durable child agent run
	//
	// Corresponds with GET /session/agents/{agentRunId} (the `GetSessionAgentRun` operationId).
	GetSessionAgentRun(ctx context.Context, agentRunId AgentRunID, params *GetSessionAgentRunParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CancelSessionAgentRun Cancel one child agent run without ending its parent turn
	//
	// Corresponds with POST /session/agents/{agentRunId}/cancel (the `CancelSessionAgentRun` operationId).
	CancelSessionAgentRun(ctx context.Context, agentRunId AgentRunID, params *CancelSessionAgentRunParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionAgentRunCompactions List one child agent run's compaction lineage
	//
	// Corresponds with GET /session/agents/{agentRunId}/compactions (the `ListSessionAgentRunCompactions` operationId).
	ListSessionAgentRunCompactions(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunCompactionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSessionAgentRunCompaction Read one immutable child compaction record
	//
	// Corresponds with GET /session/agents/{agentRunId}/compactions/{compactionId} (the `GetSessionAgentRunCompaction` operationId).
	GetSessionAgentRunCompaction(ctx context.Context, agentRunId AgentRunID, compactionId CompactionID, params *GetSessionAgentRunCompactionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionAgentRunEvents Follow what one child agent run is doing
	//
	// Corresponds with GET /session/agents/{agentRunId}/events (the `ListSessionAgentRunEvents` operationId).
	ListSessionAgentRunEvents(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionAgentRunMessages List one child agent run's own durable transcript
	//
	// A child agent runs a separate model context, so its transcript is stored apart from the session transcript and is never absorbed by a parent-session compaction.
	//
	// Corresponds with GET /session/agents/{agentRunId}/messages (the `ListSessionAgentRunMessages` operationId).
	ListSessionAgentRunMessages(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunMessagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CancelSession Request cancellation for the active turn
	//
	// Corresponds with POST /session/cancel (the `CancelSession` operationId).
	CancelSession(ctx context.Context, params *CancelSessionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionCompactions List durable compaction records
	//
	// Corresponds with GET /session/compactions (the `ListSessionCompactions` operationId).
	ListSessionCompactions(ctx context.Context, params *ListSessionCompactionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSessionCompaction Read one durable compaction record
	//
	// Corresponds with GET /session/compactions/{compactionId} (the `GetSessionCompaction` operationId).
	GetSessionCompaction(ctx context.Context, compactionId CompactionID, params *GetSessionCompactionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSessionContextSnapshot Read a context snapshot referenced by this session
	//
	// Corresponds with GET /session/context-snapshots/{contextHash} (the `GetSessionContextSnapshot` operationId).
	GetSessionContextSnapshot(ctx context.Context, contextHash ContextHash, params *GetSessionContextSnapshotParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionEvents List durable protocol events
	//
	// Corresponds with GET /session/events (the `ListSessionEvents` operationId).
	ListSessionEvents(ctx context.Context, params *ListSessionEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionFeed Replay a session's live feed from a sequence
	//
	// Returns the session's sequenced live frames after `cursor`, oldest first: root protocol events, child agent run steps, and notices. Each item has the same type, data and sequence its live WebSocket frame carried, so a client that reconnects passes the last sequence it applied and continues without a gap or a duplicate. A cursor at or past the head returns an empty page.
	//
	// Corresponds with GET /session/feed (the `ListSessionFeed` operationId).
	ListSessionFeed(ctx context.Context, params *ListSessionFeedParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionJobs List the commands this session has started
	//
	// Corresponds with GET /session/jobs (the `ListSessionJobs` operationId).
	ListSessionJobs(ctx context.Context, params *ListSessionJobsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReadSessionJobOutput Read a bounded window of one job's output
	//
	// Corresponds with GET /session/jobs/{jobId}/output (the `ReadSessionJobOutput` operationId).
	ReadSessionJobOutput(ctx context.Context, jobId JobID, params *ReadSessionJobOutputParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SignalSessionJobWithBody Stop one running job
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).
	SignalSessionJobWithBody(ctx context.Context, jobId JobID, params *SignalSessionJobParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SignalSessionJob Stop one running job
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).
	SignalSessionJob(ctx context.Context, jobId JobID, params *SignalSessionJobParams, body SignalSessionJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionJobSignalRequests List the durable signal-request history for one job
	//
	// Corresponds with GET /session/jobs/{jobId}/signals (the `ListSessionJobSignalRequests` operationId).
	ListSessionJobSignalRequests(ctx context.Context, jobId JobID, params *ListSessionJobSignalRequestsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionLearnedFiles List the learned rules and skills this session loads
	//
	// Lists every rule under .agents/learned/rules and every skill under .agents/learned/skills in the session's workspace and in the global learned directory, so a user can review what an auto-evolving agent saved. Each rule says whether it loads on every turn and its estimated token count. Symbolic links are left out. The list is bounded by the harness file limits, so it has no pages.
	//
	// Corresponds with GET /session/learned (the `ListSessionLearnedFiles` operationId).
	ListSessionLearnedFiles(ctx context.Context, params *ListSessionLearnedFilesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteSessionLearnedFile Delete one learned rule or skill
	//
	// Removes a learned rule's file, or a learned skill's whole directory. The next turn, child launch, or changeDirectory call no longer loads it. Only files under a learned directory can be deleted this way.
	//
	// Corresponds with DELETE /session/learned/file (the `DeleteSessionLearnedFile` operationId).
	DeleteSessionLearnedFile(ctx context.Context, params *DeleteSessionLearnedFileParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSessionLearnedFile Read one learned rule or skill
	//
	// Returns a learned rule's file, or a learned skill's SKILL.md, as the agent saved it.
	//
	// Corresponds with GET /session/learned/file (the `GetSessionLearnedFile` operationId).
	GetSessionLearnedFile(ctx context.Context, params *GetSessionLearnedFileParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSessionMCPStatus Report the session's MCP servers
	//
	// Returns the MCP servers the session's worker last reported: which started, the tools each offers, and why one failed. The worker reports at the start of every turn, so the answer is what the most recent turn saw, and reportedAt says when that was. A session that has not run a turn with MCP configured has no report yet and answers an empty server list with a null reportedAt.
	//
	// Corresponds with GET /session/mcp (the `GetSessionMCPStatus` operationId).
	GetSessionMCPStatus(ctx context.Context, params *GetSessionMCPStatusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionModelRuns List complete durable model invocations
	//
	// Corresponds with GET /session/model-runs (the `ListSessionModelRuns` operationId).
	ListSessionModelRuns(ctx context.Context, params *ListSessionModelRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionModelRunCalls Read every provider round for one model invocation
	//
	// Corresponds with GET /session/model-runs/{modelRunId}/calls (the `ListSessionModelRunCalls` operationId).
	ListSessionModelRunCalls(ctx context.Context, modelRunId ModelRunID, params *ListSessionModelRunCallsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionNotices List durable outside and worker notices
	//
	// Corresponds with GET /session/notices (the `ListSessionNotices` operationId).
	ListSessionNotices(ctx context.Context, params *ListSessionNoticesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PublishSessionNoticeWithBody Report a durable notice to the session
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /session/notices (the `PublishSessionNotice` operationId).
	PublishSessionNoticeWithBody(ctx context.Context, params *PublishSessionNoticeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PublishSessionNotice Report a durable notice to the session
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /session/notices (the `PublishSessionNotice` operationId).
	PublishSessionNotice(ctx context.Context, params *PublishSessionNoticeParams, body PublishSessionNoticeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSessionPromptSnapshot Read a prompt snapshot referenced by this session
	//
	// Corresponds with GET /session/prompt-snapshots/{promptHash} (the `GetSessionPromptSnapshot` operationId).
	GetSessionPromptSnapshot(ctx context.Context, promptHash PromptHash, params *GetSessionPromptSnapshotParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReconfigureSessionWithBody Move an idle session to a different agent space
	//
	// Changes the agent space a session's tools run in and records the decision with the caller's reason. The named agent space must be one the deployment offers; an undefined name is refused with 403. A session with a turn in flight is refused with 409, because changing the environment under running work would attribute that turn's tool calls to an agent space that did not run them. On success the session's current worker is stopped, so the next turn starts a new generation in the new agent space. The client names only an agent space and never sends an image, mount, network setting, or capability.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /session/reconfigure (the `ReconfigureSession` operationId).
	ReconfigureSessionWithBody(ctx context.Context, params *ReconfigureSessionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReconfigureSession Move an idle session to a different agent space
	//
	// Changes the agent space a session's tools run in and records the decision with the caller's reason. The named agent space must be one the deployment offers; an undefined name is refused with 403. A session with a turn in flight is refused with 409, because changing the environment under running work would attribute that turn's tool calls to an agent space that did not run them. On success the session's current worker is stopped, so the next turn starts a new generation in the new agent space. The client names only an agent space and never sends an image, mount, network setting, or capability.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /session/reconfigure (the `ReconfigureSession` operationId).
	ReconfigureSession(ctx context.Context, params *ReconfigureSessionParams, body ReconfigureSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionTurns List durable turns
	//
	// Corresponds with GET /session/turns (the `ListSessionTurns` operationId).
	ListSessionTurns(ctx context.Context, params *ListSessionTurnsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionWorkers List one session's worker generations
	//
	// Returns the durable worker generations for one session, newest first. A generation records the worker process that ran a set of turns, the agent space revision it started under, and for a Docker generation its container and repository image digest when one is available.
	//
	// Corresponds with GET /session/workers (the `ListSessionWorkers` operationId).
	ListSessionWorkers(ctx context.Context, params *ListSessionWorkersParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessions List durable workspace sessions
	//
	// Lists every session this control surface holds. It takes no session header because it is how a client discovers which sessions exist.
	//
	// Corresponds with GET /sessions (the `ListSessions` operationId).
	ListSessions(ctx context.Context, params *ListSessionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// OpenSessionWithBody Open or resume the session for a workspace
	//
	// Resolves a workspace path to its one durable session, creating that session the first time the directory is opened. This is the only operation that creates a session, so a control surface starts with none and a client must name the workspace it wants. Opening the same directory again, by any of its names, resumes the existing session. A path outside every configured workspace root is refused with 403 WORKSPACE_NOT_ALLOWED, and so is a workspace that is, contains, or sits inside the controller's state directory, or is or contains its configuration directory, and an agent space the deployment does not offer is refused with 403 AGENT_SPACE_NOT_ALLOWED. Neither creates a session. A path beneath a configured root whose directory does not exist returns 404 WORKSPACE_NOT_FOUND.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /sessions/open (the `OpenSession` operationId).
	OpenSessionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// OpenSession Open or resume the session for a workspace
	//
	// Resolves a workspace path to its one durable session, creating that session the first time the directory is opened. This is the only operation that creates a session, so a control surface starts with none and a client must name the workspace it wants. Opening the same directory again, by any of its names, resumes the existing session. A path outside every configured workspace root is refused with 403 WORKSPACE_NOT_ALLOWED, and so is a workspace that is, contains, or sits inside the controller's state directory, or is or contains its configuration directory, and an agent space the deployment does not offer is refused with 403 AGENT_SPACE_NOT_ALLOWED. Neither creates a session. A path beneath a configured root whose directory does not exist returns 404 WORKSPACE_NOT_FOUND.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /sessions/open (the `OpenSession` operationId).
	OpenSession(ctx context.Context, body OpenSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// OpenSystemSession Open or resume the system session
	//
	// Returns the deployment's one system session, creating it the first time, and starts no turn. Send it messages over the WebSocket with `system` set. While `PEEN_SYSTEM_AGENT` is off this answers 403 SYSTEM_AGENT_OFF and creates nothing.
	//
	// Corresponds with POST /sessions/system (the `OpenSystemSession` operationId).
	OpenSystemSession(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListWorkspaceRoots List workspace roots this controller may open
	//
	// Lists the operator-configured workspace roots available to this authenticated control surface. A client selects one of these roots when it opens its first session instead of guessing a host path. This is the deliberate, authenticated disclosure of the controller's workspace boundary; rejected workspace opens still disclose no roots.
	//
	// Corresponds with GET /workspace-roots (the `ListWorkspaceRoots` operationId).
	ListWorkspaceRoots(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) CancelSessionAgentRunWithResponse

func (c *ClientWithResponses) CancelSessionAgentRunWithResponse(ctx context.Context, agentRunId AgentRunID, params *CancelSessionAgentRunParams, reqEditors ...RequestEditorFn) (*CancelSessionAgentRunResponse, error)

CancelSessionAgentRunWithResponse Cancel one child agent run without ending its parent turn

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

Corresponds with POST /session/agents/{agentRunId}/cancel (the `CancelSessionAgentRun` operationId).

func (*ClientWithResponses) CancelSessionWithResponse

func (c *ClientWithResponses) CancelSessionWithResponse(ctx context.Context, params *CancelSessionParams, reqEditors ...RequestEditorFn) (*CancelSessionResponse, error)

CancelSessionWithResponse Request cancellation for the active turn

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

Corresponds with POST /session/cancel (the `CancelSession` operationId).

func (*ClientWithResponses) DeleteSessionLearnedFileWithResponse added in v0.37.0

func (c *ClientWithResponses) DeleteSessionLearnedFileWithResponse(ctx context.Context, params *DeleteSessionLearnedFileParams, reqEditors ...RequestEditorFn) (*DeleteSessionLearnedFileResponse, error)

DeleteSessionLearnedFileWithResponse Delete one learned rule or skill

Removes a learned rule's file, or a learned skill's whole directory. The next turn, child launch, or changeDirectory call no longer loads it. Only files under a learned directory can be deleted this way.

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

Corresponds with DELETE /session/learned/file (the `DeleteSessionLearnedFile` operationId).

func (*ClientWithResponses) GetSessionAgentRunCompactionWithResponse added in v0.11.0

func (c *ClientWithResponses) GetSessionAgentRunCompactionWithResponse(ctx context.Context, agentRunId AgentRunID, compactionId CompactionID, params *GetSessionAgentRunCompactionParams, reqEditors ...RequestEditorFn) (*GetSessionAgentRunCompactionResponse, error)

GetSessionAgentRunCompactionWithResponse Read one immutable child compaction record

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

Corresponds with GET /session/agents/{agentRunId}/compactions/{compactionId} (the `GetSessionAgentRunCompaction` operationId).

func (*ClientWithResponses) GetSessionAgentRunWithResponse added in v0.4.0

func (c *ClientWithResponses) GetSessionAgentRunWithResponse(ctx context.Context, agentRunId AgentRunID, params *GetSessionAgentRunParams, reqEditors ...RequestEditorFn) (*GetSessionAgentRunResponse, error)

GetSessionAgentRunWithResponse Read one durable child agent run

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

Corresponds with GET /session/agents/{agentRunId} (the `GetSessionAgentRun` operationId).

func (*ClientWithResponses) GetSessionCompactionWithResponse added in v0.4.0

func (c *ClientWithResponses) GetSessionCompactionWithResponse(ctx context.Context, compactionId CompactionID, params *GetSessionCompactionParams, reqEditors ...RequestEditorFn) (*GetSessionCompactionResponse, error)

GetSessionCompactionWithResponse Read one durable compaction record

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

Corresponds with GET /session/compactions/{compactionId} (the `GetSessionCompaction` operationId).

func (*ClientWithResponses) GetSessionContextSnapshotWithResponse added in v0.4.0

func (c *ClientWithResponses) GetSessionContextSnapshotWithResponse(ctx context.Context, contextHash ContextHash, params *GetSessionContextSnapshotParams, reqEditors ...RequestEditorFn) (*GetSessionContextSnapshotResponse, error)

GetSessionContextSnapshotWithResponse Read a context snapshot referenced by this session

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

Corresponds with GET /session/context-snapshots/{contextHash} (the `GetSessionContextSnapshot` operationId).

func (*ClientWithResponses) GetSessionLearnedFileWithResponse added in v0.37.0

func (c *ClientWithResponses) GetSessionLearnedFileWithResponse(ctx context.Context, params *GetSessionLearnedFileParams, reqEditors ...RequestEditorFn) (*GetSessionLearnedFileResponse, error)

GetSessionLearnedFileWithResponse Read one learned rule or skill

Returns a learned rule's file, or a learned skill's SKILL.md, as the agent saved it.

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

Corresponds with GET /session/learned/file (the `GetSessionLearnedFile` operationId).

func (*ClientWithResponses) GetSessionMCPStatusWithResponse added in v0.38.0

func (c *ClientWithResponses) GetSessionMCPStatusWithResponse(ctx context.Context, params *GetSessionMCPStatusParams, reqEditors ...RequestEditorFn) (*GetSessionMCPStatusResponse, error)

GetSessionMCPStatusWithResponse Report the session's MCP servers

Returns the MCP servers the session's worker last reported: which started, the tools each offers, and why one failed. The worker reports at the start of every turn, so the answer is what the most recent turn saw, and reportedAt says when that was. A session that has not run a turn with MCP configured has no report yet and answers an empty server list with a null reportedAt.

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

Corresponds with GET /session/mcp (the `GetSessionMCPStatus` operationId).

func (*ClientWithResponses) GetSessionPromptSnapshotWithResponse added in v0.4.0

func (c *ClientWithResponses) GetSessionPromptSnapshotWithResponse(ctx context.Context, promptHash PromptHash, params *GetSessionPromptSnapshotParams, reqEditors ...RequestEditorFn) (*GetSessionPromptSnapshotResponse, error)

GetSessionPromptSnapshotWithResponse Read a prompt snapshot referenced by this session

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

Corresponds with GET /session/prompt-snapshots/{promptHash} (the `GetSessionPromptSnapshot` operationId).

func (*ClientWithResponses) GetSessionWithResponse

func (c *ClientWithResponses) GetSessionWithResponse(ctx context.Context, params *GetSessionParams, reqEditors ...RequestEditorFn) (*GetSessionResponse, error)

GetSessionWithResponse Read session details

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

Corresponds with GET /session (the `GetSession` operationId).

func (*ClientWithResponses) ListAgentSpacesWithResponse added in v0.19.0

func (c *ClientWithResponses) ListAgentSpacesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListAgentSpacesResponse, error)

ListAgentSpacesWithResponse List the agent spaces a client may name

Lists the agent spaces a session may run in: `control`, where the agent runs where Peen runs, which is listed only when the controller cannot reach a Docker daemon, and one `docker:<profile>` space for each Docker profile, including the built-in `default`. A client names an agent space when it opens a workspace and never sends an image, mount, network setting, or capability. Each Docker space reports its grants (`docker`, `network`, `sudo`), and a space that grants host root or other risky access carries capability warnings.

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

Corresponds with GET /agent-spaces (the `ListAgentSpaces` operationId).

func (*ClientWithResponses) ListMessagesWithResponse

func (c *ClientWithResponses) ListMessagesWithResponse(ctx context.Context, params *ListMessagesParams, reqEditors ...RequestEditorFn) (*ListMessagesResponse, error)

ListMessagesWithResponse List stored conversation messages

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

Corresponds with GET /messages (the `ListMessages` operationId).

func (*ClientWithResponses) ListModelsWithResponse added in v0.12.0

func (c *ClientWithResponses) ListModelsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListModelsResponse, error)

ListModelsWithResponse List models discovered from configured connections

Lists the non-secret model metadata Peen confirmed at controller startup. A model's name is the exact connection/model reference a WebSocket message.send frame may use for its one-turn model override.

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

Corresponds with GET /models (the `ListModels` operationId).

func (*ClientWithResponses) ListSessionAgentRunCompactionsWithResponse added in v0.11.0

func (c *ClientWithResponses) ListSessionAgentRunCompactionsWithResponse(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunCompactionsParams, reqEditors ...RequestEditorFn) (*ListSessionAgentRunCompactionsResponse, error)

ListSessionAgentRunCompactionsWithResponse List one child agent run's compaction lineage

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

Corresponds with GET /session/agents/{agentRunId}/compactions (the `ListSessionAgentRunCompactions` operationId).

func (*ClientWithResponses) ListSessionAgentRunEventsWithResponse

func (c *ClientWithResponses) ListSessionAgentRunEventsWithResponse(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunEventsParams, reqEditors ...RequestEditorFn) (*ListSessionAgentRunEventsResponse, error)

ListSessionAgentRunEventsWithResponse Follow what one child agent run is doing

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

Corresponds with GET /session/agents/{agentRunId}/events (the `ListSessionAgentRunEvents` operationId).

func (*ClientWithResponses) ListSessionAgentRunMessagesWithResponse added in v0.11.0

func (c *ClientWithResponses) ListSessionAgentRunMessagesWithResponse(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunMessagesParams, reqEditors ...RequestEditorFn) (*ListSessionAgentRunMessagesResponse, error)

ListSessionAgentRunMessagesWithResponse List one child agent run's own durable transcript

A child agent runs a separate model context, so its transcript is stored apart from the session transcript and is never absorbed by a parent-session compaction.

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

Corresponds with GET /session/agents/{agentRunId}/messages (the `ListSessionAgentRunMessages` operationId).

func (*ClientWithResponses) ListSessionAgentRunsWithResponse

func (c *ClientWithResponses) ListSessionAgentRunsWithResponse(ctx context.Context, params *ListSessionAgentRunsParams, reqEditors ...RequestEditorFn) (*ListSessionAgentRunsResponse, error)

ListSessionAgentRunsWithResponse List the child agent runs this session has started

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

Corresponds with GET /session/agents (the `ListSessionAgentRuns` operationId).

func (*ClientWithResponses) ListSessionAgentSpaceDecisionsWithResponse added in v0.19.0

func (c *ClientWithResponses) ListSessionAgentSpaceDecisionsWithResponse(ctx context.Context, params *ListSessionAgentSpaceDecisionsParams, reqEditors ...RequestEditorFn) (*ListSessionAgentSpaceDecisionsResponse, error)

ListSessionAgentSpaceDecisionsWithResponse List one session's agent space decision history

Returns the durable record of every agent space change made to one session, newest first. Each entry names the agent space the session moved from, the agent space it moved to, and the reason the caller gave.

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

Corresponds with GET /session/agent-space-decisions (the `ListSessionAgentSpaceDecisions` operationId).

func (*ClientWithResponses) ListSessionCompactionsWithResponse added in v0.4.0

func (c *ClientWithResponses) ListSessionCompactionsWithResponse(ctx context.Context, params *ListSessionCompactionsParams, reqEditors ...RequestEditorFn) (*ListSessionCompactionsResponse, error)

ListSessionCompactionsWithResponse List durable compaction records

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

Corresponds with GET /session/compactions (the `ListSessionCompactions` operationId).

func (*ClientWithResponses) ListSessionEventsWithResponse

func (c *ClientWithResponses) ListSessionEventsWithResponse(ctx context.Context, params *ListSessionEventsParams, reqEditors ...RequestEditorFn) (*ListSessionEventsResponse, error)

ListSessionEventsWithResponse List durable protocol events

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

Corresponds with GET /session/events (the `ListSessionEvents` operationId).

func (*ClientWithResponses) ListSessionFeedWithResponse added in v0.26.0

func (c *ClientWithResponses) ListSessionFeedWithResponse(ctx context.Context, params *ListSessionFeedParams, reqEditors ...RequestEditorFn) (*ListSessionFeedResponse, error)

ListSessionFeedWithResponse Replay a session's live feed from a sequence

Returns the session's sequenced live frames after `cursor`, oldest first: root protocol events, child agent run steps, and notices. Each item has the same type, data and sequence its live WebSocket frame carried, so a client that reconnects passes the last sequence it applied and continues without a gap or a duplicate. A cursor at or past the head returns an empty page.

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

Corresponds with GET /session/feed (the `ListSessionFeed` operationId).

func (*ClientWithResponses) ListSessionJobSignalRequestsWithResponse added in v0.4.0

func (c *ClientWithResponses) ListSessionJobSignalRequestsWithResponse(ctx context.Context, jobId JobID, params *ListSessionJobSignalRequestsParams, reqEditors ...RequestEditorFn) (*ListSessionJobSignalRequestsResponse, error)

ListSessionJobSignalRequestsWithResponse List the durable signal-request history for one job

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

Corresponds with GET /session/jobs/{jobId}/signals (the `ListSessionJobSignalRequests` operationId).

func (*ClientWithResponses) ListSessionJobsWithResponse

func (c *ClientWithResponses) ListSessionJobsWithResponse(ctx context.Context, params *ListSessionJobsParams, reqEditors ...RequestEditorFn) (*ListSessionJobsResponse, error)

ListSessionJobsWithResponse List the commands this session has started

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

Corresponds with GET /session/jobs (the `ListSessionJobs` operationId).

func (*ClientWithResponses) ListSessionLearnedFilesWithResponse added in v0.37.0

func (c *ClientWithResponses) ListSessionLearnedFilesWithResponse(ctx context.Context, params *ListSessionLearnedFilesParams, reqEditors ...RequestEditorFn) (*ListSessionLearnedFilesResponse, error)

ListSessionLearnedFilesWithResponse List the learned rules and skills this session loads

Lists every rule under .agents/learned/rules and every skill under .agents/learned/skills in the session's workspace and in the global learned directory, so a user can review what an auto-evolving agent saved. Each rule says whether it loads on every turn and its estimated token count. Symbolic links are left out. The list is bounded by the harness file limits, so it has no pages.

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

Corresponds with GET /session/learned (the `ListSessionLearnedFiles` operationId).

func (*ClientWithResponses) ListSessionModelRunCallsWithResponse added in v0.4.0

func (c *ClientWithResponses) ListSessionModelRunCallsWithResponse(ctx context.Context, modelRunId ModelRunID, params *ListSessionModelRunCallsParams, reqEditors ...RequestEditorFn) (*ListSessionModelRunCallsResponse, error)

ListSessionModelRunCallsWithResponse Read every provider round for one model invocation

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

Corresponds with GET /session/model-runs/{modelRunId}/calls (the `ListSessionModelRunCalls` operationId).

func (*ClientWithResponses) ListSessionModelRunsWithResponse added in v0.4.0

func (c *ClientWithResponses) ListSessionModelRunsWithResponse(ctx context.Context, params *ListSessionModelRunsParams, reqEditors ...RequestEditorFn) (*ListSessionModelRunsResponse, error)

ListSessionModelRunsWithResponse List complete durable model invocations

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

Corresponds with GET /session/model-runs (the `ListSessionModelRuns` operationId).

func (*ClientWithResponses) ListSessionNoticesWithResponse added in v0.4.0

func (c *ClientWithResponses) ListSessionNoticesWithResponse(ctx context.Context, params *ListSessionNoticesParams, reqEditors ...RequestEditorFn) (*ListSessionNoticesResponse, error)

ListSessionNoticesWithResponse List durable outside and worker notices

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

Corresponds with GET /session/notices (the `ListSessionNotices` operationId).

func (*ClientWithResponses) ListSessionTurnsWithResponse added in v0.4.0

func (c *ClientWithResponses) ListSessionTurnsWithResponse(ctx context.Context, params *ListSessionTurnsParams, reqEditors ...RequestEditorFn) (*ListSessionTurnsResponse, error)

ListSessionTurnsWithResponse List durable turns

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

Corresponds with GET /session/turns (the `ListSessionTurns` operationId).

func (*ClientWithResponses) ListSessionWorkersWithResponse added in v0.8.0

func (c *ClientWithResponses) ListSessionWorkersWithResponse(ctx context.Context, params *ListSessionWorkersParams, reqEditors ...RequestEditorFn) (*ListSessionWorkersResponse, error)

ListSessionWorkersWithResponse List one session's worker generations

Returns the durable worker generations for one session, newest first. A generation records the worker process that ran a set of turns, the agent space revision it started under, and for a Docker generation its container and repository image digest when one is available.

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

Corresponds with GET /session/workers (the `ListSessionWorkers` operationId).

func (*ClientWithResponses) ListSessionsWithResponse added in v0.8.0

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

ListSessionsWithResponse List durable workspace sessions

Lists every session this control surface holds. It takes no session header because it is how a client discovers which sessions exist.

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

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

func (*ClientWithResponses) ListWorkspaceRootsWithResponse added in v0.13.0

func (c *ClientWithResponses) ListWorkspaceRootsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListWorkspaceRootsResponse, error)

ListWorkspaceRootsWithResponse List workspace roots this controller may open

Lists the operator-configured workspace roots available to this authenticated control surface. A client selects one of these roots when it opens its first session instead of guessing a host path. This is the deliberate, authenticated disclosure of the controller's workspace boundary; rejected workspace opens still disclose no roots.

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

Corresponds with GET /workspace-roots (the `ListWorkspaceRoots` operationId).

func (*ClientWithResponses) OpenSessionWithBodyWithResponse added in v0.8.0

func (c *ClientWithResponses) OpenSessionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*OpenSessionResponse, error)

OpenSessionWithBodyWithResponse Open or resume the session for a workspace

Resolves a workspace path to its one durable session, creating that session the first time the directory is opened. This is the only operation that creates a session, so a control surface starts with none and a client must name the workspace it wants. Opening the same directory again, by any of its names, resumes the existing session. A path outside every configured workspace root is refused with 403 WORKSPACE_NOT_ALLOWED, and so is a workspace that is, contains, or sits inside the controller's state directory, or is or contains its configuration directory, and an agent space the deployment does not offer is refused with 403 AGENT_SPACE_NOT_ALLOWED. Neither creates a session. A path beneath a configured root whose directory does not exist returns 404 WORKSPACE_NOT_FOUND.

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 /sessions/open (the `OpenSession` operationId).

func (*ClientWithResponses) OpenSessionWithResponse added in v0.8.0

func (c *ClientWithResponses) OpenSessionWithResponse(ctx context.Context, body OpenSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*OpenSessionResponse, error)

OpenSessionWithResponse Open or resume the session for a workspace

Resolves a workspace path to its one durable session, creating that session the first time the directory is opened. This is the only operation that creates a session, so a control surface starts with none and a client must name the workspace it wants. Opening the same directory again, by any of its names, resumes the existing session. A path outside every configured workspace root is refused with 403 WORKSPACE_NOT_ALLOWED, and so is a workspace that is, contains, or sits inside the controller's state directory, or is or contains its configuration directory, and an agent space the deployment does not offer is refused with 403 AGENT_SPACE_NOT_ALLOWED. Neither creates a session. A path beneath a configured root whose directory does not exist returns 404 WORKSPACE_NOT_FOUND.

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

Corresponds with POST /sessions/open (the `OpenSession` operationId).

func (*ClientWithResponses) OpenSystemSessionWithResponse added in v0.45.0

func (c *ClientWithResponses) OpenSystemSessionWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*OpenSystemSessionResponse, error)

OpenSystemSessionWithResponse Open or resume the system session

Returns the deployment's one system session, creating it the first time, and starts no turn. Send it messages over the WebSocket with `system` set. While `PEEN_SYSTEM_AGENT` is off this answers 403 SYSTEM_AGENT_OFF and creates nothing.

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

Corresponds with POST /sessions/system (the `OpenSystemSession` operationId).

func (*ClientWithResponses) PublishSessionNoticeWithBodyWithResponse added in v0.4.0

func (c *ClientWithResponses) PublishSessionNoticeWithBodyWithResponse(ctx context.Context, params *PublishSessionNoticeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PublishSessionNoticeResponse, error)

PublishSessionNoticeWithBodyWithResponse Report a durable notice to the 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 /session/notices (the `PublishSessionNotice` operationId).

func (*ClientWithResponses) PublishSessionNoticeWithResponse added in v0.4.0

PublishSessionNoticeWithResponse Report a durable notice to the 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 /session/notices (the `PublishSessionNotice` operationId).

func (*ClientWithResponses) ReadSessionJobOutputWithResponse

func (c *ClientWithResponses) ReadSessionJobOutputWithResponse(ctx context.Context, jobId JobID, params *ReadSessionJobOutputParams, reqEditors ...RequestEditorFn) (*ReadSessionJobOutputResponse, error)

ReadSessionJobOutputWithResponse Read a bounded window of one job's output

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

Corresponds with GET /session/jobs/{jobId}/output (the `ReadSessionJobOutput` operationId).

func (*ClientWithResponses) ReconfigureSessionWithBodyWithResponse added in v0.8.0

func (c *ClientWithResponses) ReconfigureSessionWithBodyWithResponse(ctx context.Context, params *ReconfigureSessionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReconfigureSessionResponse, error)

ReconfigureSessionWithBodyWithResponse Move an idle session to a different agent space

Changes the agent space a session's tools run in and records the decision with the caller's reason. The named agent space must be one the deployment offers; an undefined name is refused with 403. A session with a turn in flight is refused with 409, because changing the environment under running work would attribute that turn's tool calls to an agent space that did not run them. On success the session's current worker is stopped, so the next turn starts a new generation in the new agent space. The client names only an agent space and never sends an image, mount, network setting, or capability.

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 /session/reconfigure (the `ReconfigureSession` operationId).

func (*ClientWithResponses) ReconfigureSessionWithResponse added in v0.8.0

ReconfigureSessionWithResponse Move an idle session to a different agent space

Changes the agent space a session's tools run in and records the decision with the caller's reason. The named agent space must be one the deployment offers; an undefined name is refused with 403. A session with a turn in flight is refused with 409, because changing the environment under running work would attribute that turn's tool calls to an agent space that did not run them. On success the session's current worker is stopped, so the next turn starts a new generation in the new agent space. The client names only an agent space and never sends an image, mount, network setting, or capability.

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

Corresponds with POST /session/reconfigure (the `ReconfigureSession` operationId).

func (*ClientWithResponses) SignalSessionJobWithBodyWithResponse

func (c *ClientWithResponses) SignalSessionJobWithBodyWithResponse(ctx context.Context, jobId JobID, params *SignalSessionJobParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SignalSessionJobResponse, error)

SignalSessionJobWithBodyWithResponse Stop one running job

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 /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).

func (*ClientWithResponses) SignalSessionJobWithResponse

func (c *ClientWithResponses) SignalSessionJobWithResponse(ctx context.Context, jobId JobID, params *SignalSessionJobParams, body SignalSessionJobJSONRequestBody, reqEditors ...RequestEditorFn) (*SignalSessionJobResponse, error)

SignalSessionJobWithResponse Stop one running job

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

Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// ListAgentSpacesWithResponse List the agent spaces a client may name
	//
	// Lists the agent spaces a session may run in: `control`, where the agent runs where Peen runs, which is listed only when the controller cannot reach a Docker daemon, and one `docker:<profile>` space for each Docker profile, including the built-in `default`. A client names an agent space when it opens a workspace and never sends an image, mount, network setting, or capability. Each Docker space reports its grants (`docker`, `network`, `sudo`), and a space that grants host root or other risky access carries capability warnings.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /agent-spaces (the `ListAgentSpaces` operationId).
	ListAgentSpacesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListAgentSpacesResponse, error)

	// ListMessagesWithResponse List stored conversation messages
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /messages (the `ListMessages` operationId).
	ListMessagesWithResponse(ctx context.Context, params *ListMessagesParams, reqEditors ...RequestEditorFn) (*ListMessagesResponse, error)

	// ListModelsWithResponse List models discovered from configured connections
	//
	// Lists the non-secret model metadata Peen confirmed at controller startup. A model's name is the exact connection/model reference a WebSocket message.send frame may use for its one-turn model override.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /models (the `ListModels` operationId).
	ListModelsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListModelsResponse, error)

	// GetSessionWithResponse Read session details
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session (the `GetSession` operationId).
	GetSessionWithResponse(ctx context.Context, params *GetSessionParams, reqEditors ...RequestEditorFn) (*GetSessionResponse, error)

	// ListSessionAgentSpaceDecisionsWithResponse List one session's agent space decision history
	//
	// Returns the durable record of every agent space change made to one session, newest first. Each entry names the agent space the session moved from, the agent space it moved to, and the reason the caller gave.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/agent-space-decisions (the `ListSessionAgentSpaceDecisions` operationId).
	ListSessionAgentSpaceDecisionsWithResponse(ctx context.Context, params *ListSessionAgentSpaceDecisionsParams, reqEditors ...RequestEditorFn) (*ListSessionAgentSpaceDecisionsResponse, error)

	// ListSessionAgentRunsWithResponse List the child agent runs this session has started
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/agents (the `ListSessionAgentRuns` operationId).
	ListSessionAgentRunsWithResponse(ctx context.Context, params *ListSessionAgentRunsParams, reqEditors ...RequestEditorFn) (*ListSessionAgentRunsResponse, error)

	// GetSessionAgentRunWithResponse Read one durable child agent run
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/agents/{agentRunId} (the `GetSessionAgentRun` operationId).
	GetSessionAgentRunWithResponse(ctx context.Context, agentRunId AgentRunID, params *GetSessionAgentRunParams, reqEditors ...RequestEditorFn) (*GetSessionAgentRunResponse, error)

	// CancelSessionAgentRunWithResponse Cancel one child agent run without ending its parent turn
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /session/agents/{agentRunId}/cancel (the `CancelSessionAgentRun` operationId).
	CancelSessionAgentRunWithResponse(ctx context.Context, agentRunId AgentRunID, params *CancelSessionAgentRunParams, reqEditors ...RequestEditorFn) (*CancelSessionAgentRunResponse, error)

	// ListSessionAgentRunCompactionsWithResponse List one child agent run's compaction lineage
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/agents/{agentRunId}/compactions (the `ListSessionAgentRunCompactions` operationId).
	ListSessionAgentRunCompactionsWithResponse(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunCompactionsParams, reqEditors ...RequestEditorFn) (*ListSessionAgentRunCompactionsResponse, error)

	// GetSessionAgentRunCompactionWithResponse Read one immutable child compaction record
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/agents/{agentRunId}/compactions/{compactionId} (the `GetSessionAgentRunCompaction` operationId).
	GetSessionAgentRunCompactionWithResponse(ctx context.Context, agentRunId AgentRunID, compactionId CompactionID, params *GetSessionAgentRunCompactionParams, reqEditors ...RequestEditorFn) (*GetSessionAgentRunCompactionResponse, error)

	// ListSessionAgentRunEventsWithResponse Follow what one child agent run is doing
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/agents/{agentRunId}/events (the `ListSessionAgentRunEvents` operationId).
	ListSessionAgentRunEventsWithResponse(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunEventsParams, reqEditors ...RequestEditorFn) (*ListSessionAgentRunEventsResponse, error)

	// ListSessionAgentRunMessagesWithResponse List one child agent run's own durable transcript
	//
	// A child agent runs a separate model context, so its transcript is stored apart from the session transcript and is never absorbed by a parent-session compaction.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/agents/{agentRunId}/messages (the `ListSessionAgentRunMessages` operationId).
	ListSessionAgentRunMessagesWithResponse(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunMessagesParams, reqEditors ...RequestEditorFn) (*ListSessionAgentRunMessagesResponse, error)

	// CancelSessionWithResponse Request cancellation for the active turn
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /session/cancel (the `CancelSession` operationId).
	CancelSessionWithResponse(ctx context.Context, params *CancelSessionParams, reqEditors ...RequestEditorFn) (*CancelSessionResponse, error)

	// ListSessionCompactionsWithResponse List durable compaction records
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/compactions (the `ListSessionCompactions` operationId).
	ListSessionCompactionsWithResponse(ctx context.Context, params *ListSessionCompactionsParams, reqEditors ...RequestEditorFn) (*ListSessionCompactionsResponse, error)

	// GetSessionCompactionWithResponse Read one durable compaction record
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/compactions/{compactionId} (the `GetSessionCompaction` operationId).
	GetSessionCompactionWithResponse(ctx context.Context, compactionId CompactionID, params *GetSessionCompactionParams, reqEditors ...RequestEditorFn) (*GetSessionCompactionResponse, error)

	// GetSessionContextSnapshotWithResponse Read a context snapshot referenced by this session
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/context-snapshots/{contextHash} (the `GetSessionContextSnapshot` operationId).
	GetSessionContextSnapshotWithResponse(ctx context.Context, contextHash ContextHash, params *GetSessionContextSnapshotParams, reqEditors ...RequestEditorFn) (*GetSessionContextSnapshotResponse, error)

	// ListSessionEventsWithResponse List durable protocol events
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/events (the `ListSessionEvents` operationId).
	ListSessionEventsWithResponse(ctx context.Context, params *ListSessionEventsParams, reqEditors ...RequestEditorFn) (*ListSessionEventsResponse, error)

	// ListSessionFeedWithResponse Replay a session's live feed from a sequence
	//
	// Returns the session's sequenced live frames after `cursor`, oldest first: root protocol events, child agent run steps, and notices. Each item has the same type, data and sequence its live WebSocket frame carried, so a client that reconnects passes the last sequence it applied and continues without a gap or a duplicate. A cursor at or past the head returns an empty page.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/feed (the `ListSessionFeed` operationId).
	ListSessionFeedWithResponse(ctx context.Context, params *ListSessionFeedParams, reqEditors ...RequestEditorFn) (*ListSessionFeedResponse, error)

	// ListSessionJobsWithResponse List the commands this session has started
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/jobs (the `ListSessionJobs` operationId).
	ListSessionJobsWithResponse(ctx context.Context, params *ListSessionJobsParams, reqEditors ...RequestEditorFn) (*ListSessionJobsResponse, error)

	// ReadSessionJobOutputWithResponse Read a bounded window of one job's output
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/jobs/{jobId}/output (the `ReadSessionJobOutput` operationId).
	ReadSessionJobOutputWithResponse(ctx context.Context, jobId JobID, params *ReadSessionJobOutputParams, reqEditors ...RequestEditorFn) (*ReadSessionJobOutputResponse, error)

	// SignalSessionJobWithBodyWithResponse Stop one running job
	//
	// 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 /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).
	SignalSessionJobWithBodyWithResponse(ctx context.Context, jobId JobID, params *SignalSessionJobParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SignalSessionJobResponse, error)

	// SignalSessionJobWithResponse Stop one running job
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).
	SignalSessionJobWithResponse(ctx context.Context, jobId JobID, params *SignalSessionJobParams, body SignalSessionJobJSONRequestBody, reqEditors ...RequestEditorFn) (*SignalSessionJobResponse, error)

	// ListSessionJobSignalRequestsWithResponse List the durable signal-request history for one job
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/jobs/{jobId}/signals (the `ListSessionJobSignalRequests` operationId).
	ListSessionJobSignalRequestsWithResponse(ctx context.Context, jobId JobID, params *ListSessionJobSignalRequestsParams, reqEditors ...RequestEditorFn) (*ListSessionJobSignalRequestsResponse, error)

	// ListSessionLearnedFilesWithResponse List the learned rules and skills this session loads
	//
	// Lists every rule under .agents/learned/rules and every skill under .agents/learned/skills in the session's workspace and in the global learned directory, so a user can review what an auto-evolving agent saved. Each rule says whether it loads on every turn and its estimated token count. Symbolic links are left out. The list is bounded by the harness file limits, so it has no pages.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/learned (the `ListSessionLearnedFiles` operationId).
	ListSessionLearnedFilesWithResponse(ctx context.Context, params *ListSessionLearnedFilesParams, reqEditors ...RequestEditorFn) (*ListSessionLearnedFilesResponse, error)

	// DeleteSessionLearnedFileWithResponse Delete one learned rule or skill
	//
	// Removes a learned rule's file, or a learned skill's whole directory. The next turn, child launch, or changeDirectory call no longer loads it. Only files under a learned directory can be deleted this way.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /session/learned/file (the `DeleteSessionLearnedFile` operationId).
	DeleteSessionLearnedFileWithResponse(ctx context.Context, params *DeleteSessionLearnedFileParams, reqEditors ...RequestEditorFn) (*DeleteSessionLearnedFileResponse, error)

	// GetSessionLearnedFileWithResponse Read one learned rule or skill
	//
	// Returns a learned rule's file, or a learned skill's SKILL.md, as the agent saved it.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/learned/file (the `GetSessionLearnedFile` operationId).
	GetSessionLearnedFileWithResponse(ctx context.Context, params *GetSessionLearnedFileParams, reqEditors ...RequestEditorFn) (*GetSessionLearnedFileResponse, error)

	// GetSessionMCPStatusWithResponse Report the session's MCP servers
	//
	// Returns the MCP servers the session's worker last reported: which started, the tools each offers, and why one failed. The worker reports at the start of every turn, so the answer is what the most recent turn saw, and reportedAt says when that was. A session that has not run a turn with MCP configured has no report yet and answers an empty server list with a null reportedAt.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/mcp (the `GetSessionMCPStatus` operationId).
	GetSessionMCPStatusWithResponse(ctx context.Context, params *GetSessionMCPStatusParams, reqEditors ...RequestEditorFn) (*GetSessionMCPStatusResponse, error)

	// ListSessionModelRunsWithResponse List complete durable model invocations
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/model-runs (the `ListSessionModelRuns` operationId).
	ListSessionModelRunsWithResponse(ctx context.Context, params *ListSessionModelRunsParams, reqEditors ...RequestEditorFn) (*ListSessionModelRunsResponse, error)

	// ListSessionModelRunCallsWithResponse Read every provider round for one model invocation
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/model-runs/{modelRunId}/calls (the `ListSessionModelRunCalls` operationId).
	ListSessionModelRunCallsWithResponse(ctx context.Context, modelRunId ModelRunID, params *ListSessionModelRunCallsParams, reqEditors ...RequestEditorFn) (*ListSessionModelRunCallsResponse, error)

	// ListSessionNoticesWithResponse List durable outside and worker notices
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/notices (the `ListSessionNotices` operationId).
	ListSessionNoticesWithResponse(ctx context.Context, params *ListSessionNoticesParams, reqEditors ...RequestEditorFn) (*ListSessionNoticesResponse, error)

	// PublishSessionNoticeWithBodyWithResponse Report a durable notice to the 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 /session/notices (the `PublishSessionNotice` operationId).
	PublishSessionNoticeWithBodyWithResponse(ctx context.Context, params *PublishSessionNoticeParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PublishSessionNoticeResponse, error)

	// PublishSessionNoticeWithResponse Report a durable notice to the 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 /session/notices (the `PublishSessionNotice` operationId).
	PublishSessionNoticeWithResponse(ctx context.Context, params *PublishSessionNoticeParams, body PublishSessionNoticeJSONRequestBody, reqEditors ...RequestEditorFn) (*PublishSessionNoticeResponse, error)

	// GetSessionPromptSnapshotWithResponse Read a prompt snapshot referenced by this session
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/prompt-snapshots/{promptHash} (the `GetSessionPromptSnapshot` operationId).
	GetSessionPromptSnapshotWithResponse(ctx context.Context, promptHash PromptHash, params *GetSessionPromptSnapshotParams, reqEditors ...RequestEditorFn) (*GetSessionPromptSnapshotResponse, error)

	// ReconfigureSessionWithBodyWithResponse Move an idle session to a different agent space
	//
	// Changes the agent space a session's tools run in and records the decision with the caller's reason. The named agent space must be one the deployment offers; an undefined name is refused with 403. A session with a turn in flight is refused with 409, because changing the environment under running work would attribute that turn's tool calls to an agent space that did not run them. On success the session's current worker is stopped, so the next turn starts a new generation in the new agent space. The client names only an agent space and never sends an image, mount, network setting, or capability.
	//
	// 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 /session/reconfigure (the `ReconfigureSession` operationId).
	ReconfigureSessionWithBodyWithResponse(ctx context.Context, params *ReconfigureSessionParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReconfigureSessionResponse, error)

	// ReconfigureSessionWithResponse Move an idle session to a different agent space
	//
	// Changes the agent space a session's tools run in and records the decision with the caller's reason. The named agent space must be one the deployment offers; an undefined name is refused with 403. A session with a turn in flight is refused with 409, because changing the environment under running work would attribute that turn's tool calls to an agent space that did not run them. On success the session's current worker is stopped, so the next turn starts a new generation in the new agent space. The client names only an agent space and never sends an image, mount, network setting, or capability.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /session/reconfigure (the `ReconfigureSession` operationId).
	ReconfigureSessionWithResponse(ctx context.Context, params *ReconfigureSessionParams, body ReconfigureSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*ReconfigureSessionResponse, error)

	// ListSessionTurnsWithResponse List durable turns
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/turns (the `ListSessionTurns` operationId).
	ListSessionTurnsWithResponse(ctx context.Context, params *ListSessionTurnsParams, reqEditors ...RequestEditorFn) (*ListSessionTurnsResponse, error)

	// ListSessionWorkersWithResponse List one session's worker generations
	//
	// Returns the durable worker generations for one session, newest first. A generation records the worker process that ran a set of turns, the agent space revision it started under, and for a Docker generation its container and repository image digest when one is available.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/workers (the `ListSessionWorkers` operationId).
	ListSessionWorkersWithResponse(ctx context.Context, params *ListSessionWorkersParams, reqEditors ...RequestEditorFn) (*ListSessionWorkersResponse, error)

	// ListSessionsWithResponse List durable workspace sessions
	//
	// Lists every session this control surface holds. It takes no session header because it is how a client discovers which sessions exist.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /sessions (the `ListSessions` operationId).
	ListSessionsWithResponse(ctx context.Context, params *ListSessionsParams, reqEditors ...RequestEditorFn) (*ListSessionsResponse, error)

	// OpenSessionWithBodyWithResponse Open or resume the session for a workspace
	//
	// Resolves a workspace path to its one durable session, creating that session the first time the directory is opened. This is the only operation that creates a session, so a control surface starts with none and a client must name the workspace it wants. Opening the same directory again, by any of its names, resumes the existing session. A path outside every configured workspace root is refused with 403 WORKSPACE_NOT_ALLOWED, and so is a workspace that is, contains, or sits inside the controller's state directory, or is or contains its configuration directory, and an agent space the deployment does not offer is refused with 403 AGENT_SPACE_NOT_ALLOWED. Neither creates a session. A path beneath a configured root whose directory does not exist returns 404 WORKSPACE_NOT_FOUND.
	//
	// 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 /sessions/open (the `OpenSession` operationId).
	OpenSessionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*OpenSessionResponse, error)

	// OpenSessionWithResponse Open or resume the session for a workspace
	//
	// Resolves a workspace path to its one durable session, creating that session the first time the directory is opened. This is the only operation that creates a session, so a control surface starts with none and a client must name the workspace it wants. Opening the same directory again, by any of its names, resumes the existing session. A path outside every configured workspace root is refused with 403 WORKSPACE_NOT_ALLOWED, and so is a workspace that is, contains, or sits inside the controller's state directory, or is or contains its configuration directory, and an agent space the deployment does not offer is refused with 403 AGENT_SPACE_NOT_ALLOWED. Neither creates a session. A path beneath a configured root whose directory does not exist returns 404 WORKSPACE_NOT_FOUND.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /sessions/open (the `OpenSession` operationId).
	OpenSessionWithResponse(ctx context.Context, body OpenSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*OpenSessionResponse, error)

	// OpenSystemSessionWithResponse Open or resume the system session
	//
	// Returns the deployment's one system session, creating it the first time, and starts no turn. Send it messages over the WebSocket with `system` set. While `PEEN_SYSTEM_AGENT` is off this answers 403 SYSTEM_AGENT_OFF and creates nothing.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /sessions/system (the `OpenSystemSession` operationId).
	OpenSystemSessionWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*OpenSystemSessionResponse, error)

	// ListWorkspaceRootsWithResponse List workspace roots this controller may open
	//
	// Lists the operator-configured workspace roots available to this authenticated control surface. A client selects one of these roots when it opens its first session instead of guessing a host path. This is the deliberate, authenticated disclosure of the controller's workspace boundary; rejected workspace opens still disclose no roots.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /workspace-roots (the `ListWorkspaceRoots` operationId).
	ListWorkspaceRootsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListWorkspaceRootsResponse, error)
}

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

type Compaction added in v0.4.0

type Compaction struct {
	CreatedAt          time.Time           `json:"createdAt"`
	FromMessageId      openapi_types.UUID  `json:"fromMessageId"`
	FromSequence       int64               `json:"fromSequence"`
	Id                 openapi_types.UUID  `json:"id"`
	InputTokenCount    int64               `json:"inputTokenCount"`
	Model              string              `json:"model"`
	ParentCompactionId *openapi_types.UUID `json:"parentCompactionId,omitempty"`
	PromptHash         string              `json:"promptHash"`
	SessionId          openapi_types.UUID  `json:"sessionId"`
	SourceMessageCount int64               `json:"sourceMessageCount"`
	Summary            string              `json:"summary"`
	SummaryTokenCount  int64               `json:"summaryTokenCount"`
	ToMessageId        openapi_types.UUID  `json:"toMessageId"`
	ToSequence         int64               `json:"toSequence"`
}

Compaction defines model for Compaction.

type CompactionID added in v0.4.0

type CompactionID = openapi_types.UUID

CompactionID defines model for CompactionID.

type CompactionPage added in v0.4.0

type CompactionPage struct {
	Compactions []Compaction `json:"compactions"`
	HasMore     bool         `json:"hasMore"`
	Limit       int32        `json:"limit"`
	Offset      int32        `json:"offset"`
}

CompactionPage defines model for CompactionPage.

type ContextHash added in v0.4.0

type ContextHash = string

ContextHash defines model for ContextHash.

type ContextManifestEntry added in v0.8.0

type ContextManifestEntry struct {
	Hash     string `json:"hash"`
	Kind     string `json:"kind"`
	Name     string `json:"name"`
	Priority int32  `json:"priority"`
	Source   string `json:"source"`
}

ContextManifestEntry defines model for ContextManifestEntry.

type ContextSnapshot added in v0.4.0

type ContextSnapshot struct {
	CreatedAt time.Time `json:"createdAt"`
	Hash      string    `json:"hash"`

	// Manifest The layered sources this context was assembled from, in resolution order. It is a list because the harness contributes one entry per file from the filesystem root down to the workspace, and the same name may appear at more than one layer.
	Manifest        []ContextManifestEntry `json:"manifest"`
	ResolvedContent string                 `json:"resolvedContent"`
}

ContextSnapshot defines model for ContextSnapshot.

type DeleteSessionLearnedFileParams added in v0.37.0

type DeleteSessionLearnedFileParams struct {
	Scope LearnedScope `form:"scope" json:"scope"`
	Kind  LearnedKind  `form:"kind" json:"kind"`

	// Name The rule's path under rules/ without .md, such as go-errors or go/errors, or the skill's directory name.
	Name       LearnedName       `form:"name" json:"name"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

DeleteSessionLearnedFileParams defines parameters for DeleteSessionLearnedFile.

type DeleteSessionLearnedFileResponse added in v0.37.0

type DeleteSessionLearnedFileResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers204 the parsed response headers for an HTTP 204 response
	Headers204 *DeleteSessionLearnedFileResponse204Headers
}

func ParseDeleteSessionLearnedFileResponse added in v0.37.0

func ParseDeleteSessionLearnedFileResponse(rsp *http.Response) (*DeleteSessionLearnedFileResponse, error)

ParseDeleteSessionLearnedFileResponse parses an HTTP response from a DeleteSessionLearnedFileWithResponse call

func (DeleteSessionLearnedFileResponse) ContentType added in v0.37.0

func (r DeleteSessionLearnedFileResponse) ContentType() string

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

func (DeleteSessionLearnedFileResponse) GetBody added in v0.37.0

func (r DeleteSessionLearnedFileResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteSessionLearnedFileResponse) GetJSON400 added in v0.37.0

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

func (DeleteSessionLearnedFileResponse) GetJSON401 added in v0.37.0

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

func (DeleteSessionLearnedFileResponse) GetJSON404 added in v0.37.0

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

func (DeleteSessionLearnedFileResponse) GetJSON500 added in v0.37.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeleteSessionLearnedFileResponse) Status added in v0.37.0

Status returns HTTPResponse.Status

func (DeleteSessionLearnedFileResponse) StatusCode added in v0.37.0

func (r DeleteSessionLearnedFileResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteSessionLearnedFileResponse204Headers added in v0.37.0

type DeleteSessionLearnedFileResponse204Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

DeleteSessionLearnedFileResponse204Headers the declared response headers of an HTTP 204 response for DeleteSessionLearnedFile

type Error

type Error struct {
	Code    string                  `json:"code"`
	Details *map[string]interface{} `json:"details,omitempty"`
	Message string                  `json:"message"`
}

Error defines model for Error.

type ErrorBadRequest

type ErrorBadRequest = Error

ErrorBadRequest defines model for ErrorBadRequest.

type ErrorConflict

type ErrorConflict = Error

ErrorConflict defines model for ErrorConflict.

type ErrorForbidden added in v0.8.0

type ErrorForbidden = Error

ErrorForbidden defines model for ErrorForbidden.

type ErrorInternal

type ErrorInternal = Error

ErrorInternal defines model for ErrorInternal.

type ErrorNotFound

type ErrorNotFound = Error

ErrorNotFound defines model for ErrorNotFound.

type ErrorUnauthorized

type ErrorUnauthorized = Error

ErrorUnauthorized defines model for ErrorUnauthorized.

type FeedFrame added in v0.26.0

type FeedFrame struct {
	CreatedAt time.Time `json:"createdAt"`

	// Data The frame's data, exactly as sent live.
	Data interface{} `json:"data"`

	// Id ID of the stored record, also the live frame's id.
	Id        openapi_types.UUID  `json:"id"`
	RequestId *openapi_types.UUID `json:"requestId"`

	// Sequence Position in the session feed. Consecutive, starting at 1.
	Sequence  int64              `json:"sequence"`
	SessionId openapi_types.UUID `json:"sessionId"`
	Type      string             `json:"type"`
}

FeedFrame One sequenced frame of a session's live feed, as it was sent over the WebSocket.

type FeedPage added in v0.26.0

type FeedPage struct {
	HasMore bool `json:"hasMore"`

	// Head The session's newest feed sequence when the page was read.
	Head  int64       `json:"head"`
	Items []FeedFrame `json:"items"`
	Limit int32       `json:"limit"`

	// NextCursor Pass back as cursor to continue from here.
	NextCursor int64 `json:"nextCursor"`
}

FeedPage defines model for FeedPage.

type GetSessionAgentRunCompactionParams added in v0.11.0

type GetSessionAgentRunCompactionParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

GetSessionAgentRunCompactionParams defines parameters for GetSessionAgentRunCompaction.

type GetSessionAgentRunCompactionResponse added in v0.11.0

type GetSessionAgentRunCompactionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AgentRunCompaction
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetSessionAgentRunCompactionResponse200Headers
}

func ParseGetSessionAgentRunCompactionResponse added in v0.11.0

func ParseGetSessionAgentRunCompactionResponse(rsp *http.Response) (*GetSessionAgentRunCompactionResponse, error)

ParseGetSessionAgentRunCompactionResponse parses an HTTP response from a GetSessionAgentRunCompactionWithResponse call

func (GetSessionAgentRunCompactionResponse) ContentType added in v0.11.0

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

func (GetSessionAgentRunCompactionResponse) GetBody added in v0.11.0

GetBody returns the raw response body bytes

func (GetSessionAgentRunCompactionResponse) GetJSON200 added in v0.11.0

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

func (GetSessionAgentRunCompactionResponse) GetJSON400 added in v0.11.0

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

func (GetSessionAgentRunCompactionResponse) GetJSON401 added in v0.11.0

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

func (GetSessionAgentRunCompactionResponse) GetJSON404 added in v0.11.0

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

func (GetSessionAgentRunCompactionResponse) GetJSON500 added in v0.11.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSessionAgentRunCompactionResponse) Status added in v0.11.0

Status returns HTTPResponse.Status

func (GetSessionAgentRunCompactionResponse) StatusCode added in v0.11.0

StatusCode returns HTTPResponse.StatusCode

type GetSessionAgentRunCompactionResponse200Headers added in v0.11.0

type GetSessionAgentRunCompactionResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

GetSessionAgentRunCompactionResponse200Headers the declared response headers of an HTTP 200 response for GetSessionAgentRunCompaction

type GetSessionAgentRunParams added in v0.4.0

type GetSessionAgentRunParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

GetSessionAgentRunParams defines parameters for GetSessionAgentRun.

type GetSessionAgentRunResponse added in v0.4.0

type GetSessionAgentRunResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AgentRun
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetSessionAgentRunResponse200Headers
}

func ParseGetSessionAgentRunResponse added in v0.4.0

func ParseGetSessionAgentRunResponse(rsp *http.Response) (*GetSessionAgentRunResponse, error)

ParseGetSessionAgentRunResponse parses an HTTP response from a GetSessionAgentRunWithResponse call

func (GetSessionAgentRunResponse) ContentType added in v0.4.0

func (r GetSessionAgentRunResponse) ContentType() string

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

func (GetSessionAgentRunResponse) GetBody added in v0.4.0

func (r GetSessionAgentRunResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSessionAgentRunResponse) GetJSON200 added in v0.4.0

func (r GetSessionAgentRunResponse) GetJSON200() *AgentRun

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

func (GetSessionAgentRunResponse) GetJSON400 added in v0.4.0

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

func (GetSessionAgentRunResponse) GetJSON401 added in v0.4.0

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

func (GetSessionAgentRunResponse) GetJSON404 added in v0.4.0

func (r GetSessionAgentRunResponse) GetJSON404() *ErrorNotFound

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

func (GetSessionAgentRunResponse) GetJSON500 added in v0.4.0

func (r GetSessionAgentRunResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSessionAgentRunResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (GetSessionAgentRunResponse) StatusCode added in v0.4.0

func (r GetSessionAgentRunResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSessionAgentRunResponse200Headers added in v0.4.0

type GetSessionAgentRunResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

GetSessionAgentRunResponse200Headers the declared response headers of an HTTP 200 response for GetSessionAgentRun

type GetSessionCompactionParams added in v0.4.0

type GetSessionCompactionParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

GetSessionCompactionParams defines parameters for GetSessionCompaction.

type GetSessionCompactionResponse added in v0.4.0

type GetSessionCompactionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Compaction
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetSessionCompactionResponse200Headers
}

func ParseGetSessionCompactionResponse added in v0.4.0

func ParseGetSessionCompactionResponse(rsp *http.Response) (*GetSessionCompactionResponse, error)

ParseGetSessionCompactionResponse parses an HTTP response from a GetSessionCompactionWithResponse call

func (GetSessionCompactionResponse) ContentType added in v0.4.0

func (r GetSessionCompactionResponse) ContentType() string

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

func (GetSessionCompactionResponse) GetBody added in v0.4.0

func (r GetSessionCompactionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSessionCompactionResponse) GetJSON200 added in v0.4.0

func (r GetSessionCompactionResponse) GetJSON200() *Compaction

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

func (GetSessionCompactionResponse) GetJSON400 added in v0.4.0

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

func (GetSessionCompactionResponse) GetJSON401 added in v0.4.0

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

func (GetSessionCompactionResponse) GetJSON404 added in v0.4.0

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

func (GetSessionCompactionResponse) GetJSON500 added in v0.4.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSessionCompactionResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (GetSessionCompactionResponse) StatusCode added in v0.4.0

func (r GetSessionCompactionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSessionCompactionResponse200Headers added in v0.4.0

type GetSessionCompactionResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

GetSessionCompactionResponse200Headers the declared response headers of an HTTP 200 response for GetSessionCompaction

type GetSessionContextSnapshotParams added in v0.4.0

type GetSessionContextSnapshotParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

GetSessionContextSnapshotParams defines parameters for GetSessionContextSnapshot.

type GetSessionContextSnapshotResponse added in v0.4.0

type GetSessionContextSnapshotResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ContextSnapshot
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetSessionContextSnapshotResponse200Headers
}

func ParseGetSessionContextSnapshotResponse added in v0.4.0

func ParseGetSessionContextSnapshotResponse(rsp *http.Response) (*GetSessionContextSnapshotResponse, error)

ParseGetSessionContextSnapshotResponse parses an HTTP response from a GetSessionContextSnapshotWithResponse call

func (GetSessionContextSnapshotResponse) ContentType added in v0.4.0

func (r GetSessionContextSnapshotResponse) ContentType() string

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

func (GetSessionContextSnapshotResponse) GetBody added in v0.4.0

GetBody returns the raw response body bytes

func (GetSessionContextSnapshotResponse) GetJSON200 added in v0.4.0

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

func (GetSessionContextSnapshotResponse) GetJSON400 added in v0.4.0

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

func (GetSessionContextSnapshotResponse) GetJSON401 added in v0.4.0

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

func (GetSessionContextSnapshotResponse) GetJSON404 added in v0.4.0

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

func (GetSessionContextSnapshotResponse) GetJSON500 added in v0.4.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSessionContextSnapshotResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (GetSessionContextSnapshotResponse) StatusCode added in v0.4.0

func (r GetSessionContextSnapshotResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSessionContextSnapshotResponse200Headers added in v0.4.0

type GetSessionContextSnapshotResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

GetSessionContextSnapshotResponse200Headers the declared response headers of an HTTP 200 response for GetSessionContextSnapshot

type GetSessionLearnedFileParams added in v0.37.0

type GetSessionLearnedFileParams struct {
	Scope LearnedScope `form:"scope" json:"scope"`
	Kind  LearnedKind  `form:"kind" json:"kind"`

	// Name The rule's path under rules/ without .md, such as go-errors or go/errors, or the skill's directory name.
	Name       LearnedName       `form:"name" json:"name"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

GetSessionLearnedFileParams defines parameters for GetSessionLearnedFile.

type GetSessionLearnedFileResponse added in v0.37.0

type GetSessionLearnedFileResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *LearnedFileContent
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetSessionLearnedFileResponse200Headers
}

func ParseGetSessionLearnedFileResponse added in v0.37.0

func ParseGetSessionLearnedFileResponse(rsp *http.Response) (*GetSessionLearnedFileResponse, error)

ParseGetSessionLearnedFileResponse parses an HTTP response from a GetSessionLearnedFileWithResponse call

func (GetSessionLearnedFileResponse) ContentType added in v0.37.0

func (r GetSessionLearnedFileResponse) ContentType() string

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

func (GetSessionLearnedFileResponse) GetBody added in v0.37.0

func (r GetSessionLearnedFileResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSessionLearnedFileResponse) GetJSON200 added in v0.37.0

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

func (GetSessionLearnedFileResponse) GetJSON400 added in v0.37.0

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

func (GetSessionLearnedFileResponse) GetJSON401 added in v0.37.0

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

func (GetSessionLearnedFileResponse) GetJSON404 added in v0.37.0

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

func (GetSessionLearnedFileResponse) GetJSON500 added in v0.37.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSessionLearnedFileResponse) Status added in v0.37.0

Status returns HTTPResponse.Status

func (GetSessionLearnedFileResponse) StatusCode added in v0.37.0

func (r GetSessionLearnedFileResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSessionLearnedFileResponse200Headers added in v0.37.0

type GetSessionLearnedFileResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

GetSessionLearnedFileResponse200Headers the declared response headers of an HTTP 200 response for GetSessionLearnedFile

type GetSessionMCPStatusParams added in v0.38.0

type GetSessionMCPStatusParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

GetSessionMCPStatusParams defines parameters for GetSessionMCPStatus.

type GetSessionMCPStatusResponse added in v0.38.0

type GetSessionMCPStatusResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *MCPStatusReport
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetSessionMCPStatusResponse200Headers
}

func ParseGetSessionMCPStatusResponse added in v0.38.0

func ParseGetSessionMCPStatusResponse(rsp *http.Response) (*GetSessionMCPStatusResponse, error)

ParseGetSessionMCPStatusResponse parses an HTTP response from a GetSessionMCPStatusWithResponse call

func (GetSessionMCPStatusResponse) ContentType added in v0.38.0

func (r GetSessionMCPStatusResponse) ContentType() string

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

func (GetSessionMCPStatusResponse) GetBody added in v0.38.0

func (r GetSessionMCPStatusResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSessionMCPStatusResponse) GetJSON200 added in v0.38.0

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

func (GetSessionMCPStatusResponse) GetJSON400 added in v0.38.0

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

func (GetSessionMCPStatusResponse) GetJSON401 added in v0.38.0

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

func (GetSessionMCPStatusResponse) GetJSON404 added in v0.38.0

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

func (GetSessionMCPStatusResponse) GetJSON500 added in v0.38.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSessionMCPStatusResponse) Status added in v0.38.0

Status returns HTTPResponse.Status

func (GetSessionMCPStatusResponse) StatusCode added in v0.38.0

func (r GetSessionMCPStatusResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSessionMCPStatusResponse200Headers added in v0.38.0

type GetSessionMCPStatusResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

GetSessionMCPStatusResponse200Headers the declared response headers of an HTTP 200 response for GetSessionMCPStatus

type GetSessionParams

type GetSessionParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

GetSessionParams defines parameters for GetSession.

type GetSessionPromptSnapshotParams added in v0.4.0

type GetSessionPromptSnapshotParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

GetSessionPromptSnapshotParams defines parameters for GetSessionPromptSnapshot.

type GetSessionPromptSnapshotResponse added in v0.4.0

type GetSessionPromptSnapshotResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PromptSnapshot
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetSessionPromptSnapshotResponse200Headers
}

func ParseGetSessionPromptSnapshotResponse added in v0.4.0

func ParseGetSessionPromptSnapshotResponse(rsp *http.Response) (*GetSessionPromptSnapshotResponse, error)

ParseGetSessionPromptSnapshotResponse parses an HTTP response from a GetSessionPromptSnapshotWithResponse call

func (GetSessionPromptSnapshotResponse) ContentType added in v0.4.0

func (r GetSessionPromptSnapshotResponse) ContentType() string

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

func (GetSessionPromptSnapshotResponse) GetBody added in v0.4.0

func (r GetSessionPromptSnapshotResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSessionPromptSnapshotResponse) GetJSON200 added in v0.4.0

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

func (GetSessionPromptSnapshotResponse) GetJSON400 added in v0.4.0

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

func (GetSessionPromptSnapshotResponse) GetJSON401 added in v0.4.0

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

func (GetSessionPromptSnapshotResponse) GetJSON404 added in v0.4.0

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

func (GetSessionPromptSnapshotResponse) GetJSON500 added in v0.4.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSessionPromptSnapshotResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (GetSessionPromptSnapshotResponse) StatusCode added in v0.4.0

func (r GetSessionPromptSnapshotResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSessionPromptSnapshotResponse200Headers added in v0.4.0

type GetSessionPromptSnapshotResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

GetSessionPromptSnapshotResponse200Headers the declared response headers of an HTTP 200 response for GetSessionPromptSnapshot

type GetSessionResponse

type GetSessionResponse 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 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetSessionResponse200Headers
}

func ParseGetSessionResponse

func ParseGetSessionResponse(rsp *http.Response) (*GetSessionResponse, error)

ParseGetSessionResponse parses an HTTP response from a GetSessionWithResponse call

func (GetSessionResponse) ContentType

func (r GetSessionResponse) ContentType() string

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

func (GetSessionResponse) GetBody

func (r GetSessionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSessionResponse) GetJSON200

func (r GetSessionResponse) GetJSON200() *Session

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

func (GetSessionResponse) GetJSON400

func (r GetSessionResponse) GetJSON400() *ErrorBadRequest

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

func (GetSessionResponse) GetJSON401

func (r GetSessionResponse) GetJSON401() *ErrorUnauthorized

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

func (GetSessionResponse) GetJSON404

func (r GetSessionResponse) GetJSON404() *ErrorNotFound

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

func (GetSessionResponse) GetJSON500

func (r GetSessionResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSessionResponse) Status

func (r GetSessionResponse) Status() string

Status returns HTTPResponse.Status

func (GetSessionResponse) StatusCode

func (r GetSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSessionResponse200Headers

type GetSessionResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

GetSessionResponse200Headers the declared response headers of an HTTP 200 response for GetSession

type HttpRequestDoer

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type Job

type Job struct {
	Command   string     `json:"command"`
	Directory string     `json:"directory"`
	EndedAt   *time.Time `json:"endedAt,omitempty"`

	// ExitCode Exit status once known, or -1 while it is not.
	ExitCode int64 `json:"exitCode"`

	// FailureDetail Empty unless Peen recorded a terminal failure detail.
	FailureDetail string             `json:"failureDetail"`
	JobId         openapi_types.UUID `json:"jobId"`

	// Pid Operating-system process ID of the job's shell.
	Pid int64 `json:"pid"`

	// Purpose Why the agent said it was running this command.
	Purpose   string             `json:"purpose"`
	SessionId openapi_types.UUID `json:"sessionId"`
	StartedAt time.Time          `json:"startedAt"`
	State     JobState           `json:"state"`

	// ToolCallId The tool call that started this job.
	ToolCallId *string `json:"toolCallId,omitempty"`

	// TurnId The durable turn that launched this process.
	TurnId openapi_types.UUID `json:"turnId"`

	// WorkerGenerationId Worker generation that launched this process.
	WorkerGenerationId *string `json:"workerGenerationId,omitempty"`
}

Job defines model for Job.

type JobID

type JobID = openapi_types.UUID

JobID defines model for JobID.

type JobOutput

type JobOutput struct {
	HasMore bool               `json:"hasMore"`
	JobId   openapi_types.UUID `json:"jobId"`

	// Lines Ordered immutable stdout and stderr records from SQLite.
	Lines []JobOutputLine `json:"lines"`

	// NextCursor Pass back as cursor to continue from this durable sequence.
	NextCursor int64          `json:"nextCursor"`
	State      JobOutputState `json:"state"`
}

JobOutput defines model for JobOutput.

type JobOutputLine added in v0.4.0

type JobOutputLine struct {
	Content   string              `json:"content"`
	CreatedAt time.Time           `json:"createdAt"`
	Id        openapi_types.UUID  `json:"id"`
	JobId     openapi_types.UUID  `json:"jobId"`
	Sequence  int64               `json:"sequence"`
	SessionId openapi_types.UUID  `json:"sessionId"`
	Stream    JobOutputLineStream `json:"stream"`
}

JobOutputLine defines model for JobOutputLine.

type JobOutputLineStream added in v0.4.0

type JobOutputLineStream string

JobOutputLineStream defines model for JobOutputLine.Stream.

const (
	JobOutputLineStreamStderr JobOutputLineStream = "stderr"
	JobOutputLineStreamStdout JobOutputLineStream = "stdout"
)

Defines values for JobOutputLineStream.

func (JobOutputLineStream) Valid added in v0.4.0

func (e JobOutputLineStream) Valid() bool

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

type JobOutputState

type JobOutputState string

JobOutputState defines model for JobOutput.State.

const (
	JobOutputStateExited      JobOutputState = "exited"
	JobOutputStateFailed      JobOutputState = "failed"
	JobOutputStateInterrupted JobOutputState = "interrupted"
	JobOutputStateRunning     JobOutputState = "running"
	JobOutputStateSignalled   JobOutputState = "signalled"
)

Defines values for JobOutputState.

func (JobOutputState) Valid

func (e JobOutputState) Valid() bool

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

type JobPage

type JobPage struct {
	HasMore bool  `json:"hasMore"`
	Jobs    []Job `json:"jobs"`
	Limit   int32 `json:"limit"`
	Offset  int32 `json:"offset"`
}

JobPage defines model for JobPage.

type JobSignalRecord added in v0.4.0

type JobSignalRecord struct {
	Accepted       bool                          `json:"accepted"`
	Id             openapi_types.UUID            `json:"id"`
	JobId          openapi_types.UUID            `json:"jobId"`
	RequestedAt    time.Time                     `json:"requestedAt"`
	SessionId      openapi_types.UUID            `json:"sessionId"`
	Signal         JobSignalRecordSignal         `json:"signal"`
	StateAtRequest JobSignalRecordStateAtRequest `json:"stateAtRequest"`
}

JobSignalRecord defines model for JobSignalRecord.

type JobSignalRecordPage added in v0.4.0

type JobSignalRecordPage struct {
	HasMore        bool              `json:"hasMore"`
	Job            Job               `json:"job"`
	Limit          int32             `json:"limit"`
	Offset         int32             `json:"offset"`
	SignalRequests []JobSignalRecord `json:"signalRequests"`
}

JobSignalRecordPage defines model for JobSignalRecordPage.

type JobSignalRecordSignal added in v0.4.0

type JobSignalRecordSignal string

JobSignalRecordSignal defines model for JobSignalRecord.Signal.

const (
	JobSignalRecordSignalKill JobSignalRecordSignal = "kill"
	JobSignalRecordSignalStop JobSignalRecordSignal = "stop"
)

Defines values for JobSignalRecordSignal.

func (JobSignalRecordSignal) Valid added in v0.4.0

func (e JobSignalRecordSignal) Valid() bool

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

type JobSignalRecordStateAtRequest added in v0.4.0

type JobSignalRecordStateAtRequest string

JobSignalRecordStateAtRequest defines model for JobSignalRecord.StateAtRequest.

const (
	JobSignalRecordStateAtRequestExited      JobSignalRecordStateAtRequest = "exited"
	JobSignalRecordStateAtRequestFailed      JobSignalRecordStateAtRequest = "failed"
	JobSignalRecordStateAtRequestInterrupted JobSignalRecordStateAtRequest = "interrupted"
	JobSignalRecordStateAtRequestRunning     JobSignalRecordStateAtRequest = "running"
	JobSignalRecordStateAtRequestSignalled   JobSignalRecordStateAtRequest = "signalled"
)

Defines values for JobSignalRecordStateAtRequest.

func (JobSignalRecordStateAtRequest) Valid added in v0.4.0

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

type JobSignalRequest

type JobSignalRequest struct {
	// Signal stop sends SIGTERM to the process group then escalates to SIGKILL. kill goes straight to SIGKILL.
	Signal JobSignalRequestSignal `json:"signal"`
}

JobSignalRequest defines model for JobSignalRequest.

type JobSignalRequestSignal

type JobSignalRequestSignal string

JobSignalRequestSignal stop sends SIGTERM to the process group then escalates to SIGKILL. kill goes straight to SIGKILL.

const (
	JobSignalRequestSignalKill JobSignalRequestSignal = "kill"
	JobSignalRequestSignalStop JobSignalRequestSignal = "stop"
)

Defines values for JobSignalRequestSignal.

func (JobSignalRequestSignal) Valid

func (e JobSignalRequestSignal) Valid() bool

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

type JobSignalResponse

type JobSignalResponse struct {
	JobId openapi_types.UUID `json:"jobId"`

	// Signalled True when this request found a running job and signalled it. Signalling an unknown, exited, or already signalled job is not an error and reports false with the current state.
	Signalled bool                   `json:"signalled"`
	State     JobSignalResponseState `json:"state"`
}

JobSignalResponse defines model for JobSignalResponse.

type JobSignalResponseState

type JobSignalResponseState string

JobSignalResponseState defines model for JobSignalResponse.State.

const (
	JobSignalResponseStateExited      JobSignalResponseState = "exited"
	JobSignalResponseStateFailed      JobSignalResponseState = "failed"
	JobSignalResponseStateInterrupted JobSignalResponseState = "interrupted"
	JobSignalResponseStateRunning     JobSignalResponseState = "running"
	JobSignalResponseStateSignalled   JobSignalResponseState = "signalled"
)

Defines values for JobSignalResponseState.

func (JobSignalResponseState) Valid

func (e JobSignalResponseState) Valid() bool

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

type JobState

type JobState string

JobState defines model for Job.State.

const (
	JobStateExited      JobState = "exited"
	JobStateFailed      JobState = "failed"
	JobStateInterrupted JobState = "interrupted"
	JobStateRunning     JobState = "running"
	JobStateSignalled   JobState = "signalled"
)

Defines values for JobState.

func (JobState) Valid

func (e JobState) Valid() bool

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

type LearnedFile added in v0.37.0

type LearnedFile struct {
	// AlwaysLoaded True for a rule without paths, globs, or applyTo, which is part of every system prompt and counts against PEEN_MAX_SYSTEM_PROMPT_PERCENT. Always false for a skill.
	AlwaysLoaded bool `json:"alwaysLoaded"`

	// EstimatedTokens The file's size in tokens, estimated with the o200k tokenizer.
	EstimatedTokens int64       `json:"estimatedTokens"`
	Kind            LearnedKind `json:"kind"`
	ModifiedAt      time.Time   `json:"modifiedAt"`

	// Name The rule's path under rules/ without .md, or the skill's directory name. A learned rule loads under the name learned/<name>.
	Name string `json:"name"`

	// Path The rule file, or the skill's SKILL.md, on the controller's host.
	Path string `json:"path"`

	// Scope workspace is the session workspace's .agents/learned, and global is the global learned directory every session reads.
	Scope     LearnedScope `json:"scope"`
	SizeBytes int64        `json:"sizeBytes"`
}

LearnedFile defines model for LearnedFile.

type LearnedFileContent added in v0.37.0

type LearnedFileContent struct {
	Content string      `json:"content"`
	File    LearnedFile `json:"file"`
}

LearnedFileContent defines model for LearnedFileContent.

type LearnedFileList added in v0.37.0

type LearnedFileList struct {
	// Items Workspace files first, then global ones, each sorted by kind and name.
	Items []LearnedFile `json:"items"`
}

LearnedFileList defines model for LearnedFileList.

type LearnedKind added in v0.37.0

type LearnedKind string

LearnedKind defines model for LearnedKind.

const (
	LearnedKindRule  LearnedKind = "rule"
	LearnedKindSkill LearnedKind = "skill"
)

Defines values for LearnedKind.

func (LearnedKind) Valid added in v0.37.0

func (e LearnedKind) Valid() bool

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

type LearnedName added in v0.37.0

type LearnedName = string

LearnedName defines model for LearnedName.

type LearnedScope added in v0.37.0

type LearnedScope string

LearnedScope workspace is the session workspace's .agents/learned, and global is the global learned directory every session reads.

const (
	LearnedScopeGlobal    LearnedScope = "global"
	LearnedScopeWorkspace LearnedScope = "workspace"
)

Defines values for LearnedScope.

func (LearnedScope) Valid added in v0.37.0

func (e LearnedScope) Valid() bool

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

type Limit

type Limit = int32

Limit defines model for Limit.

type ListAgentSpacesResponse added in v0.19.0

type ListAgentSpacesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AgentSpaceList
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListAgentSpacesResponse200Headers
}

func ParseListAgentSpacesResponse added in v0.19.0

func ParseListAgentSpacesResponse(rsp *http.Response) (*ListAgentSpacesResponse, error)

ParseListAgentSpacesResponse parses an HTTP response from a ListAgentSpacesWithResponse call

func (ListAgentSpacesResponse) ContentType added in v0.19.0

func (r ListAgentSpacesResponse) ContentType() string

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

func (ListAgentSpacesResponse) GetBody added in v0.19.0

func (r ListAgentSpacesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListAgentSpacesResponse) GetJSON200 added in v0.19.0

func (r ListAgentSpacesResponse) GetJSON200() *AgentSpaceList

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

func (ListAgentSpacesResponse) GetJSON401 added in v0.19.0

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

func (ListAgentSpacesResponse) GetJSON500 added in v0.19.0

func (r ListAgentSpacesResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListAgentSpacesResponse) Status added in v0.19.0

func (r ListAgentSpacesResponse) Status() string

Status returns HTTPResponse.Status

func (ListAgentSpacesResponse) StatusCode added in v0.19.0

func (r ListAgentSpacesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListAgentSpacesResponse200Headers added in v0.19.0

type ListAgentSpacesResponse200Headers struct {
	XRequestID openapi_types.UUID
}

ListAgentSpacesResponse200Headers the declared response headers of an HTTP 200 response for ListAgentSpaces

type ListMessagesParams

type ListMessagesParams struct {
	Limit      *Limit                   `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset                  `form:"offset,omitempty" json:"offset,omitempty"`
	Order      *ListMessagesParamsOrder `form:"order,omitempty" json:"order,omitempty"`
	XSessionID SessionIDRequired        `json:"X-Session-ID"`
}

ListMessagesParams defines parameters for ListMessages.

type ListMessagesParamsOrder

type ListMessagesParamsOrder string

ListMessagesParamsOrder defines parameters for ListMessages.

const (
	ListMessagesParamsOrderAsc  ListMessagesParamsOrder = "asc"
	ListMessagesParamsOrderDesc ListMessagesParamsOrder = "desc"
)

Defines values for ListMessagesParamsOrder.

func (ListMessagesParamsOrder) Valid

func (e ListMessagesParamsOrder) Valid() bool

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

type ListMessagesResponse

type ListMessagesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *MessagePage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListMessagesResponse200Headers
}

func ParseListMessagesResponse

func ParseListMessagesResponse(rsp *http.Response) (*ListMessagesResponse, error)

ParseListMessagesResponse parses an HTTP response from a ListMessagesWithResponse call

func (ListMessagesResponse) ContentType

func (r ListMessagesResponse) ContentType() string

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

func (ListMessagesResponse) GetBody

func (r ListMessagesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListMessagesResponse) GetJSON200

func (r ListMessagesResponse) GetJSON200() *MessagePage

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

func (ListMessagesResponse) GetJSON400

func (r ListMessagesResponse) GetJSON400() *ErrorBadRequest

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

func (ListMessagesResponse) GetJSON401

func (r ListMessagesResponse) GetJSON401() *ErrorUnauthorized

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

func (ListMessagesResponse) GetJSON404

func (r ListMessagesResponse) GetJSON404() *ErrorNotFound

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

func (ListMessagesResponse) GetJSON500

func (r ListMessagesResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListMessagesResponse) Status

func (r ListMessagesResponse) Status() string

Status returns HTTPResponse.Status

func (ListMessagesResponse) StatusCode

func (r ListMessagesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListMessagesResponse200Headers

type ListMessagesResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListMessagesResponse200Headers the declared response headers of an HTTP 200 response for ListMessages

type ListModelsResponse added in v0.12.0

type ListModelsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ModelList
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListModelsResponse200Headers
}

func ParseListModelsResponse added in v0.12.0

func ParseListModelsResponse(rsp *http.Response) (*ListModelsResponse, error)

ParseListModelsResponse parses an HTTP response from a ListModelsWithResponse call

func (ListModelsResponse) ContentType added in v0.12.0

func (r ListModelsResponse) ContentType() string

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

func (ListModelsResponse) GetBody added in v0.12.0

func (r ListModelsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListModelsResponse) GetJSON200 added in v0.12.0

func (r ListModelsResponse) GetJSON200() *ModelList

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

func (ListModelsResponse) GetJSON401 added in v0.12.0

func (r ListModelsResponse) GetJSON401() *ErrorUnauthorized

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

func (ListModelsResponse) GetJSON500 added in v0.12.0

func (r ListModelsResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListModelsResponse) Status added in v0.12.0

func (r ListModelsResponse) Status() string

Status returns HTTPResponse.Status

func (ListModelsResponse) StatusCode added in v0.12.0

func (r ListModelsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListModelsResponse200Headers added in v0.12.0

type ListModelsResponse200Headers struct {
	XRequestID openapi_types.UUID
}

ListModelsResponse200Headers the declared response headers of an HTTP 200 response for ListModels

type ListSessionAgentRunCompactionsParams added in v0.11.0

type ListSessionAgentRunCompactionsParams struct {
	Limit      *Limit            `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset           `form:"offset,omitempty" json:"offset,omitempty"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionAgentRunCompactionsParams defines parameters for ListSessionAgentRunCompactions.

type ListSessionAgentRunCompactionsResponse added in v0.11.0

type ListSessionAgentRunCompactionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AgentRunCompactionPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionAgentRunCompactionsResponse200Headers
}

func ParseListSessionAgentRunCompactionsResponse added in v0.11.0

func ParseListSessionAgentRunCompactionsResponse(rsp *http.Response) (*ListSessionAgentRunCompactionsResponse, error)

ParseListSessionAgentRunCompactionsResponse parses an HTTP response from a ListSessionAgentRunCompactionsWithResponse call

func (ListSessionAgentRunCompactionsResponse) ContentType added in v0.11.0

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

func (ListSessionAgentRunCompactionsResponse) GetBody added in v0.11.0

GetBody returns the raw response body bytes

func (ListSessionAgentRunCompactionsResponse) GetJSON200 added in v0.11.0

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

func (ListSessionAgentRunCompactionsResponse) GetJSON400 added in v0.11.0

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

func (ListSessionAgentRunCompactionsResponse) GetJSON401 added in v0.11.0

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

func (ListSessionAgentRunCompactionsResponse) GetJSON404 added in v0.11.0

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

func (ListSessionAgentRunCompactionsResponse) GetJSON500 added in v0.11.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionAgentRunCompactionsResponse) Status added in v0.11.0

Status returns HTTPResponse.Status

func (ListSessionAgentRunCompactionsResponse) StatusCode added in v0.11.0

StatusCode returns HTTPResponse.StatusCode

type ListSessionAgentRunCompactionsResponse200Headers added in v0.11.0

type ListSessionAgentRunCompactionsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionAgentRunCompactionsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionAgentRunCompactions

type ListSessionAgentRunEventsParams

type ListSessionAgentRunEventsParams struct {
	Cursor     *int64            `form:"cursor,omitempty" json:"cursor,omitempty"`
	Limit      *int32            `form:"limit,omitempty" json:"limit,omitempty"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionAgentRunEventsParams defines parameters for ListSessionAgentRunEvents.

type ListSessionAgentRunEventsResponse

type ListSessionAgentRunEventsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AgentRunEventPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionAgentRunEventsResponse200Headers
}

func ParseListSessionAgentRunEventsResponse

func ParseListSessionAgentRunEventsResponse(rsp *http.Response) (*ListSessionAgentRunEventsResponse, error)

ParseListSessionAgentRunEventsResponse parses an HTTP response from a ListSessionAgentRunEventsWithResponse call

func (ListSessionAgentRunEventsResponse) ContentType

func (r ListSessionAgentRunEventsResponse) ContentType() string

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

func (ListSessionAgentRunEventsResponse) GetBody

GetBody returns the raw response body bytes

func (ListSessionAgentRunEventsResponse) GetJSON200

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

func (ListSessionAgentRunEventsResponse) GetJSON400

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

func (ListSessionAgentRunEventsResponse) GetJSON401

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

func (ListSessionAgentRunEventsResponse) GetJSON404

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

func (ListSessionAgentRunEventsResponse) GetJSON500

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionAgentRunEventsResponse) Status

Status returns HTTPResponse.Status

func (ListSessionAgentRunEventsResponse) StatusCode

func (r ListSessionAgentRunEventsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionAgentRunEventsResponse200Headers

type ListSessionAgentRunEventsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionAgentRunEventsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionAgentRunEvents

type ListSessionAgentRunMessagesParams added in v0.11.0

type ListSessionAgentRunMessagesParams struct {
	Limit      *Limit            `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset           `form:"offset,omitempty" json:"offset,omitempty"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionAgentRunMessagesParams defines parameters for ListSessionAgentRunMessages.

type ListSessionAgentRunMessagesResponse added in v0.11.0

type ListSessionAgentRunMessagesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AgentRunMessagePage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionAgentRunMessagesResponse200Headers
}

func ParseListSessionAgentRunMessagesResponse added in v0.11.0

func ParseListSessionAgentRunMessagesResponse(rsp *http.Response) (*ListSessionAgentRunMessagesResponse, error)

ParseListSessionAgentRunMessagesResponse parses an HTTP response from a ListSessionAgentRunMessagesWithResponse call

func (ListSessionAgentRunMessagesResponse) ContentType added in v0.11.0

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

func (ListSessionAgentRunMessagesResponse) GetBody added in v0.11.0

GetBody returns the raw response body bytes

func (ListSessionAgentRunMessagesResponse) GetJSON200 added in v0.11.0

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

func (ListSessionAgentRunMessagesResponse) GetJSON400 added in v0.11.0

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

func (ListSessionAgentRunMessagesResponse) GetJSON401 added in v0.11.0

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

func (ListSessionAgentRunMessagesResponse) GetJSON404 added in v0.11.0

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

func (ListSessionAgentRunMessagesResponse) GetJSON500 added in v0.11.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionAgentRunMessagesResponse) Status added in v0.11.0

Status returns HTTPResponse.Status

func (ListSessionAgentRunMessagesResponse) StatusCode added in v0.11.0

StatusCode returns HTTPResponse.StatusCode

type ListSessionAgentRunMessagesResponse200Headers added in v0.11.0

type ListSessionAgentRunMessagesResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionAgentRunMessagesResponse200Headers the declared response headers of an HTTP 200 response for ListSessionAgentRunMessages

type ListSessionAgentRunsParams

type ListSessionAgentRunsParams struct {
	Limit  *Limit  `form:"limit,omitempty" json:"limit,omitempty"`
	Offset *Offset `form:"offset,omitempty" json:"offset,omitempty"`

	// State Keep runs in one state. waiting keeps running runs whose question nobody has answered yet.
	State *ListSessionAgentRunsParamsState `form:"state,omitempty" json:"state,omitempty"`

	// ParentAgentRunId Keep the direct children of one agent run, or root for the children the root conversation launched.
	ParentAgentRunId *string           `form:"parentAgentRunId,omitempty" json:"parentAgentRunId,omitempty"`
	XSessionID       SessionIDRequired `json:"X-Session-ID"`
}

ListSessionAgentRunsParams defines parameters for ListSessionAgentRuns.

type ListSessionAgentRunsParamsState

type ListSessionAgentRunsParamsState string

ListSessionAgentRunsParamsState defines parameters for ListSessionAgentRuns.

const (
	ListSessionAgentRunsParamsStateCancelled   ListSessionAgentRunsParamsState = "cancelled"
	ListSessionAgentRunsParamsStateCompleted   ListSessionAgentRunsParamsState = "completed"
	ListSessionAgentRunsParamsStateFailed      ListSessionAgentRunsParamsState = "failed"
	ListSessionAgentRunsParamsStateInterrupted ListSessionAgentRunsParamsState = "interrupted"
	ListSessionAgentRunsParamsStateRunning     ListSessionAgentRunsParamsState = "running"
	ListSessionAgentRunsParamsStateWaiting     ListSessionAgentRunsParamsState = "waiting"
)

Defines values for ListSessionAgentRunsParamsState.

func (ListSessionAgentRunsParamsState) Valid

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

type ListSessionAgentRunsResponse

type ListSessionAgentRunsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AgentRunPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionAgentRunsResponse200Headers
}

func ParseListSessionAgentRunsResponse

func ParseListSessionAgentRunsResponse(rsp *http.Response) (*ListSessionAgentRunsResponse, error)

ParseListSessionAgentRunsResponse parses an HTTP response from a ListSessionAgentRunsWithResponse call

func (ListSessionAgentRunsResponse) ContentType

func (r ListSessionAgentRunsResponse) ContentType() string

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

func (ListSessionAgentRunsResponse) GetBody

func (r ListSessionAgentRunsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionAgentRunsResponse) GetJSON200

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

func (ListSessionAgentRunsResponse) GetJSON400

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

func (ListSessionAgentRunsResponse) GetJSON401

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

func (ListSessionAgentRunsResponse) GetJSON404

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

func (ListSessionAgentRunsResponse) GetJSON500

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionAgentRunsResponse) Status

Status returns HTTPResponse.Status

func (ListSessionAgentRunsResponse) StatusCode

func (r ListSessionAgentRunsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionAgentRunsResponse200Headers

type ListSessionAgentRunsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionAgentRunsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionAgentRuns

type ListSessionAgentSpaceDecisionsParams added in v0.19.0

type ListSessionAgentSpaceDecisionsParams struct {
	Limit      *Limit            `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset           `form:"offset,omitempty" json:"offset,omitempty"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionAgentSpaceDecisionsParams defines parameters for ListSessionAgentSpaceDecisions.

type ListSessionAgentSpaceDecisionsResponse added in v0.19.0

type ListSessionAgentSpaceDecisionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SessionAgentSpaceDecisionPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionAgentSpaceDecisionsResponse200Headers
}

func ParseListSessionAgentSpaceDecisionsResponse added in v0.19.0

func ParseListSessionAgentSpaceDecisionsResponse(rsp *http.Response) (*ListSessionAgentSpaceDecisionsResponse, error)

ParseListSessionAgentSpaceDecisionsResponse parses an HTTP response from a ListSessionAgentSpaceDecisionsWithResponse call

func (ListSessionAgentSpaceDecisionsResponse) ContentType added in v0.19.0

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

func (ListSessionAgentSpaceDecisionsResponse) GetBody added in v0.19.0

GetBody returns the raw response body bytes

func (ListSessionAgentSpaceDecisionsResponse) GetJSON200 added in v0.19.0

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

func (ListSessionAgentSpaceDecisionsResponse) GetJSON400 added in v0.19.0

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

func (ListSessionAgentSpaceDecisionsResponse) GetJSON401 added in v0.19.0

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

func (ListSessionAgentSpaceDecisionsResponse) GetJSON404 added in v0.19.0

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

func (ListSessionAgentSpaceDecisionsResponse) GetJSON500 added in v0.19.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionAgentSpaceDecisionsResponse) Status added in v0.19.0

Status returns HTTPResponse.Status

func (ListSessionAgentSpaceDecisionsResponse) StatusCode added in v0.19.0

StatusCode returns HTTPResponse.StatusCode

type ListSessionAgentSpaceDecisionsResponse200Headers added in v0.19.0

type ListSessionAgentSpaceDecisionsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionAgentSpaceDecisionsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionAgentSpaceDecisions

type ListSessionCompactionsParams added in v0.4.0

type ListSessionCompactionsParams struct {
	Limit      *Limit            `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset           `form:"offset,omitempty" json:"offset,omitempty"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionCompactionsParams defines parameters for ListSessionCompactions.

type ListSessionCompactionsResponse added in v0.4.0

type ListSessionCompactionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *CompactionPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionCompactionsResponse200Headers
}

func ParseListSessionCompactionsResponse added in v0.4.0

func ParseListSessionCompactionsResponse(rsp *http.Response) (*ListSessionCompactionsResponse, error)

ParseListSessionCompactionsResponse parses an HTTP response from a ListSessionCompactionsWithResponse call

func (ListSessionCompactionsResponse) ContentType added in v0.4.0

func (r ListSessionCompactionsResponse) ContentType() string

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

func (ListSessionCompactionsResponse) GetBody added in v0.4.0

func (r ListSessionCompactionsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionCompactionsResponse) GetJSON200 added in v0.4.0

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

func (ListSessionCompactionsResponse) GetJSON400 added in v0.4.0

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

func (ListSessionCompactionsResponse) GetJSON401 added in v0.4.0

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

func (ListSessionCompactionsResponse) GetJSON404 added in v0.4.0

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

func (ListSessionCompactionsResponse) GetJSON500 added in v0.4.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionCompactionsResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (ListSessionCompactionsResponse) StatusCode added in v0.4.0

func (r ListSessionCompactionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionCompactionsResponse200Headers added in v0.4.0

type ListSessionCompactionsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionCompactionsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionCompactions

type ListSessionEventsParams

type ListSessionEventsParams struct {
	Limit      *Limit                        `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset                       `form:"offset,omitempty" json:"offset,omitempty"`
	Order      *ListSessionEventsParamsOrder `form:"order,omitempty" json:"order,omitempty"`
	XSessionID SessionIDRequired             `json:"X-Session-ID"`
}

ListSessionEventsParams defines parameters for ListSessionEvents.

type ListSessionEventsParamsOrder added in v0.4.0

type ListSessionEventsParamsOrder string

ListSessionEventsParamsOrder defines parameters for ListSessionEvents.

const (
	ListSessionEventsParamsOrderAsc  ListSessionEventsParamsOrder = "asc"
	ListSessionEventsParamsOrderDesc ListSessionEventsParamsOrder = "desc"
)

Defines values for ListSessionEventsParamsOrder.

func (ListSessionEventsParamsOrder) Valid added in v0.4.0

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

type ListSessionEventsResponse

type ListSessionEventsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *TranscriptEventPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionEventsResponse200Headers
}

func ParseListSessionEventsResponse

func ParseListSessionEventsResponse(rsp *http.Response) (*ListSessionEventsResponse, error)

ParseListSessionEventsResponse parses an HTTP response from a ListSessionEventsWithResponse call

func (ListSessionEventsResponse) ContentType

func (r ListSessionEventsResponse) ContentType() string

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

func (ListSessionEventsResponse) GetBody

func (r ListSessionEventsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionEventsResponse) GetJSON200

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

func (ListSessionEventsResponse) GetJSON400

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

func (ListSessionEventsResponse) GetJSON401

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

func (ListSessionEventsResponse) GetJSON404

func (r ListSessionEventsResponse) GetJSON404() *ErrorNotFound

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

func (ListSessionEventsResponse) GetJSON500

func (r ListSessionEventsResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionEventsResponse) Status

func (r ListSessionEventsResponse) Status() string

Status returns HTTPResponse.Status

func (ListSessionEventsResponse) StatusCode

func (r ListSessionEventsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionEventsResponse200Headers

type ListSessionEventsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionEventsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionEvents

type ListSessionFeedParams added in v0.26.0

type ListSessionFeedParams struct {
	// Cursor Return items with a sequence greater than this value.
	Cursor     *int64            `form:"cursor,omitempty" json:"cursor,omitempty"`
	Limit      *int32            `form:"limit,omitempty" json:"limit,omitempty"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionFeedParams defines parameters for ListSessionFeed.

type ListSessionFeedResponse added in v0.26.0

type ListSessionFeedResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *FeedPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionFeedResponse200Headers
}

func ParseListSessionFeedResponse added in v0.26.0

func ParseListSessionFeedResponse(rsp *http.Response) (*ListSessionFeedResponse, error)

ParseListSessionFeedResponse parses an HTTP response from a ListSessionFeedWithResponse call

func (ListSessionFeedResponse) ContentType added in v0.26.0

func (r ListSessionFeedResponse) ContentType() string

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

func (ListSessionFeedResponse) GetBody added in v0.26.0

func (r ListSessionFeedResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionFeedResponse) GetJSON200 added in v0.26.0

func (r ListSessionFeedResponse) GetJSON200() *FeedPage

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

func (ListSessionFeedResponse) GetJSON400 added in v0.26.0

func (r ListSessionFeedResponse) GetJSON400() *ErrorBadRequest

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

func (ListSessionFeedResponse) GetJSON401 added in v0.26.0

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

func (ListSessionFeedResponse) GetJSON404 added in v0.26.0

func (r ListSessionFeedResponse) GetJSON404() *ErrorNotFound

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

func (ListSessionFeedResponse) GetJSON500 added in v0.26.0

func (r ListSessionFeedResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionFeedResponse) Status added in v0.26.0

func (r ListSessionFeedResponse) Status() string

Status returns HTTPResponse.Status

func (ListSessionFeedResponse) StatusCode added in v0.26.0

func (r ListSessionFeedResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionFeedResponse200Headers added in v0.26.0

type ListSessionFeedResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionFeedResponse200Headers the declared response headers of an HTTP 200 response for ListSessionFeed

type ListSessionJobSignalRequestsParams added in v0.4.0

type ListSessionJobSignalRequestsParams struct {
	Limit      *Limit            `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset           `form:"offset,omitempty" json:"offset,omitempty"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionJobSignalRequestsParams defines parameters for ListSessionJobSignalRequests.

type ListSessionJobSignalRequestsResponse added in v0.4.0

type ListSessionJobSignalRequestsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *JobSignalRecordPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionJobSignalRequestsResponse200Headers
}

func ParseListSessionJobSignalRequestsResponse added in v0.4.0

func ParseListSessionJobSignalRequestsResponse(rsp *http.Response) (*ListSessionJobSignalRequestsResponse, error)

ParseListSessionJobSignalRequestsResponse parses an HTTP response from a ListSessionJobSignalRequestsWithResponse call

func (ListSessionJobSignalRequestsResponse) ContentType added in v0.4.0

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

func (ListSessionJobSignalRequestsResponse) GetBody added in v0.4.0

GetBody returns the raw response body bytes

func (ListSessionJobSignalRequestsResponse) GetJSON200 added in v0.4.0

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

func (ListSessionJobSignalRequestsResponse) GetJSON400 added in v0.4.0

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

func (ListSessionJobSignalRequestsResponse) GetJSON401 added in v0.4.0

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

func (ListSessionJobSignalRequestsResponse) GetJSON404 added in v0.4.0

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

func (ListSessionJobSignalRequestsResponse) GetJSON500 added in v0.4.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionJobSignalRequestsResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (ListSessionJobSignalRequestsResponse) StatusCode added in v0.4.0

StatusCode returns HTTPResponse.StatusCode

type ListSessionJobSignalRequestsResponse200Headers added in v0.4.0

type ListSessionJobSignalRequestsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionJobSignalRequestsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionJobSignalRequests

type ListSessionJobsParams

type ListSessionJobsParams struct {
	Limit      *Limit                      `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset                     `form:"offset,omitempty" json:"offset,omitempty"`
	State      *ListSessionJobsParamsState `form:"state,omitempty" json:"state,omitempty"`
	XSessionID SessionIDRequired           `json:"X-Session-ID"`
}

ListSessionJobsParams defines parameters for ListSessionJobs.

type ListSessionJobsParamsState

type ListSessionJobsParamsState string

ListSessionJobsParamsState defines parameters for ListSessionJobs.

const (
	ListSessionJobsParamsStateExited      ListSessionJobsParamsState = "exited"
	ListSessionJobsParamsStateFailed      ListSessionJobsParamsState = "failed"
	ListSessionJobsParamsStateInterrupted ListSessionJobsParamsState = "interrupted"
	ListSessionJobsParamsStateRunning     ListSessionJobsParamsState = "running"
	ListSessionJobsParamsStateSignalled   ListSessionJobsParamsState = "signalled"
)

Defines values for ListSessionJobsParamsState.

func (ListSessionJobsParamsState) Valid

func (e ListSessionJobsParamsState) Valid() bool

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

type ListSessionJobsResponse

type ListSessionJobsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *JobPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionJobsResponse200Headers
}

func ParseListSessionJobsResponse

func ParseListSessionJobsResponse(rsp *http.Response) (*ListSessionJobsResponse, error)

ParseListSessionJobsResponse parses an HTTP response from a ListSessionJobsWithResponse call

func (ListSessionJobsResponse) ContentType

func (r ListSessionJobsResponse) ContentType() string

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

func (ListSessionJobsResponse) GetBody

func (r ListSessionJobsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionJobsResponse) GetJSON200

func (r ListSessionJobsResponse) GetJSON200() *JobPage

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

func (ListSessionJobsResponse) GetJSON400

func (r ListSessionJobsResponse) GetJSON400() *ErrorBadRequest

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

func (ListSessionJobsResponse) GetJSON401

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

func (ListSessionJobsResponse) GetJSON404

func (r ListSessionJobsResponse) GetJSON404() *ErrorNotFound

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

func (ListSessionJobsResponse) GetJSON500

func (r ListSessionJobsResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionJobsResponse) Status

func (r ListSessionJobsResponse) Status() string

Status returns HTTPResponse.Status

func (ListSessionJobsResponse) StatusCode

func (r ListSessionJobsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionJobsResponse200Headers

type ListSessionJobsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionJobsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionJobs

type ListSessionLearnedFilesParams added in v0.37.0

type ListSessionLearnedFilesParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionLearnedFilesParams defines parameters for ListSessionLearnedFiles.

type ListSessionLearnedFilesResponse added in v0.37.0

type ListSessionLearnedFilesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *LearnedFileList
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionLearnedFilesResponse200Headers
}

func ParseListSessionLearnedFilesResponse added in v0.37.0

func ParseListSessionLearnedFilesResponse(rsp *http.Response) (*ListSessionLearnedFilesResponse, error)

ParseListSessionLearnedFilesResponse parses an HTTP response from a ListSessionLearnedFilesWithResponse call

func (ListSessionLearnedFilesResponse) ContentType added in v0.37.0

func (r ListSessionLearnedFilesResponse) ContentType() string

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

func (ListSessionLearnedFilesResponse) GetBody added in v0.37.0

func (r ListSessionLearnedFilesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionLearnedFilesResponse) GetJSON200 added in v0.37.0

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

func (ListSessionLearnedFilesResponse) GetJSON400 added in v0.37.0

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

func (ListSessionLearnedFilesResponse) GetJSON401 added in v0.37.0

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

func (ListSessionLearnedFilesResponse) GetJSON404 added in v0.37.0

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

func (ListSessionLearnedFilesResponse) GetJSON500 added in v0.37.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionLearnedFilesResponse) Status added in v0.37.0

Status returns HTTPResponse.Status

func (ListSessionLearnedFilesResponse) StatusCode added in v0.37.0

func (r ListSessionLearnedFilesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionLearnedFilesResponse200Headers added in v0.37.0

type ListSessionLearnedFilesResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionLearnedFilesResponse200Headers the declared response headers of an HTTP 200 response for ListSessionLearnedFiles

type ListSessionModelRunCallsParams added in v0.4.0

type ListSessionModelRunCallsParams struct {
	Limit      *Limit            `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset           `form:"offset,omitempty" json:"offset,omitempty"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionModelRunCallsParams defines parameters for ListSessionModelRunCalls.

type ListSessionModelRunCallsResponse added in v0.4.0

type ListSessionModelRunCallsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ModelCallPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionModelRunCallsResponse200Headers
}

func ParseListSessionModelRunCallsResponse added in v0.4.0

func ParseListSessionModelRunCallsResponse(rsp *http.Response) (*ListSessionModelRunCallsResponse, error)

ParseListSessionModelRunCallsResponse parses an HTTP response from a ListSessionModelRunCallsWithResponse call

func (ListSessionModelRunCallsResponse) ContentType added in v0.4.0

func (r ListSessionModelRunCallsResponse) ContentType() string

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

func (ListSessionModelRunCallsResponse) GetBody added in v0.4.0

func (r ListSessionModelRunCallsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionModelRunCallsResponse) GetJSON200 added in v0.4.0

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

func (ListSessionModelRunCallsResponse) GetJSON400 added in v0.4.0

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

func (ListSessionModelRunCallsResponse) GetJSON401 added in v0.4.0

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

func (ListSessionModelRunCallsResponse) GetJSON404 added in v0.4.0

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

func (ListSessionModelRunCallsResponse) GetJSON500 added in v0.4.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionModelRunCallsResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (ListSessionModelRunCallsResponse) StatusCode added in v0.4.0

func (r ListSessionModelRunCallsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionModelRunCallsResponse200Headers added in v0.4.0

type ListSessionModelRunCallsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionModelRunCallsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionModelRunCalls

type ListSessionModelRunsParams added in v0.4.0

type ListSessionModelRunsParams struct {
	Limit      *Limit                           `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset                          `form:"offset,omitempty" json:"offset,omitempty"`
	Stage      *ListSessionModelRunsParamsStage `form:"stage,omitempty" json:"stage,omitempty"`
	State      *ListSessionModelRunsParamsState `form:"state,omitempty" json:"state,omitempty"`
	XSessionID SessionIDRequired                `json:"X-Session-ID"`
}

ListSessionModelRunsParams defines parameters for ListSessionModelRuns.

type ListSessionModelRunsParamsStage added in v0.4.0

type ListSessionModelRunsParamsStage string

ListSessionModelRunsParamsStage defines parameters for ListSessionModelRuns.

const (
	ListSessionModelRunsParamsStageChild      ListSessionModelRunsParamsStage = "child"
	ListSessionModelRunsParamsStageCompaction ListSessionModelRunsParamsStage = "compaction"
	ListSessionModelRunsParamsStageTurn       ListSessionModelRunsParamsStage = "turn"
)

Defines values for ListSessionModelRunsParamsStage.

func (ListSessionModelRunsParamsStage) Valid added in v0.4.0

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

type ListSessionModelRunsParamsState added in v0.4.0

type ListSessionModelRunsParamsState string

ListSessionModelRunsParamsState defines parameters for ListSessionModelRuns.

const (
	ListSessionModelRunsParamsStateCancelled   ListSessionModelRunsParamsState = "cancelled"
	ListSessionModelRunsParamsStateCompleted   ListSessionModelRunsParamsState = "completed"
	ListSessionModelRunsParamsStateFailed      ListSessionModelRunsParamsState = "failed"
	ListSessionModelRunsParamsStateInterrupted ListSessionModelRunsParamsState = "interrupted"
	ListSessionModelRunsParamsStateRunning     ListSessionModelRunsParamsState = "running"
)

Defines values for ListSessionModelRunsParamsState.

func (ListSessionModelRunsParamsState) Valid added in v0.4.0

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

type ListSessionModelRunsResponse added in v0.4.0

type ListSessionModelRunsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ModelRunPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionModelRunsResponse200Headers
}

func ParseListSessionModelRunsResponse added in v0.4.0

func ParseListSessionModelRunsResponse(rsp *http.Response) (*ListSessionModelRunsResponse, error)

ParseListSessionModelRunsResponse parses an HTTP response from a ListSessionModelRunsWithResponse call

func (ListSessionModelRunsResponse) ContentType added in v0.4.0

func (r ListSessionModelRunsResponse) ContentType() string

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

func (ListSessionModelRunsResponse) GetBody added in v0.4.0

func (r ListSessionModelRunsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionModelRunsResponse) GetJSON200 added in v0.4.0

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

func (ListSessionModelRunsResponse) GetJSON400 added in v0.4.0

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

func (ListSessionModelRunsResponse) GetJSON401 added in v0.4.0

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

func (ListSessionModelRunsResponse) GetJSON404 added in v0.4.0

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

func (ListSessionModelRunsResponse) GetJSON500 added in v0.4.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionModelRunsResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (ListSessionModelRunsResponse) StatusCode added in v0.4.0

func (r ListSessionModelRunsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionModelRunsResponse200Headers added in v0.4.0

type ListSessionModelRunsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionModelRunsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionModelRuns

type ListSessionNoticesParams added in v0.4.0

type ListSessionNoticesParams struct {
	Limit      *Limit            `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset           `form:"offset,omitempty" json:"offset,omitempty"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionNoticesParams defines parameters for ListSessionNotices.

type ListSessionNoticesResponse added in v0.4.0

type ListSessionNoticesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SessionNoticePage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionNoticesResponse200Headers
}

func ParseListSessionNoticesResponse added in v0.4.0

func ParseListSessionNoticesResponse(rsp *http.Response) (*ListSessionNoticesResponse, error)

ParseListSessionNoticesResponse parses an HTTP response from a ListSessionNoticesWithResponse call

func (ListSessionNoticesResponse) ContentType added in v0.4.0

func (r ListSessionNoticesResponse) ContentType() string

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

func (ListSessionNoticesResponse) GetBody added in v0.4.0

func (r ListSessionNoticesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionNoticesResponse) GetJSON200 added in v0.4.0

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

func (ListSessionNoticesResponse) GetJSON400 added in v0.4.0

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

func (ListSessionNoticesResponse) GetJSON401 added in v0.4.0

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

func (ListSessionNoticesResponse) GetJSON404 added in v0.4.0

func (r ListSessionNoticesResponse) GetJSON404() *ErrorNotFound

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

func (ListSessionNoticesResponse) GetJSON500 added in v0.4.0

func (r ListSessionNoticesResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionNoticesResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (ListSessionNoticesResponse) StatusCode added in v0.4.0

func (r ListSessionNoticesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionNoticesResponse200Headers added in v0.4.0

type ListSessionNoticesResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionNoticesResponse200Headers the declared response headers of an HTTP 200 response for ListSessionNotices

type ListSessionTurnsParams added in v0.4.0

type ListSessionTurnsParams struct {
	Limit      *Limit            `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset           `form:"offset,omitempty" json:"offset,omitempty"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionTurnsParams defines parameters for ListSessionTurns.

type ListSessionTurnsResponse added in v0.4.0

type ListSessionTurnsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *TurnPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionTurnsResponse200Headers
}

func ParseListSessionTurnsResponse added in v0.4.0

func ParseListSessionTurnsResponse(rsp *http.Response) (*ListSessionTurnsResponse, error)

ParseListSessionTurnsResponse parses an HTTP response from a ListSessionTurnsWithResponse call

func (ListSessionTurnsResponse) ContentType added in v0.4.0

func (r ListSessionTurnsResponse) ContentType() string

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

func (ListSessionTurnsResponse) GetBody added in v0.4.0

func (r ListSessionTurnsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionTurnsResponse) GetJSON200 added in v0.4.0

func (r ListSessionTurnsResponse) GetJSON200() *TurnPage

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

func (ListSessionTurnsResponse) GetJSON400 added in v0.4.0

func (r ListSessionTurnsResponse) GetJSON400() *ErrorBadRequest

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

func (ListSessionTurnsResponse) GetJSON401 added in v0.4.0

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

func (ListSessionTurnsResponse) GetJSON404 added in v0.4.0

func (r ListSessionTurnsResponse) GetJSON404() *ErrorNotFound

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

func (ListSessionTurnsResponse) GetJSON500 added in v0.4.0

func (r ListSessionTurnsResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionTurnsResponse) Status added in v0.4.0

func (r ListSessionTurnsResponse) Status() string

Status returns HTTPResponse.Status

func (ListSessionTurnsResponse) StatusCode added in v0.4.0

func (r ListSessionTurnsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionTurnsResponse200Headers added in v0.4.0

type ListSessionTurnsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionTurnsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionTurns

type ListSessionWorkersParams added in v0.8.0

type ListSessionWorkersParams struct {
	Limit      *Limit            `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset           `form:"offset,omitempty" json:"offset,omitempty"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionWorkersParams defines parameters for ListSessionWorkers.

type ListSessionWorkersResponse added in v0.8.0

type ListSessionWorkersResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *WorkerGenerationPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionWorkersResponse200Headers
}

func ParseListSessionWorkersResponse added in v0.8.0

func ParseListSessionWorkersResponse(rsp *http.Response) (*ListSessionWorkersResponse, error)

ParseListSessionWorkersResponse parses an HTTP response from a ListSessionWorkersWithResponse call

func (ListSessionWorkersResponse) ContentType added in v0.8.0

func (r ListSessionWorkersResponse) ContentType() string

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

func (ListSessionWorkersResponse) GetBody added in v0.8.0

func (r ListSessionWorkersResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionWorkersResponse) GetJSON200 added in v0.8.0

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

func (ListSessionWorkersResponse) GetJSON400 added in v0.8.0

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

func (ListSessionWorkersResponse) GetJSON401 added in v0.8.0

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

func (ListSessionWorkersResponse) GetJSON404 added in v0.8.0

func (r ListSessionWorkersResponse) GetJSON404() *ErrorNotFound

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

func (ListSessionWorkersResponse) GetJSON500 added in v0.8.0

func (r ListSessionWorkersResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionWorkersResponse) Status added in v0.8.0

Status returns HTTPResponse.Status

func (ListSessionWorkersResponse) StatusCode added in v0.8.0

func (r ListSessionWorkersResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionWorkersResponse200Headers added in v0.8.0

type ListSessionWorkersResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionWorkersResponse200Headers the declared response headers of an HTTP 200 response for ListSessionWorkers

type ListSessionsParams added in v0.8.0

type ListSessionsParams struct {
	Limit  *Limit  `form:"limit,omitempty" json:"limit,omitempty"`
	Offset *Offset `form:"offset,omitempty" json:"offset,omitempty"`
}

ListSessionsParams defines parameters for ListSessions.

type ListSessionsResponse added in v0.8.0

type ListSessionsResponse 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 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionsResponse200Headers
}

func ParseListSessionsResponse added in v0.8.0

func ParseListSessionsResponse(rsp *http.Response) (*ListSessionsResponse, error)

ParseListSessionsResponse parses an HTTP response from a ListSessionsWithResponse call

func (ListSessionsResponse) ContentType added in v0.8.0

func (r ListSessionsResponse) ContentType() string

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

func (ListSessionsResponse) GetBody added in v0.8.0

func (r ListSessionsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionsResponse) GetJSON200 added in v0.8.0

func (r ListSessionsResponse) GetJSON200() *SessionPage

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

func (ListSessionsResponse) GetJSON400 added in v0.8.0

func (r ListSessionsResponse) GetJSON400() *ErrorBadRequest

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

func (ListSessionsResponse) GetJSON401 added in v0.8.0

func (r ListSessionsResponse) GetJSON401() *ErrorUnauthorized

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

func (ListSessionsResponse) GetJSON500 added in v0.8.0

func (r ListSessionsResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionsResponse) Status added in v0.8.0

func (r ListSessionsResponse) Status() string

Status returns HTTPResponse.Status

func (ListSessionsResponse) StatusCode added in v0.8.0

func (r ListSessionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionsResponse200Headers added in v0.8.0

type ListSessionsResponse200Headers struct {
	XRequestID openapi_types.UUID
}

ListSessionsResponse200Headers the declared response headers of an HTTP 200 response for ListSessions

type ListWorkspaceRootsResponse added in v0.13.0

type ListWorkspaceRootsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *WorkspaceRootList
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListWorkspaceRootsResponse200Headers
}

func ParseListWorkspaceRootsResponse added in v0.13.0

func ParseListWorkspaceRootsResponse(rsp *http.Response) (*ListWorkspaceRootsResponse, error)

ParseListWorkspaceRootsResponse parses an HTTP response from a ListWorkspaceRootsWithResponse call

func (ListWorkspaceRootsResponse) ContentType added in v0.13.0

func (r ListWorkspaceRootsResponse) ContentType() string

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

func (ListWorkspaceRootsResponse) GetBody added in v0.13.0

func (r ListWorkspaceRootsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListWorkspaceRootsResponse) GetJSON200 added in v0.13.0

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

func (ListWorkspaceRootsResponse) GetJSON401 added in v0.13.0

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

func (ListWorkspaceRootsResponse) GetJSON500 added in v0.13.0

func (r ListWorkspaceRootsResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListWorkspaceRootsResponse) Status added in v0.13.0

Status returns HTTPResponse.Status

func (ListWorkspaceRootsResponse) StatusCode added in v0.13.0

func (r ListWorkspaceRootsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListWorkspaceRootsResponse200Headers added in v0.13.0

type ListWorkspaceRootsResponse200Headers struct {
	XRequestID openapi_types.UUID
}

ListWorkspaceRootsResponse200Headers the declared response headers of an HTTP 200 response for ListWorkspaceRoots

type MCPServerStatus added in v0.38.0

type MCPServerStatus struct {
	// Error Why the server failed.
	Error *string `json:"error,omitempty"`

	// Name The server name from mcp.json. Empty when a whole mcp.json file was refused.
	Name string `json:"name"`

	// Source The layer whose .agents/mcp.json defines the server.
	Source MCPServerStatusSource `json:"source"`
	State  MCPServerStatusState  `json:"state"`

	// Tools The exposed tool names, mcp__<server>__<tool>.
	Tools     []string                  `json:"tools"`
	Transport *MCPServerStatusTransport `json:"transport,omitempty"`

	// Warnings Problems that did not stop the server.
	Warnings *[]string `json:"warnings,omitempty"`
}

MCPServerStatus defines model for MCPServerStatus.

type MCPServerStatusSource added in v0.38.0

type MCPServerStatusSource string

MCPServerStatusSource The layer whose .agents/mcp.json defines the server.

const (
	MCPServerStatusSourceConfig    MCPServerStatusSource = "config"
	MCPServerStatusSourceWorkspace MCPServerStatusSource = "workspace"
)

Defines values for MCPServerStatusSource.

func (MCPServerStatusSource) Valid added in v0.38.0

func (e MCPServerStatusSource) Valid() bool

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

type MCPServerStatusState added in v0.38.0

type MCPServerStatusState string

MCPServerStatusState defines model for MCPServerStatus.State.

const (
	MCPServerStatusStateFailed MCPServerStatusState = "failed"
	MCPServerStatusStateReady  MCPServerStatusState = "ready"
)

Defines values for MCPServerStatusState.

func (MCPServerStatusState) Valid added in v0.38.0

func (e MCPServerStatusState) Valid() bool

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

type MCPServerStatusTransport added in v0.38.0

type MCPServerStatusTransport string

MCPServerStatusTransport defines model for MCPServerStatus.Transport.

const (
	MCPServerStatusTransportHttp  MCPServerStatusTransport = "http"
	MCPServerStatusTransportStdio MCPServerStatusTransport = "stdio"
)

Defines values for MCPServerStatusTransport.

func (MCPServerStatusTransport) Valid added in v0.38.0

func (e MCPServerStatusTransport) Valid() bool

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

type MCPStatusReport added in v0.38.0

type MCPStatusReport struct {
	// ReportedAt When the worker reported, at the start of a turn. Null before the first report.
	ReportedAt *time.Time        `json:"reportedAt"`
	Servers    []MCPServerStatus `json:"servers"`
}

MCPStatusReport defines model for MCPStatusReport.

type Message

type Message struct {
	CompactionId *openapi_types.UUID `json:"compactionId,omitempty"`
	Content      string              `json:"content"`
	CreatedAt    time.Time           `json:"createdAt"`
	Id           openapi_types.UUID  `json:"id"`

	// Images The images the message carries, without their bytes, in the order the model sees them after the text. Absent when it has none.
	Images     *[]MessageImageInfo `json:"images,omitempty"`
	Incomplete *bool               `json:"incomplete,omitempty"`

	// Injected True when Peen added this message to the conversation itself, such as a report of session events delivered during a turn or the instructions of an event handler that started a turn, rather than a person or the model writing it.
	Injected *bool `json:"injected,omitempty"`

	// InjectedKind What an injected message is, when it is more than a generic update. `skill` marks a skill the user invoked with `:name`, delivered as its own message after the message that named it, or the note that the skill was already loaded. `image` marks the message that shows the model an image readFile read, after that tool round. Absent for every other message.
	InjectedKind *MessageInjectedKind `json:"injectedKind,omitempty"`
	IsError      *bool                `json:"isError,omitempty"`
	Model        *string              `json:"model,omitempty"`

	// Role `system` is a notice Peen added to the conversation, such as how the previous turn ended and what it was asked. The model receives it as a system message.
	Role       MessageRole        `json:"role"`
	Sequence   int64              `json:"sequence"`
	Thinking   *string            `json:"thinking,omitempty"`
	ToolCallId *string            `json:"toolCallId,omitempty"`
	ToolCalls  *[]MessageToolCall `json:"toolCalls,omitempty"`

	// TurnId The turn that wrote this message. Messages that share it belong to one turn.
	TurnId    *openapi_types.UUID `json:"turnId,omitempty"`
	Workspace string              `json:"workspace"`
}

Message defines model for Message.

type MessageImageInfo added in v0.38.0

type MessageImageInfo struct {
	MediaType string `json:"mediaType"`
	SizeBytes int64  `json:"sizeBytes"`
}

MessageImageInfo defines model for MessageImageInfo.

type MessageInjectedKind added in v0.18.0

type MessageInjectedKind string

MessageInjectedKind What an injected message is, when it is more than a generic update. `skill` marks a skill the user invoked with `:name`, delivered as its own message after the message that named it, or the note that the skill was already loaded. `image` marks the message that shows the model an image readFile read, after that tool round. Absent for every other message.

const (
	MessageInjectedKindImage MessageInjectedKind = "image"
	MessageInjectedKindSkill MessageInjectedKind = "skill"
)

Defines values for MessageInjectedKind.

func (MessageInjectedKind) Valid added in v0.18.0

func (e MessageInjectedKind) Valid() bool

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

type MessagePage

type MessagePage struct {
	HasMore bool      `json:"hasMore"`
	Items   []Message `json:"items"`
	Limit   int32     `json:"limit"`
	Offset  int32     `json:"offset"`
}

MessagePage defines model for MessagePage.

type MessageRole

type MessageRole string

MessageRole `system` is a notice Peen added to the conversation, such as how the previous turn ended and what it was asked. The model receives it as a system message.

const (
	MessageRoleAssistant MessageRole = "assistant"
	MessageRoleSystem    MessageRole = "system"
	MessageRoleTool      MessageRole = "tool"
	MessageRoleUser      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 MessageToolCall

type MessageToolCall struct {
	Arguments map[string]interface{} `json:"arguments"`
	Id        string                 `json:"id"`
	Name      string                 `json:"name"`
}

MessageToolCall defines model for MessageToolCall.

type Model added in v0.12.0

type Model struct {
	// ConnectionName The configured connection portion of name.
	ConnectionName string `json:"connectionName"`

	// ContextWindowTokens The model context window Peen will enforce. For an upstream that publishes no window, this is the deployment context budget.
	ContextWindowTokens int64 `json:"contextWindowTokens"`

	// ImageInput Whether the model takes images, in message.send and from readFile. An upstream with "imageInput": false makes every one of its models text-only.
	ImageInput bool `json:"imageInput"`

	// ModelId The raw model identifier the upstream accepted.
	ModelId string `json:"modelId"`

	// Name Exact connection/model reference accepted by message.send for a one-turn model override.
	Name string `json:"name"`
}

Model defines model for Model.

type ModelCall added in v0.4.0

type ModelCall struct {
	BilledCostAmount        string                   `json:"billedCostAmount"`
	CacheReadTokens         int64                    `json:"cacheReadTokens"`
	CacheWriteLongTtlTokens int64                    `json:"cacheWriteLongTtlTokens"`
	CacheWriteTokens        int64                    `json:"cacheWriteTokens"`
	CompletedAt             *time.Time               `json:"completedAt,omitempty"`
	CompletionTokens        int64                    `json:"completionTokens"`
	CostKnown               bool                     `json:"costKnown"`
	FailureClassification   string                   `json:"failureClassification"`
	FailureDetail           string                   `json:"failureDetail"`
	FinishReason            string                   `json:"finishReason"`
	Id                      openapi_types.UUID       `json:"id"`
	ModelRunId              openapi_types.UUID       `json:"modelRunId"`
	PromptTokens            int64                    `json:"promptTokens"`
	ReasoningTokens         int64                    `json:"reasoningTokens"`
	RequestMessages         []interface{}            `json:"requestMessages"`
	RequestTools            []interface{}            `json:"requestTools"`
	ResponseCostAmount      string                   `json:"responseCostAmount"`
	ResponseMessage         *map[string]interface{}  `json:"responseMessage"`
	ResponseModelId         string                   `json:"responseModelId"`
	ResponseUsage           map[string]interface{}   `json:"responseUsage"`
	RetryAttemptCount       int64                    `json:"retryAttemptCount"`
	RetryAttempts           []map[string]interface{} `json:"retryAttempts"`
	RetryCostAmount         string                   `json:"retryCostAmount"`
	Round                   int64                    `json:"round"`
	SessionId               openapi_types.UUID       `json:"sessionId"`
	StartedAt               time.Time                `json:"startedAt"`
	State                   ModelCallState           `json:"state"`
	TotalAttempts           int64                    `json:"totalAttempts"`
	TotalTokens             int64                    `json:"totalTokens"`
	WastedCompletionTokens  int64                    `json:"wastedCompletionTokens"`
	WastedPromptTokens      int64                    `json:"wastedPromptTokens"`
	WastedTotalTokens       int64                    `json:"wastedTotalTokens"`
}

ModelCall defines model for ModelCall.

type ModelCallPage added in v0.4.0

type ModelCallPage struct {
	Calls    []ModelCall `json:"calls"`
	HasMore  bool        `json:"hasMore"`
	Limit    int32       `json:"limit"`
	ModelRun ModelRun    `json:"modelRun"`
	Offset   int32       `json:"offset"`
}

ModelCallPage defines model for ModelCallPage.

type ModelCallState added in v0.4.0

type ModelCallState string

ModelCallState defines model for ModelCall.State.

const (
	ModelCallStateCancelled   ModelCallState = "cancelled"
	ModelCallStateCompleted   ModelCallState = "completed"
	ModelCallStateFailed      ModelCallState = "failed"
	ModelCallStateInterrupted ModelCallState = "interrupted"
	ModelCallStateRunning     ModelCallState = "running"
)

Defines values for ModelCallState.

func (ModelCallState) Valid added in v0.4.0

func (e ModelCallState) Valid() bool

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

type ModelList added in v0.12.0

type ModelList struct {
	// Models Models available to this authenticated controller.
	Models []Model `json:"models"`
}

ModelList defines model for ModelList.

type ModelRun added in v0.4.0

type ModelRun struct {
	AgentRunId            *openapi_types.UUID    `json:"agentRunId,omitempty"`
	BilledCostAmount      string                 `json:"billedCostAmount"`
	CompletedAt           *time.Time             `json:"completedAt,omitempty"`
	ConnectionName        string                 `json:"connectionName"`
	CostKnown             bool                   `json:"costKnown"`
	FailureClassification string                 `json:"failureClassification"`
	FailureDetail         string                 `json:"failureDetail"`
	FinishReason          string                 `json:"finishReason"`
	Id                    openapi_types.UUID     `json:"id"`
	ModelReference        string                 `json:"modelReference"`
	RequestSettings       map[string]interface{} `json:"requestSettings"`
	RequestedModelId      string                 `json:"requestedModelId"`
	ResponseCostAmount    string                 `json:"responseCostAmount"`
	ResponseInjections    []interface{}          `json:"responseInjections"`
	ResponseMessages      []interface{}          `json:"responseMessages"`
	ResponseModelId       string                 `json:"responseModelId"`
	ResponseText          string                 `json:"responseText"`
	ResponseThinking      string                 `json:"responseThinking"`
	ResponseUsage         map[string]interface{} `json:"responseUsage"`
	RetryCostAmount       string                 `json:"retryCostAmount"`
	SessionId             openapi_types.UUID     `json:"sessionId"`
	Stage                 ModelRunStage          `json:"stage"`
	StartedAt             time.Time              `json:"startedAt"`
	State                 ModelRunState          `json:"state"`
	TurnId                openapi_types.UUID     `json:"turnId"`
}

ModelRun defines model for ModelRun.

type ModelRunID added in v0.4.0

type ModelRunID = openapi_types.UUID

ModelRunID defines model for ModelRunID.

type ModelRunPage added in v0.4.0

type ModelRunPage struct {
	HasMore   bool       `json:"hasMore"`
	Limit     int32      `json:"limit"`
	ModelRuns []ModelRun `json:"modelRuns"`
	Offset    int32      `json:"offset"`
}

ModelRunPage defines model for ModelRunPage.

type ModelRunStage added in v0.4.0

type ModelRunStage string

ModelRunStage defines model for ModelRun.Stage.

const (
	ModelRunStageChild      ModelRunStage = "child"
	ModelRunStageCompaction ModelRunStage = "compaction"
	ModelRunStageTurn       ModelRunStage = "turn"
)

Defines values for ModelRunStage.

func (ModelRunStage) Valid added in v0.4.0

func (e ModelRunStage) Valid() bool

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

type ModelRunState added in v0.4.0

type ModelRunState string

ModelRunState defines model for ModelRun.State.

const (
	ModelRunStateCancelled   ModelRunState = "cancelled"
	ModelRunStateCompleted   ModelRunState = "completed"
	ModelRunStateFailed      ModelRunState = "failed"
	ModelRunStateInterrupted ModelRunState = "interrupted"
	ModelRunStateRunning     ModelRunState = "running"
)

Defines values for ModelRunState.

func (ModelRunState) Valid added in v0.4.0

func (e ModelRunState) Valid() bool

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

type Offset

type Offset = int32

Offset defines model for Offset.

type OpenSessionJSONRequestBody added in v0.8.0

type OpenSessionJSONRequestBody = OpenSessionRequest

OpenSessionJSONRequestBody defines body for OpenSession for application/json ContentType.

type OpenSessionRequest added in v0.8.0

type OpenSessionRequest struct {
	// AgentSpace The agent space to run in, `control` or `docker:<profile>`. Empty takes the deployment default. A name the deployment does not offer is refused with 403. This is the only environment choice a client makes: images, mounts, network, and capabilities come from deployment configuration alone. It applies only when this call creates the session; opening an existing session never changes its agent space.
	AgentSpace *string `json:"agentSpace,omitempty"`

	// Workspace Absolute host path of the workspace directory. It is resolved through its symlinks and must fall under a configured workspace root.
	Workspace string `json:"workspace"`
}

OpenSessionRequest defines model for OpenSessionRequest.

type OpenSessionResponse added in v0.8.0

type OpenSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *OpenedSession
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ErrorForbidden
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *OpenSessionResponse200Headers
}

func ParseOpenSessionResponse added in v0.8.0

func ParseOpenSessionResponse(rsp *http.Response) (*OpenSessionResponse, error)

ParseOpenSessionResponse parses an HTTP response from a OpenSessionWithResponse call

func (OpenSessionResponse) ContentType added in v0.8.0

func (r OpenSessionResponse) ContentType() string

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

func (OpenSessionResponse) GetBody added in v0.8.0

func (r OpenSessionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (OpenSessionResponse) GetJSON200 added in v0.8.0

func (r OpenSessionResponse) GetJSON200() *OpenedSession

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

func (OpenSessionResponse) GetJSON400 added in v0.8.0

func (r OpenSessionResponse) GetJSON400() *ErrorBadRequest

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

func (OpenSessionResponse) GetJSON401 added in v0.8.0

func (r OpenSessionResponse) GetJSON401() *ErrorUnauthorized

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

func (OpenSessionResponse) GetJSON403 added in v0.8.0

func (r OpenSessionResponse) GetJSON403() *ErrorForbidden

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (OpenSessionResponse) GetJSON404 added in v0.13.0

func (r OpenSessionResponse) GetJSON404() *ErrorNotFound

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

func (OpenSessionResponse) GetJSON500 added in v0.8.0

func (r OpenSessionResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (OpenSessionResponse) Status added in v0.8.0

func (r OpenSessionResponse) Status() string

Status returns HTTPResponse.Status

func (OpenSessionResponse) StatusCode added in v0.8.0

func (r OpenSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type OpenSessionResponse200Headers added in v0.8.0

type OpenSessionResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

OpenSessionResponse200Headers the declared response headers of an HTTP 200 response for OpenSession

type OpenSystemSessionResponse added in v0.45.0

type OpenSystemSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *OpenedSession
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ErrorForbidden
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *OpenSystemSessionResponse200Headers
}

func ParseOpenSystemSessionResponse added in v0.45.0

func ParseOpenSystemSessionResponse(rsp *http.Response) (*OpenSystemSessionResponse, error)

ParseOpenSystemSessionResponse parses an HTTP response from a OpenSystemSessionWithResponse call

func (OpenSystemSessionResponse) ContentType added in v0.45.0

func (r OpenSystemSessionResponse) ContentType() string

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

func (OpenSystemSessionResponse) GetBody added in v0.45.0

func (r OpenSystemSessionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (OpenSystemSessionResponse) GetJSON200 added in v0.45.0

func (r OpenSystemSessionResponse) GetJSON200() *OpenedSession

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

func (OpenSystemSessionResponse) GetJSON401 added in v0.45.0

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

func (OpenSystemSessionResponse) GetJSON403 added in v0.45.0

func (r OpenSystemSessionResponse) GetJSON403() *ErrorForbidden

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (OpenSystemSessionResponse) GetJSON500 added in v0.45.0

func (r OpenSystemSessionResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (OpenSystemSessionResponse) Status added in v0.45.0

func (r OpenSystemSessionResponse) Status() string

Status returns HTTPResponse.Status

func (OpenSystemSessionResponse) StatusCode added in v0.45.0

func (r OpenSystemSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type OpenSystemSessionResponse200Headers added in v0.45.0

type OpenSystemSessionResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

OpenSystemSessionResponse200Headers the declared response headers of an HTTP 200 response for OpenSystemSession

type OpenedSession added in v0.8.0

type OpenedSession struct {
	// Created True when this call created the session, false when it resumed an existing one.
	Created bool    `json:"created"`
	Session Session `json:"session"`
}

OpenedSession defines model for OpenedSession.

type Order

type Order string

Order defines model for Order.

const (
	OrderAsc  Order = "asc"
	OrderDesc Order = "desc"
)

Defines values for Order.

func (Order) Valid

func (e Order) Valid() bool

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

type PromptHash added in v0.4.0

type PromptHash = string

PromptHash defines model for PromptHash.

type PromptSnapshot added in v0.4.0

type PromptSnapshot struct {
	CreatedAt       time.Time `json:"createdAt"`
	EffectivePrompt string    `json:"effectivePrompt"`
	Hash            string    `json:"hash"`
}

PromptSnapshot defines model for PromptSnapshot.

type PublishSessionNoticeJSONRequestBody added in v0.4.0

type PublishSessionNoticeJSONRequestBody = SessionNoticeRequest

PublishSessionNoticeJSONRequestBody defines body for PublishSessionNotice for application/json ContentType.

type PublishSessionNoticeParams added in v0.4.0

type PublishSessionNoticeParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

PublishSessionNoticeParams defines parameters for PublishSessionNotice.

type PublishSessionNoticeResponse added in v0.4.0

type PublishSessionNoticeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *SessionNotice
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers202 the parsed response headers for an HTTP 202 response
	Headers202 *PublishSessionNoticeResponse202Headers
}

func ParsePublishSessionNoticeResponse added in v0.4.0

func ParsePublishSessionNoticeResponse(rsp *http.Response) (*PublishSessionNoticeResponse, error)

ParsePublishSessionNoticeResponse parses an HTTP response from a PublishSessionNoticeWithResponse call

func (PublishSessionNoticeResponse) ContentType added in v0.4.0

func (r PublishSessionNoticeResponse) ContentType() string

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

func (PublishSessionNoticeResponse) GetBody added in v0.4.0

func (r PublishSessionNoticeResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PublishSessionNoticeResponse) GetJSON202 added in v0.4.0

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

func (PublishSessionNoticeResponse) GetJSON400 added in v0.4.0

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

func (PublishSessionNoticeResponse) GetJSON401 added in v0.4.0

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

func (PublishSessionNoticeResponse) GetJSON404 added in v0.4.0

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

func (PublishSessionNoticeResponse) GetJSON500 added in v0.4.0

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PublishSessionNoticeResponse) Status added in v0.4.0

Status returns HTTPResponse.Status

func (PublishSessionNoticeResponse) StatusCode added in v0.4.0

func (r PublishSessionNoticeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PublishSessionNoticeResponse202Headers added in v0.4.0

type PublishSessionNoticeResponse202Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

PublishSessionNoticeResponse202Headers the declared response headers of an HTTP 202 response for PublishSessionNotice

type ReadSessionJobOutputParams

type ReadSessionJobOutputParams struct {
	Stream     *ReadSessionJobOutputParamsStream `form:"stream,omitempty" json:"stream,omitempty"`
	Cursor     *int64                            `form:"cursor,omitempty" json:"cursor,omitempty"`
	Limit      *int32                            `form:"limit,omitempty" json:"limit,omitempty"`
	XSessionID SessionIDRequired                 `json:"X-Session-ID"`
}

ReadSessionJobOutputParams defines parameters for ReadSessionJobOutput.

type ReadSessionJobOutputParamsStream

type ReadSessionJobOutputParamsStream string

ReadSessionJobOutputParamsStream defines parameters for ReadSessionJobOutput.

const (
	ReadSessionJobOutputParamsStreamBoth   ReadSessionJobOutputParamsStream = "both"
	ReadSessionJobOutputParamsStreamStderr ReadSessionJobOutputParamsStream = "stderr"
	ReadSessionJobOutputParamsStreamStdout ReadSessionJobOutputParamsStream = "stdout"
)

Defines values for ReadSessionJobOutputParamsStream.

func (ReadSessionJobOutputParamsStream) Valid

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

type ReadSessionJobOutputResponse

type ReadSessionJobOutputResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *JobOutput
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ReadSessionJobOutputResponse200Headers
}

func ParseReadSessionJobOutputResponse

func ParseReadSessionJobOutputResponse(rsp *http.Response) (*ReadSessionJobOutputResponse, error)

ParseReadSessionJobOutputResponse parses an HTTP response from a ReadSessionJobOutputWithResponse call

func (ReadSessionJobOutputResponse) ContentType

func (r ReadSessionJobOutputResponse) ContentType() string

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

func (ReadSessionJobOutputResponse) GetBody

func (r ReadSessionJobOutputResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ReadSessionJobOutputResponse) GetJSON200

func (r ReadSessionJobOutputResponse) GetJSON200() *JobOutput

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

func (ReadSessionJobOutputResponse) GetJSON400

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

func (ReadSessionJobOutputResponse) GetJSON401

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

func (ReadSessionJobOutputResponse) GetJSON404

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

func (ReadSessionJobOutputResponse) GetJSON500

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ReadSessionJobOutputResponse) Status

Status returns HTTPResponse.Status

func (ReadSessionJobOutputResponse) StatusCode

func (r ReadSessionJobOutputResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReadSessionJobOutputResponse200Headers

type ReadSessionJobOutputResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ReadSessionJobOutputResponse200Headers the declared response headers of an HTTP 200 response for ReadSessionJobOutput

type ReconfigureSessionJSONRequestBody added in v0.8.0

type ReconfigureSessionJSONRequestBody = ReconfigureSessionRequest

ReconfigureSessionJSONRequestBody defines body for ReconfigureSession for application/json ContentType.

type ReconfigureSessionParams added in v0.8.0

type ReconfigureSessionParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ReconfigureSessionParams defines parameters for ReconfigureSession.

type ReconfigureSessionRequest added in v0.8.0

type ReconfigureSessionRequest struct {
	// AgentSpace The agent space to move this session to, `control` or `docker:<profile>`. A space the deployment does not offer is refused. This is the only environment choice a client makes.
	AgentSpace string `json:"agentSpace"`

	// Reason Why the agent space changed, kept in the durable decision history.
	Reason string `json:"reason"`
}

ReconfigureSessionRequest defines model for ReconfigureSessionRequest.

type ReconfigureSessionResponse added in v0.8.0

type ReconfigureSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SessionAgentSpaceDecision
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ErrorForbidden
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorConflict
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ReconfigureSessionResponse200Headers
}

func ParseReconfigureSessionResponse added in v0.8.0

func ParseReconfigureSessionResponse(rsp *http.Response) (*ReconfigureSessionResponse, error)

ParseReconfigureSessionResponse parses an HTTP response from a ReconfigureSessionWithResponse call

func (ReconfigureSessionResponse) ContentType added in v0.8.0

func (r ReconfigureSessionResponse) ContentType() string

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

func (ReconfigureSessionResponse) GetBody added in v0.8.0

func (r ReconfigureSessionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ReconfigureSessionResponse) GetJSON200 added in v0.8.0

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

func (ReconfigureSessionResponse) GetJSON400 added in v0.8.0

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

func (ReconfigureSessionResponse) GetJSON401 added in v0.8.0

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

func (ReconfigureSessionResponse) GetJSON403 added in v0.8.0

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ReconfigureSessionResponse) GetJSON404 added in v0.8.0

func (r ReconfigureSessionResponse) GetJSON404() *ErrorNotFound

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

func (ReconfigureSessionResponse) GetJSON409 added in v0.8.0

func (r ReconfigureSessionResponse) GetJSON409() *ErrorConflict

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

func (ReconfigureSessionResponse) GetJSON500 added in v0.8.0

func (r ReconfigureSessionResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ReconfigureSessionResponse) Status added in v0.8.0

Status returns HTTPResponse.Status

func (ReconfigureSessionResponse) StatusCode added in v0.8.0

func (r ReconfigureSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReconfigureSessionResponse200Headers added in v0.8.0

type ReconfigureSessionResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ReconfigureSessionResponse200Headers the declared response headers of an HTTP 200 response for ReconfigureSession

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type Session

type Session struct {
	ActiveTurn bool `json:"activeTurn"`

	// ActiveTurnFeedSequence First feed sequence of the running turn. Set only by GET /session while a turn runs; replay from the sequence before it to rebuild that turn's live view.
	ActiveTurnFeedSequence *int64 `json:"activeTurnFeedSequence,omitempty"`
	Agent                  string `json:"agent"`

	// AgentSpace The agent space this session's tools run in, `control` or `docker:<profile>`.
	AgentSpace         *string   `json:"agentSpace,omitempty"`
	CompletedTurnCount int64     `json:"completedTurnCount"`
	CreatedAt          time.Time `json:"createdAt"`

	// FeedSequence The session's newest feed sequence.
	FeedSequence  int64              `json:"feedSequence"`
	Id            openapi_types.UUID `json:"id"`
	LastMessageAt *time.Time         `json:"lastMessageAt,omitempty"`
	MessageCount  int64              `json:"messageCount"`
	Model         string             `json:"model"`
	UpdatedAt     time.Time          `json:"updatedAt"`
	Workspace     string             `json:"workspace"`
}

Session defines model for Session.

type SessionAgentSpaceDecision added in v0.19.0

type SessionAgentSpaceDecision struct {
	DecidedAt time.Time `json:"decidedAt"`

	// FromAgentSpace The agent space the session ran in before this decision. Absent when the session had no recorded agent space.
	FromAgentSpace *string            `json:"fromAgentSpace,omitempty"`
	Id             openapi_types.UUID `json:"id"`
	Reason         string             `json:"reason"`
	SessionId      openapi_types.UUID `json:"sessionId"`
	ToAgentSpace   string             `json:"toAgentSpace"`
}

SessionAgentSpaceDecision defines model for SessionAgentSpaceDecision.

type SessionAgentSpaceDecisionPage added in v0.19.0

type SessionAgentSpaceDecisionPage struct {
	HasMore bool                        `json:"hasMore"`
	Items   []SessionAgentSpaceDecision `json:"items"`
	Limit   int32                       `json:"limit"`
	Offset  int32                       `json:"offset"`
}

SessionAgentSpaceDecisionPage defines model for SessionAgentSpaceDecisionPage.

type SessionIDRequired

type SessionIDRequired = openapi_types.UUID

SessionIDRequired defines model for SessionIDRequired.

type SessionNotice added in v0.4.0

type SessionNotice struct {
	CreatedAt time.Time               `json:"createdAt"`
	Data      *map[string]interface{} `json:"data,omitempty"`
	Delivery  SessionNoticeDelivery   `json:"delivery"`
	Id        openapi_types.UUID      `json:"id"`
	Source    string                  `json:"source"`
	Summary   string                  `json:"summary"`
	Type      string                  `json:"type"`
}

SessionNotice defines model for SessionNotice.

type SessionNoticeDelivery added in v0.4.0

type SessionNoticeDelivery string

SessionNoticeDelivery defines model for SessionNotice.Delivery.

const (
	SessionNoticeDeliveryQueue SessionNoticeDelivery = "queue"
	SessionNoticeDeliveryWake  SessionNoticeDelivery = "wake"
)

Defines values for SessionNoticeDelivery.

func (SessionNoticeDelivery) Valid added in v0.4.0

func (e SessionNoticeDelivery) Valid() bool

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

type SessionNoticePage added in v0.4.0

type SessionNoticePage struct {
	HasMore bool            `json:"hasMore"`
	Limit   int32           `json:"limit"`
	Notices []SessionNotice `json:"notices"`
	Offset  int32           `json:"offset"`
}

SessionNoticePage defines model for SessionNoticePage.

type SessionNoticeRequest added in v0.4.0

type SessionNoticeRequest struct {
	// Data Structured payload for programmatic consumers.
	Data *map[string]interface{} `json:"data,omitempty"`

	// Delivery queue waits for the next turn. wake starts a turn when the session is idle and .agents/events declares a handler for this type.
	Delivery *SessionNoticeRequestDelivery `json:"delivery,omitempty"`

	// Summary The one line describing what happened.
	Summary string `json:"summary"`

	// Type Dotted lowercase namespaced type. The job., agent., and turn. prefixes are reserved for Peen's own producers and are rejected here.
	Type string `json:"type"`
}

SessionNoticeRequest defines model for SessionNoticeRequest.

type SessionNoticeRequestDelivery added in v0.4.0

type SessionNoticeRequestDelivery string

SessionNoticeRequestDelivery queue waits for the next turn. wake starts a turn when the session is idle and .agents/events declares a handler for this type.

const (
	SessionNoticeRequestDeliveryQueue SessionNoticeRequestDelivery = "queue"
	SessionNoticeRequestDeliveryWake  SessionNoticeRequestDelivery = "wake"
)

Defines values for SessionNoticeRequestDelivery.

func (SessionNoticeRequestDelivery) Valid added in v0.4.0

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

type SessionPage added in v0.8.0

type SessionPage struct {
	HasMore bool      `json:"hasMore"`
	Items   []Session `json:"items"`
	Limit   int32     `json:"limit"`
	Offset  int32     `json:"offset"`
}

SessionPage defines model for SessionPage.

type SignalSessionJobJSONRequestBody

type SignalSessionJobJSONRequestBody = JobSignalRequest

SignalSessionJobJSONRequestBody defines body for SignalSessionJob for application/json ContentType.

type SignalSessionJobParams

type SignalSessionJobParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

SignalSessionJobParams defines parameters for SignalSessionJob.

type SignalSessionJobResponse

type SignalSessionJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *JobSignalResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers202 the parsed response headers for an HTTP 202 response
	Headers202 *SignalSessionJobResponse202Headers
}

func ParseSignalSessionJobResponse

func ParseSignalSessionJobResponse(rsp *http.Response) (*SignalSessionJobResponse, error)

ParseSignalSessionJobResponse parses an HTTP response from a SignalSessionJobWithResponse call

func (SignalSessionJobResponse) ContentType

func (r SignalSessionJobResponse) ContentType() string

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

func (SignalSessionJobResponse) GetBody

func (r SignalSessionJobResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SignalSessionJobResponse) GetJSON202

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

func (SignalSessionJobResponse) GetJSON400

func (r SignalSessionJobResponse) GetJSON400() *ErrorBadRequest

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

func (SignalSessionJobResponse) GetJSON401

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

func (SignalSessionJobResponse) GetJSON404

func (r SignalSessionJobResponse) GetJSON404() *ErrorNotFound

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

func (SignalSessionJobResponse) GetJSON500

func (r SignalSessionJobResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (SignalSessionJobResponse) Status

func (r SignalSessionJobResponse) Status() string

Status returns HTTPResponse.Status

func (SignalSessionJobResponse) StatusCode

func (r SignalSessionJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SignalSessionJobResponse202Headers

type SignalSessionJobResponse202Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

SignalSessionJobResponse202Headers the declared response headers of an HTTP 202 response for SignalSessionJob

type TranscriptEvent added in v0.4.0

type TranscriptEvent struct {
	CreatedAt        time.Time              `json:"createdAt"`
	Id               openapi_types.UUID     `json:"id"`
	ParentToolCallId *string                `json:"parentToolCallId,omitempty"`
	Payload          map[string]interface{} `json:"payload"`
	RequestId        openapi_types.UUID     `json:"requestId"`
	Sequence         int64                  `json:"sequence"`
	SessionId        openapi_types.UUID     `json:"sessionId"`
	TurnId           openapi_types.UUID     `json:"turnId"`
	Type             string                 `json:"type"`

	// WorkerGenerationId Worker generation that produced this event, if started.
	WorkerGenerationId *string `json:"workerGenerationId,omitempty"`
}

TranscriptEvent defines model for TranscriptEvent.

type TranscriptEventPage added in v0.4.0

type TranscriptEventPage struct {
	Events  []TranscriptEvent `json:"events"`
	HasMore bool              `json:"hasMore"`
	Limit   int32             `json:"limit"`
	Offset  int32             `json:"offset"`
}

TranscriptEventPage defines model for TranscriptEventPage.

type Turn added in v0.4.0

type Turn struct {
	CancelRequested       bool               `json:"cancelRequested"`
	CompletedAt           *time.Time         `json:"completedAt,omitempty"`
	ContextSnapshotHash   *string            `json:"contextSnapshotHash,omitempty"`
	FailureClassification string             `json:"failureClassification"`
	Id                    openapi_types.UUID `json:"id"`
	PromptSnapshotHash    *string            `json:"promptSnapshotHash,omitempty"`
	RequestId             openapi_types.UUID `json:"requestId"`
	SessionId             openapi_types.UUID `json:"sessionId"`
	StartedAt             time.Time          `json:"startedAt"`
	State                 TurnState          `json:"state"`
	Workspace             string             `json:"workspace"`
}

Turn defines model for Turn.

type TurnPage added in v0.4.0

type TurnPage struct {
	HasMore bool   `json:"hasMore"`
	Limit   int32  `json:"limit"`
	Offset  int32  `json:"offset"`
	Turns   []Turn `json:"turns"`
}

TurnPage defines model for TurnPage.

type TurnState added in v0.4.0

type TurnState string

TurnState defines model for Turn.State.

const (
	TurnStateCancelled   TurnState = "cancelled"
	TurnStateCompleted   TurnState = "completed"
	TurnStateFailed      TurnState = "failed"
	TurnStateInterrupted TurnState = "interrupted"
	TurnStateRunning     TurnState = "running"
)

Defines values for TurnState.

func (TurnState) Valid added in v0.4.0

func (e TurnState) Valid() bool

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

type WorkerGeneration added in v0.8.0

type WorkerGeneration struct {
	AgentSpace         string `json:"agentSpace"`
	AgentSpaceRevision int64  `json:"agentSpaceRevision"`

	// ContainerId Set only for a Docker generation.
	ContainerId *string    `json:"containerId,omitempty"`
	CreatedAt   time.Time  `json:"createdAt"`
	EndedAt     *time.Time `json:"endedAt,omitempty"`

	// FailureDetail Why a generation failed or was replaced. Never carries credentials.
	FailureDetail *string            `json:"failureDetail,omitempty"`
	Id            openapi_types.UUID `json:"id"`

	// ImageDigest Immutable image identity for a Docker generation, never a moving tag.
	ImageDigest *string               `json:"imageDigest,omitempty"`
	Kind        WorkerGenerationKind  `json:"kind"`
	SessionId   openapi_types.UUID    `json:"sessionId"`
	StartedAt   *time.Time            `json:"startedAt,omitempty"`
	State       WorkerGenerationState `json:"state"`
	Workspace   string                `json:"workspace"`
}

WorkerGeneration defines model for WorkerGeneration.

type WorkerGenerationKind added in v0.8.0

type WorkerGenerationKind string

WorkerGenerationKind defines model for WorkerGeneration.Kind.

const (
	WorkerGenerationKindControl WorkerGenerationKind = "control"
	WorkerGenerationKindDocker  WorkerGenerationKind = "docker"
)

Defines values for WorkerGenerationKind.

func (WorkerGenerationKind) Valid added in v0.8.0

func (e WorkerGenerationKind) Valid() bool

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

type WorkerGenerationPage added in v0.8.0

type WorkerGenerationPage struct {
	HasMore bool               `json:"hasMore"`
	Items   []WorkerGeneration `json:"items"`
	Limit   int32              `json:"limit"`
	Offset  int32              `json:"offset"`
}

WorkerGenerationPage defines model for WorkerGenerationPage.

type WorkerGenerationState added in v0.8.0

type WorkerGenerationState string

WorkerGenerationState defines model for WorkerGeneration.State.

const (
	WorkerGenerationStateFailed    WorkerGenerationState = "failed"
	WorkerGenerationStateReady     WorkerGenerationState = "ready"
	WorkerGenerationStateRequested WorkerGenerationState = "requested"
	WorkerGenerationStateStarting  WorkerGenerationState = "starting"
	WorkerGenerationStateStopped   WorkerGenerationState = "stopped"
	WorkerGenerationStateStopping  WorkerGenerationState = "stopping"
)

Defines values for WorkerGenerationState.

func (WorkerGenerationState) Valid added in v0.8.0

func (e WorkerGenerationState) Valid() bool

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

type WorkspaceRootList added in v0.13.0

type WorkspaceRootList struct {
	// Roots Canonical absolute directories the authenticated controller will accept as workspace roots.
	Roots []string `json:"roots"`
}

WorkspaceRootList defines model for WorkspaceRootList.

Jump to

Keyboard shortcuts

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