bma

package module
v1.0.1 Latest Latest
Warning

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

 Go to latest Published: Nov 6, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

README

bma-sdk

Go, TypeScript and Python SDKs for the BMA (BeeOS Managed Agents) API, generated from the BMA contracts in contracts/bma/: typed clients for the native REST API (rest.openapi.yaml) and the BMA extensions to the Anthropic Managed Agents façade (facade-extensions.openapi.yaml).

Moved from beeos-ai/bma-sdks (archived) in 0.4.2. The Go import path changed from github.com/beeos-ai/bma-sdk/... to github.com/beeos-ai/bma-sdk/...; the npm and PyPI package names are unchanged. The Executor Protocol SDK (executor, harness and agent ends) is beeos-ai/bma-executor-sdk.

Versions and installation

Language Package Install
Go Go Reference github.com/beeos-ai/bma-sdk go get github.com/beeos-ai/bma-sdk@v1.0.1
TypeScript npm @beeos-ai/bma-sdk npm install @beeos-ai/bma-sdk@1.0.1
Python PyPI bma-sdk pip install bma-sdk==1.0.1
Compatibility bma-sdk 1.0.1 (tag v1.0.1, all three languages)
BMA contract REST and façade at BMA commit db2403f9 (contracts/bma/lock.json)
Protocol BMA REST /api/v1 and the Anthropic Managed Agents façade extensions
Runtimes Go 1.24+, Node.js 20+ (ESM), Python 3.10+

Release notes: CHANGELOG and GitHub Releases.

Packages

SDK Package Purpose
Go github.com/beeos-ai/bma-sdk (package bma), options in .../option Native REST client: bma.NewClient(...) with resources such as client.Agents.Sessions.New.
Go github.com/beeos-ai/bma-sdk/facade BMA extensions to the Anthropic facade (session files, resources, desktop stream) and EventBMASequence.
TypeScript @beeos-ai/bma-sdk BmaClient (.) and FacadeExtensionsClient (./facade-extensions).
Python bma-sdk Bma / AsyncBma, bma_sdk.types, bma_sdk.facade_extensions.

All three are resource-style clients (ADR 0012): methods are named in contracts/bma/sdk.resources.yaml, path IDs are positional, query/header/body fields form one params value; the organization and project are client defaults (BMA_ORG_ID, BMA_PROJECT_ID) that one call can override, and the token and base URL default to BMA_TOKEN and BMA_BASE_URL. Every SDK retries reads and calls that accept an Idempotency-Key (408/429/5xx and connection errors, with a generated key reused across attempts), other writes only on 429/503 and requests that never reached the server, never 409, and never a body it cannot replay; defaults are 2 retries and a 60 s timeout per attempt until the response arrives (uploads are not cut off while sending; 0 / None disables the timeout). Every {data, next_<param>} list pages automatically; the event stream yields frames discriminated by their SSE event name and, like EventSource, reconnects from the last durable frame when the connection drops, the server ends the response or sends service_unavailable; errors carry the HTTP status and the contract's ErrorCode. See MIGRATION.md for 0.4 code.

The standard Anthropic facade routes (/v1/agents, /v1/environments, /v1/sessions, events, events/stream, /v1/memory_stores) are intentionally not wrapped: use the official Anthropic SDKs with base_url set to the BMA facade, and these packages only for what BMA adds.

REST quick start

Set BMA_BASE_URL to the origin of your deployment, for example https://api.staging.bma.beeos.ai (the default https://api.bma.beeos.ai does not resolve yet), BMA_TOKEN, BMA_ORG_ID and BMA_PROJECT_ID, or pass them as options. Like ANTHROPIC_BASE_URL, the base URL is an origin: the native client adds /api/v1 and the facade extensions /v1 (a value already ending in /api/v1 is accepted, not doubled).

Go:

client := bma.NewClient() // or option.WithBaseURL, WithToken, WithOrg, WithProject
created, err := client.Agents.Sessions.New(ctx, agentID, bma.AgentSessionNewParams{IdempotencyKey: bma.Ptr("task-1")})
if err != nil {
	log.Fatal(err)
}
_, err = client.Agents.Inputs.New(ctx, agentID, bma.AgentInputNewParams{
	SessionID:     bma.Ptr(created.Session.ID),
	ContentBlocks: []bma.CreateAgentInputContentBlock{bma.NewTextInputBlock("Start the task.")},
})
if err != nil {
	log.Fatal(err)
}
stream := client.Agents.Events.Stream(ctx, agentID, bma.AgentEventStreamParams{SessionID: bma.Ptr(created.Session.ID)})
defer stream.Close()
for stream.Next() {
	switch ev := stream.Current().AsAny().(type) {
	case bma.ModelOutputEvent:
		log.Printf("model output %d", ev.Sequence)
	case bma.ToolCallUpdate:
		log.Printf("tool call %s is %s", ev.ToolCallID, ev.State)
	}
}
var apiErr *bma.Error
if err := stream.Err(); errors.As(err, &apiErr) {
	log.Printf("%d %s", apiErr.StatusCode, apiErr.Code)
}

pager := client.Agents.ListAutoPaging(ctx, bma.AgentListParams{})
for pager.Next() {
	log.Println(pager.Current().ID)
}

TypeScript:

const bma = new BmaClient(); // or { baseUrl, token, orgId, projectId }
const { session } = await bma.agents.sessions.create(agentId, { idempotency_key: "task-1" });
await bma.agents.inputs.create(agentId, { session_id: session.id, content_blocks: [{ type: "text", text: "Start the task." }] });
for await (const ev of bma.agents.events.stream(agentId, { session_id: session.id })) {
  if (ev.event === "model_output") console.log(ev.sequence, ev.data.content_blocks);
}
for await (const agent of bma.agents.list()) console.log(agent.id);

Python:

bma = Bma()  # or Bma(token=, base_url=, org_id=, project_id=)
created = bma.agents.sessions.create(agent_id, idempotency_key="task-1")
bma.agents.inputs.create(agent_id, session_id=created.session.id,
                         content_blocks=[{"type": "text", "text": "Start the task."}])
for ev in bma.agents.events.stream(agent_id, session_id=created.session.id):
    if ev.event == "model_output":
        print(ev.sequence, ev.data.content_blocks)
for agent in bma.agents.list():
    print(agent.id)
Files: upload, mount, outputs

A project file is uploaded once and mounted into sessions by reference. The machine executor mirrors the mounts below /mnt/session/uploads (read-only) and uploads what the agent writes to /mnt/session/outputs back into the session's scope, so listing files with scope_id=<session> returns the session's outputs.

file, err := client.Files.Upload(ctx, bma.FileUploadParams{Filename: "report.pdf", Body: reader})
mounted, err := client.Agents.Sessions.Resources.Add(ctx, agentID, sessionID, bma.AgentSessionResourceAddParams{
	Type: bma.FileResourceParamsTypeFile, FileID: file.ID, MountPath: bma.Ptr("/mnt/session/uploads/reports/report.pdf"),
})
outputs, err := client.Files.List(ctx, bma.FileListParams{ScopeID: bma.Ptr(sessionID)})

const file = await bma.files.upload({ filename: "report.pdf", body: await readFile("report.pdf") });
await bma.agents.sessions.resources.add(agentId, sessionId, { type: "file", file_id: file.id, mount_path: "/mnt/session/uploads/reports/report.pdf" });
const outputs = await bma.files.list({ scope_id: sessionId });

file = bma.files.upload(filename="report.pdf", body=Path("report.pdf").read_bytes())
bma.agents.sessions.resources.add(agent_id, session_id, type="file", file_id=file.id,
                                  mount_path="/mnt/session/uploads/reports/report.pdf")
outputs = bma.files.list(scope_id=session_id)

Artifacts the agent produces are downloaded with client.Agents.Artifacts.DownloadVerified / bma.agents.artifacts.downloadVerified / bma.agents.artifacts.download_verified, which verify the recorded size and sha256; download returns the raw content.

Development

./tools/generate.sh                                  # regenerate Go, TypeScript and Python
uv run --no-project --with pyyaml --with jsonschema \
  python tools/check_contract.py [--source ../beeos-managed-agents]
go vet ./... && go test -race ./...
(cd typescript && npm ci && npm run build && npm test)
(cd python && uv run pytest -q && uv run pyright)

tools/generate.sh needs Python 3 with PyYAML, Go 1.24+, Node 20+ and uv; it pins oapi-codegen v2.7.0 (Go models), openapi-typescript 7.13.0 (TypeScript types) and ruff (formatting of the Python output); the resource layers and the Python models come from tools/sdkgen. Never edit generated files by hand. The SDK tests of all three languages replay the same recorded exchanges in contracts/bma/fixtures/sdk-contract.json, which tools/check_contract.py validates against the contracts. See contracts/bma/README.md for refreshing the contract.

go test -run TestStagingSmoke . runs the staging smoke (creates an agent with a custom tool, answers it with the tool runner, archives the agent) when BMA_BASE_URL, BMA_ORG_API_KEY, BMA_ORG_ID and BMA_PROJECT_ID are set; otherwise it is skipped.

Release

One tag v<version> releases all three languages at the same version: it must be on main, and tools/check_versions.sh checks it against typescript/package.json, python/pyproject.toml (the Python client reads its version from the installed metadata) and the User-Agent constants typescript/src/version.ts and client.go (CI runs the same check without a tag). release.yaml first runs ci.yaml (regenerate every SDK with no diff, contract drift check, Go, TypeScript and Python tests), then publishes.

Channel Publishes Credentials
Go nothing; the module comes from the tag none
npm @beeos-ai/bma-sdk with provenance secret NPM_TOKEN in the releases environment
PyPI bma-sdk a PyPI Trusted Publisher on bma-sdk: owner beeos-ai, repository bma-sdk, workflow release.yaml, environment releases

License

Apache License 2.0. See LICENSE and NOTICE.

Documentation

Overview

Package bma is the Go client for the BMA REST API (ADR 0012): 

client := bma.NewClient() // BMA_TOKEN, BMA_BASE_URL, BMA_ORG_ID, BMA_PROJECT_ID
client := bma.NewClient(option.WithToken(token), option.WithBaseURL(base),
	option.WithOrg(org), option.WithProject(project))
created, err := client.Agents.Sessions.New(ctx, agentID, bma.AgentSessionNewParams{IdempotencyKey: bma.Ptr("task-1")})

Models are generated by oapi-codegen and services by tools/sdkgen from contracts/bma/rest.openapi.yaml and contracts/bma/sdk.resources.yaml. Errors are *bma.Error (use errors.As); ErrorCode constants name the contract's codes. Lists return a CursorPage and have a ...AutoPaging variant; events.Stream returns a Stream whose frames switch on AsAny().

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

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

Index

Constants

View Source 
const (
	// DefaultBaseURL is the hosted BMA origin; the client adds /api/v1.
	DefaultBaseURL = "https://api.bma.beeos.ai"
	// SDKVersion is the version of this module; tools/check_versions.sh keeps
	// it equal to the package manifests and the release tag.
	SDKVersion = "1.0.1"
)
View Source 
const (
	BearerAuthScopes           bearerAuthContextKey           = "bearerAuth.Scopes"
	BrowserSessionCookieScopes browserSessionCookieContextKey = "browserSessionCookie.Scopes"
	CsrfHeaderScopes           csrfHeaderContextKey           = "csrfHeader.Scopes"
	MachineDaemonAuthScopes    machineDaemonAuthContextKey    = "machineDaemonAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewFile 

func NewFile(r io.Reader, filename string) io.Reader

NewFile names a reader for a multipart file field; the name is sent as the part's filename (an *os.File is named already).

func NewFileWithContentType 

func NewFileWithContentType(r io.Reader, filename, contentType string) io.Reader

NewFileWithContentType is NewFile with an explicit part content type.

func Ptr 

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

Ptr returns a pointer to v, for optional fields.

func ToolError 

func ToolError(text string) error

ToolError returns an error that reports text to the model as a failed call.

Types

type AWSCredentialsSecretMaterial 

type AWSCredentialsSecretMaterial struct {
	AccessKeyID string `json:"access_key_id"`

	// ExternalID Requires role_arn.
	ExternalID      *string                          `json:"external_id,omitempty"`
	Kind            AWSCredentialsSecretMaterialKind `json:"kind"`
	RoleArn         *string                          `json:"role_arn,omitempty"`
	SecretAccessKey string                           `json:"secret_access_key"`
	SessionToken    *string                          `json:"session_token,omitempty"`
}

AWSCredentialsSecretMaterial defines model for AWSCredentialsSecretMaterial.

type AWSCredentialsSecretMaterialKind 

type AWSCredentialsSecretMaterialKind string

AWSCredentialsSecretMaterialKind defines model for AWSCredentialsSecretMaterial.Kind. 

const (
	AwsCredentials AWSCredentialsSecretMaterialKind = "aws_credentials"
)

Defines values for AWSCredentialsSecretMaterialKind.

func (AWSCredentialsSecretMaterialKind) Valid 

func (e AWSCredentialsSecretMaterialKind) Valid() bool

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

type AcquireDesktopControlJSONRequestBody 

type AcquireDesktopControlJSONRequestBody = DesktopControlLeaseRequest

AcquireDesktopControlJSONRequestBody defines body for AcquireDesktopControl for application/json ContentType.

type Actor 

type Actor struct {
	CreatedAt   Timestamp `json:"created_at"`
	DisplayName *string   `json:"display_name,omitempty"`
	ID          ActorID   `json:"id"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata Metadata       `json:"metadata"`
	OrgID    OrganizationID `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// Provider bma for BMA identities, integration for hosted integration senders, or external for API-managed actors.
	Provider ActorProvider `json:"provider"`

	// ProviderTenantID Project-scoped identity namespace. Integration actors use a stable platform namespace (slack:<workspace ID>, discord, or github:github.com), shared across configured bots and integration kinds on that platform. Retained for attribution after integration deletion; not an authorization principal.
	ProviderTenantID *string `json:"provider_tenant_id,omitempty"`

	// ProviderUserID Stable sender identifier within the actor identity namespace.
	ProviderUserID string    `json:"provider_user_id"`
	UpdatedAt      Timestamp `json:"updated_at"`
}

Actor defines model for Actor.

type ActorID 

type ActorID = string

ActorID defines model for ActorID.

type ActorListParams 

type ActorListParams struct {
	Provider         *ActorProvider
	ProviderTenantID *string
	ProviderUserID   *string
	Limit            *PageLimit
	Cursor           *PageCursor
}

ActorListParams are the query, header and body fields of listActors.

type ActorProvider 

type ActorProvider string

ActorProvider bma for BMA identities, integration for hosted integration senders, or external for API-managed actors. 

const (
	ActorProviderBMA         ActorProvider = "bma"
	ActorProviderExternal    ActorProvider = "external"
	ActorProviderIntegration ActorProvider = "integration"
)

Defines values for ActorProvider.

func (ActorProvider) Valid 

func (e ActorProvider) Valid() bool

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

type ActorService 

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

ActorService groups the actors methods.

func (*ActorService) Get 

func (s *ActorService) Get(ctx context.Context, actorID string, opts ...option.RequestOption) (*Actor, error)

Get calls getActor: GET /orgs/{orgID}/projects/{projectID}/actors/{actorID}.

func (*ActorService) List 

func (s *ActorService) List(ctx context.Context, params ActorListParams, opts ...option.RequestOption) (*CursorPage[Actor], error)

List calls listActors: GET /orgs/{orgID}/projects/{projectID}/actors.

func (*ActorService) ListAutoPaging 

func (s *ActorService) ListAutoPaging(ctx context.Context, params ActorListParams, opts ...option.RequestOption) *CursorPageAutoPager[Actor]

ListAutoPaging iterates every item of listActors across pages.

func (*ActorService) Upsert 

func (s *ActorService) Upsert(ctx context.Context, params ActorUpsertParams, opts ...option.RequestOption) (*Actor, error)

Upsert calls putActor: PUT /orgs/{orgID}/projects/{projectID}/actors.

type ActorUpsertParams 

type ActorUpsertParams struct {
	DisplayName      *string
	Metadata         *Metadata
	ProviderTenantID *string
	ProviderUserID   string
}

ActorUpsertParams are the query, header and body fields of putActor.

type AddSessionResourceJSONRequestBody 

type AddSessionResourceJSONRequestBody = FileResourceParams

AddSessionResourceJSONRequestBody defines body for AddSessionResource for application/json ContentType.

type Agent 

type Agent struct {
	Activity       *AgentActivity  `json:"activity,omitempty"`
	AgentProfileID *AgentProfileID `json:"agent_profile_id,omitempty"`
	ArchivedAt     *Timestamp      `json:"archived_at,omitempty"`
	CreatedAt      Timestamp       `json:"created_at"`

	// CurrentConfigID Agent config ID (acfg_...).
	CurrentConfigID   *AgentConfigID     `json:"current_config_id,omitempty"`
	ID                AgentID            `json:"id"`
	IntegrationTarget *IntegrationTarget `json:"integration_target,omitempty"`
	Model             *AgentModel        `json:"model,omitempty"`

	// Name Agent name. Empty means the agent is unnamed; non-empty values use the ResourceName policy.
	Name          AgentName      `json:"name"`
	OrgID         OrganizationID `json:"org_id"`
	ParentAgentID *AgentID       `json:"parent_agent_id,omitempty"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID  `json:"project_id"`
	State     AgentState `json:"state"`

	// SubagentKey The `subagents` key this agent was spawned from.
	SubagentKey *string      `json:"subagent_key,omitempty"`
	UpdatedAt   Timestamp    `json:"updated_at"`
	Usage       *UsageTotals `json:"usage,omitempty"`
}

Agent defines model for Agent.

type AgentActivity 

type AgentActivity struct {
	LastActivityAt Timestamp `json:"last_activity_at"`

	// State running while the agent has work in progress, which includes a custom tool call awaiting its result; waiting_on_interaction while it has an open question or permission request; idle otherwise; and archived once the agent is archived.
	State AgentActivityState `json:"state"`
}

AgentActivity defines model for AgentActivity.

type AgentActivityState 

type AgentActivityState string

AgentActivityState running while the agent has work in progress, which includes a custom tool call awaiting its result; waiting_on_interaction while it has an open question or permission request; idle otherwise; and archived once the agent is archived. 

const (
	AgentActivityStateArchived             AgentActivityState = "archived"
	AgentActivityStateIdle                 AgentActivityState = "idle"
	AgentActivityStateRunning              AgentActivityState = "running"
	AgentActivityStateWaitingOnInteraction AgentActivityState = "waiting_on_interaction"
)

Defines values for AgentActivityState.

func (AgentActivityState) Valid 

func (e AgentActivityState) Valid() bool

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

type AgentArtifactService 

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

AgentArtifactService groups the agents.artifacts methods.

func (*AgentArtifactService) Download 

func (s *AgentArtifactService) Download(ctx context.Context, agentID string, artifactID string, opts ...option.RequestOption) (*http.Response, error)

Download calls getArtifactContent: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/artifacts/{artifactID}/content. The caller closes the response body.

func (*AgentArtifactService) DownloadVerified 

func (s *AgentArtifactService) DownloadVerified(ctx context.Context, artifact Artifact, maxBytes int64, w io.Writer, opts ...option.RequestOption) error

DownloadVerified writes artifact content to w after checking it against the size and sha256 digest recorded on the artifact. Content larger than maxBytes, or than the recorded size, is refused. w receives the bytes as they arrive; on error discard what was written.

func (*AgentArtifactService) Get 

func (s *AgentArtifactService) Get(ctx context.Context, agentID string, artifactID string, opts ...option.RequestOption) (*Artifact, error)

Get calls getArtifact: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/artifacts/{artifactID}.

type AgentCancelParams 

type AgentCancelParams struct {
	Actor *ExternalActorParams
}

AgentCancelParams are the query, header and body fields of cancelAgent.

type AgentConfig 

type AgentConfig struct {
	// CompiledDefinition Read-only saved compiled configuration, including default tools and derived subagent overrides.
	CompiledDefinition      CompiledAgentConfig `json:"compiled_definition"`
	CreatedAt               Timestamp           `json:"created_at"`
	EffectiveDefinitionHash string              `json:"effective_definition_hash"`

	// ID Agent config ID (acfg_...).
	ID              AgentConfigID    `json:"id"`
	InstructionHash *string          `json:"instruction_hash,omitempty"`
	Model           AgentConfigModel `json:"model"`
	OrgID           OrganizationID   `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// Source Saved source text. YAML sources keep their original text; JSON sources are stored canonicalized.
	Source       *string                  `json:"source,omitempty"`
	SourceFormat *AgentConfigSourceFormat `json:"source_format,omitempty"`
}

AgentConfig defines model for AgentConfig.

type AgentConfigDefinition 

type AgentConfigDefinition struct {
	// GitCredentials Integration whose git credentials the agent's machines use.
	GitCredentials *AgentConfigDefinitionGitCredentials `json:"git_credentials,omitempty"`

	// Harness Experimental. Which brain runs the agent's sessions: what it is, not where it runs. Omitted, or kind bma, is the BMA harness, which always runs on the server. Kind acp runs an Agent Client Protocol agent (agent dsh) on the session's machine and requires machine_sources; where it runs follows the session's machine sources (a machine pool is a sandbox, a BYO machine is local).
	Harness     *AgentConfigDefinitionHarness `json:"harness,omitempty"`
	Instruction string                        `json:"instruction"`

	// InteractionHandlers Interaction handlers keyed by integration name.
	InteractionHandlers *AgentConfigDefinitionInteractionHandlers `json:"interaction_handlers,omitempty"`
	MachineSources      *AgentConfigDefinitionMachineSources      `json:"machine_sources,omitempty"`
	MaxDepth            *int                                      `json:"max_depth,omitempty"`
	MaxSubagents        *int                                      `json:"max_subagents,omitempty"`
	Mcp                 *AgentConfigDefinitionMCPServers          `json:"mcp,omitempty"`
	MemoryStores        *AgentConfigDefinitionMemoryStores        `json:"memory_stores,omitempty"`
	Model               AgentConfigDefinitionModel                `json:"model"`
	Skills              *AgentConfigDefinitionSkills              `json:"skills,omitempty"`
	Subagents           *AgentConfigDefinitionSubagents           `json:"subagents,omitempty"`
	Tools               *AgentConfigDefinitionTools               `json:"tools,omitempty"`
	Version             interface{}                               `json:"version,omitempty"`
}

AgentConfigDefinition An agent config as a JSON object. This schema is the source of truth for agent configs: the server compiles YAML and JSON configs against it.

type AgentConfigDefinitionGitCredentials 

type AgentConfigDefinitionGitCredentials struct {
	Integration string `json:"integration"`

	// ReadOnly Prevents pushing, even if the integration allows it.
	ReadOnly *bool `json:"read_only,omitempty"`

	// RepositoryIDs GitHub repository IDs the credentials can access. Defaults to every repository the installation can access.
	RepositoryIDs *[]int `json:"repository_ids,omitempty"`
}

AgentConfigDefinitionGitCredentials Integration whose git credentials the agent's machines use.

type AgentConfigDefinitionHarness 

type AgentConfigDefinitionHarness struct {
	Agent *string     `json:"agent,omitempty"`
	Kind  interface{} `json:"kind"`
}

AgentConfigDefinitionHarness Experimental. Which brain runs the agent's sessions: what it is, not where it runs. Omitted, or kind bma, is the BMA harness, which always runs on the server. Kind acp runs an Agent Client Protocol agent (agent dsh) on the session's machine and requires machine_sources; where it runs follows the session's machine sources (a machine pool is a sandbox, a BYO machine is local).

type AgentConfigDefinitionInteractionHandler 

type AgentConfigDefinitionInteractionHandler = map[string]interface{}

AgentConfigDefinitionInteractionHandler Enables an integration's interaction handler. Takes no settings.

type AgentConfigDefinitionInteractionHandlers 

type AgentConfigDefinitionInteractionHandlers map[string]AgentConfigDefinitionInteractionHandler

AgentConfigDefinitionInteractionHandlers Interaction handlers keyed by integration name.

type AgentConfigDefinitionMCPAuth 

type AgentConfigDefinitionMCPAuth struct {
	Region   *string     `json:"region,omitempty"`
	SecretID string      `json:"secret_id"`
	Service  *string     `json:"service,omitempty"`
	Type     interface{} `json:"type"`
}

AgentConfigDefinitionMCPAuth defines model for AgentConfigDefinitionMCPAuth.

type AgentConfigDefinitionMCPServer 

type AgentConfigDefinitionMCPServer struct {
	Auth *AgentConfigDefinitionMCPAuth `json:"auth,omitempty"`

	// ConnectionOrigin Who connects an MCP server. `environment` means the executor starts or connects it in its own credential scope; `service` means the harness connects it and keeps its credentials.
	ConnectionOrigin *MCPConnectionOrigin                     `json:"connection_origin,omitempty"`
	DefaultEnabled   *bool                                    `json:"default_enabled,omitempty"`
	Deferred         *bool                                    `json:"deferred,omitempty"`
	Permission       *AgentConfigDefinitionToolPermission     `json:"permission,omitempty"`
	Tools            *map[string]AgentConfigDefinitionMCPTool `json:"tools,omitempty"`

	// Transport Transport of an environment-origin MCP server. stdio requires `command`; http requires `url`. No shell is involved: `command` is one executable token. `env` values that name a secret stay references; the executor resolves them in its own credential scope.
	Transport *AgentConfigDefinitionMCPTransport `json:"transport,omitempty"`
	URL       *string                            `json:"url,omitempty"`
}

AgentConfigDefinitionMCPServer defines model for AgentConfigDefinitionMCPServer.

type AgentConfigDefinitionMCPServers 

type AgentConfigDefinitionMCPServers map[string]AgentConfigDefinitionMCPServer

AgentConfigDefinitionMCPServers defines model for AgentConfigDefinitionMCPServers.

type AgentConfigDefinitionMCPTool 

type AgentConfigDefinitionMCPTool struct {
	Deferred   *bool                                `json:"deferred,omitempty"`
	Enabled    *bool                                `json:"enabled,omitempty"`
	Permission *AgentConfigDefinitionToolPermission `json:"permission,omitempty"`
}

AgentConfigDefinitionMCPTool defines model for AgentConfigDefinitionMCPTool.

type AgentConfigDefinitionMCPTransport 

type AgentConfigDefinitionMCPTransport struct {
	Args          *[]string          `json:"args,omitempty"`
	Command       *string            `json:"command,omitempty"`
	CommandSha256 *string            `json:"command_sha256,omitempty"`
	Cwd           *string            `json:"cwd,omitempty"`
	Env           *map[string]string `json:"env,omitempty"`
	TimeoutMs     *int               `json:"timeout_ms,omitempty"`

	// Type Transport of an MCP server.
	Type MCPTransportType `json:"type"`
	URL  *string          `json:"url,omitempty"`
}

AgentConfigDefinitionMCPTransport Transport of an environment-origin MCP server. stdio requires `command`; http requires `url`. No shell is involved: `command` is one executable token. `env` values that name a secret stay references; the executor resolves them in its own credential scope.

type AgentConfigDefinitionMachineSource 

type AgentConfigDefinitionMachineSource struct {
	Cwd                    *string                                                    `json:"cwd,omitempty"`
	DeleteAfterIdleMinutes *AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes `json:"delete_after_idle_minutes,omitempty"`
	Description            *string                                                    `json:"description,omitempty"`
	EnvOverlay             *map[string]*string                                        `json:"env_overlay,omitempty"`
	InitialNumMachines     *int                                                       `json:"initial_num_machines,omitempty"`
	MachineCPU             *int                                                       `json:"machine_cpu,omitempty"`
	MachineMemoryMb        *int                                                       `json:"machine_memory_mb,omitempty"`

	// MachineName Name of an existing resource, resolved when the config is compiled.
	MachineName *ResourceNameReference `json:"machine_name,omitempty"`

	// MachinePoolName Name of an existing resource, resolved when the config is compiled.
	MachinePoolName               *ResourceNameReference  `json:"machine_pool_name,omitempty"`
	MachineProviderOptionsOverlay *map[string]interface{} `json:"machine_provider_options_overlay,omitempty"`
	MaxMachines                   *int                    `json:"max_machines,omitempty"`
	SecretEnvOverlay              *map[string]*string     `json:"secret_env_overlay,omitempty"`
	// contains filtered or unexported fields
}

AgentConfigDefinitionMachineSource defines model for AgentConfigDefinitionMachineSource.

func (AgentConfigDefinitionMachineSource) AsAgentConfigDefinitionMachineSource0 

func (t AgentConfigDefinitionMachineSource) AsAgentConfigDefinitionMachineSource0() (AgentConfigDefinitionMachineSource0, error)

AsAgentConfigDefinitionMachineSource0 returns the union data inside the AgentConfigDefinitionMachineSource as a AgentConfigDefinitionMachineSource0

func (AgentConfigDefinitionMachineSource) AsAgentConfigDefinitionMachineSource1 

func (t AgentConfigDefinitionMachineSource) AsAgentConfigDefinitionMachineSource1() (AgentConfigDefinitionMachineSource1, error)

AsAgentConfigDefinitionMachineSource1 returns the union data inside the AgentConfigDefinitionMachineSource as a AgentConfigDefinitionMachineSource1

func (*AgentConfigDefinitionMachineSource) FromAgentConfigDefinitionMachineSource0 

func (t *AgentConfigDefinitionMachineSource) FromAgentConfigDefinitionMachineSource0(v AgentConfigDefinitionMachineSource0) error

FromAgentConfigDefinitionMachineSource0 overwrites any union data inside the AgentConfigDefinitionMachineSource as the provided AgentConfigDefinitionMachineSource0

func (*AgentConfigDefinitionMachineSource) FromAgentConfigDefinitionMachineSource1 

func (t *AgentConfigDefinitionMachineSource) FromAgentConfigDefinitionMachineSource1(v AgentConfigDefinitionMachineSource1) error

FromAgentConfigDefinitionMachineSource1 overwrites any union data inside the AgentConfigDefinitionMachineSource as the provided AgentConfigDefinitionMachineSource1

func (AgentConfigDefinitionMachineSource) MarshalJSON 

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

func (*AgentConfigDefinitionMachineSource) MergeAgentConfigDefinitionMachineSource0 

func (t *AgentConfigDefinitionMachineSource) MergeAgentConfigDefinitionMachineSource0(v AgentConfigDefinitionMachineSource0) error

MergeAgentConfigDefinitionMachineSource0 performs a merge with any union data inside the AgentConfigDefinitionMachineSource, using the provided AgentConfigDefinitionMachineSource0

func (*AgentConfigDefinitionMachineSource) MergeAgentConfigDefinitionMachineSource1 

func (t *AgentConfigDefinitionMachineSource) MergeAgentConfigDefinitionMachineSource1(v AgentConfigDefinitionMachineSource1) error

MergeAgentConfigDefinitionMachineSource1 performs a merge with any union data inside the AgentConfigDefinitionMachineSource, using the provided AgentConfigDefinitionMachineSource1

func (*AgentConfigDefinitionMachineSource) UnmarshalJSON 

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

type AgentConfigDefinitionMachineSource0 

type AgentConfigDefinitionMachineSource0 = map[string]interface{}

AgentConfigDefinitionMachineSource0 defines model for .

type AgentConfigDefinitionMachineSource1 

type AgentConfigDefinitionMachineSource1 = map[string]interface{}

AgentConfigDefinitionMachineSource1 defines model for .

type AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0 

type AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0 = interface{}

AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0 defines model for .

type AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1 

type AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1 = int

AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1 defines model for .

type AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes 

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

AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes defines model for AgentConfigDefinitionMachineSource.DeleteAfterIdleMinutes.

func (AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) AsAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0 

func (t AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) AsAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0() (AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0, error)

AsAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0 returns the union data inside the AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes as a AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0

func (AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) AsAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1 

func (t AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) AsAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1() (AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1, error)

AsAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1 returns the union data inside the AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes as a AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1

func (*AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) FromAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0 

func (t *AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) FromAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0(v AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0) error

FromAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0 overwrites any union data inside the AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes as the provided AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0

func (*AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) FromAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1 

func (t *AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) FromAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1(v AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1) error

FromAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1 overwrites any union data inside the AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes as the provided AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1

func (AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) MarshalJSON 

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

func (*AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) MergeAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0 

func (t *AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) MergeAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0(v AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0) error

MergeAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0 performs a merge with any union data inside the AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes, using the provided AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes0

func (*AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) MergeAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1 

func (t *AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) MergeAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1(v AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1) error

MergeAgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1 performs a merge with any union data inside the AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes, using the provided AgentConfigDefinitionMachineSourceDeleteAfterIdleMinutes1

func (*AgentConfigDefinitionMachineSource_DeleteAfterIdleMinutes) UnmarshalJSON 

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

type AgentConfigDefinitionMachineSources 

type AgentConfigDefinitionMachineSources = []AgentConfigDefinitionMachineSource

AgentConfigDefinitionMachineSources defines model for AgentConfigDefinitionMachineSources.

type AgentConfigDefinitionMemoryStore 

type AgentConfigDefinitionMemoryStore struct {
	Access AgentConfigDefinitionMemoryStoreAccess `json:"access"`

	// Name Machine-readable memory store identifier consisting of lowercase ASCII segments separated by single hyphens.
	Name MemoryStoreName `json:"name"`
}

AgentConfigDefinitionMemoryStore defines model for AgentConfigDefinitionMemoryStore.

type AgentConfigDefinitionMemoryStoreAccess 

type AgentConfigDefinitionMemoryStoreAccess string

AgentConfigDefinitionMemoryStoreAccess defines model for AgentConfigDefinitionMemoryStore.Access. 

const (
	AgentConfigDefinitionMemoryStoreAccessRead      AgentConfigDefinitionMemoryStoreAccess = "read"
	AgentConfigDefinitionMemoryStoreAccessReadWrite AgentConfigDefinitionMemoryStoreAccess = "read_write"
)

Defines values for AgentConfigDefinitionMemoryStoreAccess.

func (AgentConfigDefinitionMemoryStoreAccess) Valid 

func (e AgentConfigDefinitionMemoryStoreAccess) Valid() bool

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

type AgentConfigDefinitionMemoryStores 

type AgentConfigDefinitionMemoryStores = []AgentConfigDefinitionMemoryStore

AgentConfigDefinitionMemoryStores defines model for AgentConfigDefinitionMemoryStores.

type AgentConfigDefinitionModel 

type AgentConfigDefinitionModel struct {
	CacheRetention interface{} `json:"cache_retention,omitempty"`

	// ContextWindowTokens Context budget for input and output tokens. Triggers compaction when estimated input exceeds the remaining budget after output and safety reserves. The turn fails if compaction cannot make it fit.
	ContextWindowTokens    *int `json:"context_window_tokens,omitempty"`
	DefaultMaxOutputTokens *int `json:"default_max_output_tokens,omitempty"`

	// Name Name of an existing resource, resolved when the config is compiled.
	Name ResourceNameReference `json:"name"`

	// ProviderConfig Name of an existing resource, resolved when the config is compiled.
	ProviderConfig ResourceNameReference `json:"provider_config"`
	Reasoning      *struct {
		Effort string `json:"effort"`
	} `json:"reasoning,omitempty"`
}

AgentConfigDefinitionModel defines model for AgentConfigDefinitionModel.

type AgentConfigDefinitionSkills 

type AgentConfigDefinitionSkills = []string

AgentConfigDefinitionSkills defines model for AgentConfigDefinitionSkills.

type AgentConfigDefinitionSubagent 

type AgentConfigDefinitionSubagent struct {
	ArchiveAfterIdleMinutes *int                                      `json:"archive_after_idle_minutes,omitempty"`
	Description             *string                                   `json:"description,omitempty"`
	Instruction             *AgentConfigDefinitionSubagentInstruction `json:"instruction,omitempty"`
	MaxInstances            *int                                      `json:"max_instances,omitempty"`
	Model                   *AgentConfigDefinitionSubagentModel       `json:"model,omitempty"`

	// Profile Name of an existing resource, resolved when the config is compiled.
	Profile *ResourceNameReference `json:"profile,omitempty"`
	Type    interface{}            `json:"type"`
}

AgentConfigDefinitionSubagent defines model for AgentConfigDefinitionSubagent.

type AgentConfigDefinitionSubagentInstruction 

type AgentConfigDefinitionSubagentInstruction struct {
	Append *string `json:"append,omitempty"`
}

AgentConfigDefinitionSubagentInstruction defines model for AgentConfigDefinitionSubagentInstruction.

type AgentConfigDefinitionSubagentModel 

type AgentConfigDefinitionSubagentModel struct {
	CacheRetention interface{} `json:"cache_retention,omitempty"`

	// ContextWindowTokens Context budget for input and output tokens. Triggers compaction when estimated input exceeds the remaining budget after output and safety reserves. The turn fails if compaction cannot make it fit.
	ContextWindowTokens    *int `json:"context_window_tokens,omitempty"`
	DefaultMaxOutputTokens *int `json:"default_max_output_tokens,omitempty"`

	// Name Name of an existing resource, resolved when the config is compiled.
	Name *ResourceNameReference `json:"name,omitempty"`

	// ProviderConfig Name of an existing resource, resolved when the config is compiled.
	ProviderConfig *ResourceNameReference `json:"provider_config,omitempty"`
	Reasoning      *struct {
		Effort string `json:"effort"`
	} `json:"reasoning,omitempty"`
}

AgentConfigDefinitionSubagentModel defines model for AgentConfigDefinitionSubagentModel.

type AgentConfigDefinitionSubagents 

type AgentConfigDefinitionSubagents map[string]AgentConfigDefinitionSubagent

AgentConfigDefinitionSubagents defines model for AgentConfigDefinitionSubagents.

type AgentConfigDefinitionTool 

type AgentConfigDefinitionTool struct {
	Deferred    *bool   `json:"deferred,omitempty"`
	Description *string `json:"description,omitempty"`
	Enabled     *bool   `json:"enabled,omitempty"`

	// InputSchema A JSON Schema for the tool's input. Keywords beyond those listed, such as additionalProperties or description, are allowed.
	InputSchema *AgentConfigDefinitionToolInputSchema `json:"input_schema,omitempty"`
	Permission  *AgentConfigDefinitionToolPermission  `json:"permission,omitempty"`
	Type        interface{}                           `json:"type,omitempty"`
}

AgentConfigDefinitionTool defines model for AgentConfigDefinitionTool.

type AgentConfigDefinitionToolInputSchema 

type AgentConfigDefinitionToolInputSchema struct {
	Properties           *map[string]map[string]interface{} `json:"properties,omitempty"`
	Required             *[]string                          `json:"required,omitempty"`
	Type                 interface{}                        `json:"type"`
	AdditionalProperties map[string]interface{}             `json:"-"`
}

AgentConfigDefinitionToolInputSchema A JSON Schema for the tool's input. Keywords beyond those listed, such as additionalProperties or description, are allowed.

func (AgentConfigDefinitionToolInputSchema) Get 

func (a AgentConfigDefinitionToolInputSchema) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for AgentConfigDefinitionToolInputSchema. Returns the specified element and whether it was found

func (AgentConfigDefinitionToolInputSchema) MarshalJSON 

func (a AgentConfigDefinitionToolInputSchema) MarshalJSON() ([]byte, error)

Override default JSON handling for AgentConfigDefinitionToolInputSchema to handle AdditionalProperties

func (*AgentConfigDefinitionToolInputSchema) Set 

func (a *AgentConfigDefinitionToolInputSchema) Set(fieldName string, value interface{})

Setter for additional properties for AgentConfigDefinitionToolInputSchema

func (*AgentConfigDefinitionToolInputSchema) UnmarshalJSON 

func (a *AgentConfigDefinitionToolInputSchema) UnmarshalJSON(b []byte) error

Override default JSON handling for AgentConfigDefinitionToolInputSchema to handle AdditionalProperties

type AgentConfigDefinitionToolPermission 

type AgentConfigDefinitionToolPermission struct {
	Mode       string                  `json:"mode"`
	Parameters *map[string]interface{} `json:"parameters,omitempty"`
}

AgentConfigDefinitionToolPermission defines model for AgentConfigDefinitionToolPermission.

type AgentConfigDefinitionTools 

type AgentConfigDefinitionTools map[string]AgentConfigDefinitionTool

AgentConfigDefinitionTools defines model for AgentConfigDefinitionTools.

type AgentConfigErrorIssue 

type AgentConfigErrorIssue struct {
	// Column 1-based column of the offending field in the submitted source, when it can be located.
	Column *int `json:"column,omitempty"`

	// Line 1-based line of the offending field in the submitted source, when it can be located.
	Line *int `json:"line,omitempty"`

	// Message Human-readable description of the problem with this field.
	Message string `json:"message"`

	// Path JSON Pointer (RFC 6901) to the offending field in the submitted document. An empty string refers to the whole document.
	Path string `json:"path"`
}

AgentConfigErrorIssue defines model for AgentConfigErrorIssue.

type AgentConfigGeneratedSource 

type AgentConfigGeneratedSource struct {
	Source string `json:"source"`
}

AgentConfigGeneratedSource defines model for AgentConfigGeneratedSource.

type AgentConfigGeneratedSourceParams 

type AgentConfigGeneratedSourceParams struct {
	SourceFormat *GetAgentConfigGeneratedSourceParamsSourceFormat
}

AgentConfigGeneratedSourceParams are the query, header and body fields of getAgentConfigGeneratedSource.

type AgentConfigID 

type AgentConfigID = string

AgentConfigID Agent config ID (acfg_...).

type AgentConfigModel 

type AgentConfigModel struct {
	// APIFormat Wire protocol the model endpoint speaks: openai-responses, openai-chat-completions, or anthropic-messages.
	APIFormat         ModelAPIFormat                  `json:"api_format"`
	APIVariant        ModelProviderAPIVariantResponse `json:"api_variant"`
	ConfiguredModelID ConfiguredModelID               `json:"configured_model_id"`

	// ContextWindowTokens Effective context budget for input and output tokens after model, project, and agent settings are applied. Triggers compaction when estimated input exceeds the remaining budget after output and safety reserves. The turn fails if compaction cannot make it fit.
	ContextWindowTokens int                       `json:"context_window_tokens"`
	CurrentRevisionID   ConfiguredModelRevisionID `json:"current_revision_id"`

	// DefaultCacheRetention Prompt-cache preference for model requests; `short` when omitted. `short` applies the route's default caching (explicit cache breakpoints where the provider requires them) and, where the route accepts one, a stable conversation key for cache-aware routing. `long` prefers the route's extended cache lifetime where one exists (currently Anthropic's one-hour cache, which on Bedrock requires Claude 4.5 or newer) and behaves like `short` elsewhere. `none` sends no BMA-managed cache controls or conversation key; providers may still cache prefixes on their own.
	DefaultCacheRetention ModelCacheRetention `json:"default_cache_retention"`

	// DefaultMaxOutputTokens Effective per-request output-token cap sent to the provider.
	DefaultMaxOutputTokens *int     `json:"default_max_output_tokens,omitempty"`
	DefaultReasoningEffort string   `json:"default_reasoning_effort"`
	InputModalities        []string `json:"input_modalities"`

	// MaxOutputTokens Effective known output-token ceiling after model and project settings, or null when unknown.
	MaxOutputTokens *int `json:"max_output_tokens"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name             ResourceName `json:"name"`
	OutputModalities []string     `json:"output_modalities"`

	// ProviderConfig Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	ProviderConfig ResourceName `json:"provider_config"`

	// ProviderModelSlug Exact provider model slug on the configured model's current revision at response time.
	ProviderModelSlug         string   `json:"provider_model_slug"`
	SupportedReasoningEfforts []string `json:"supported_reasoning_efforts"`
	SupportsReasoning         bool     `json:"supports_reasoning"`
	SupportsTools             bool     `json:"supports_tools"`
}

AgentConfigModel defines model for AgentConfigModel.

type AgentConfigNewParams 

type AgentConfigNewParams struct {
	Source       AgentConfigSourceInput
	SourceFormat CreateAgentConfigRequestSourceFormat
}

AgentConfigNewParams are the query, header and body fields of createAgentConfig.

type AgentConfigResolveToolsParams 

type AgentConfigResolveToolsParams struct {
	Source       ResolveAgentConfigToolsRequest_Source
	SourceFormat ResolveAgentConfigToolsRequestSourceFormat
}

AgentConfigResolveToolsParams are the query, header and body fields of resolveAgentConfigTools.

type AgentConfigService 

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

AgentConfigService groups the agentConfigs methods.

func (*AgentConfigService) GeneratedSource 

func (s *AgentConfigService) GeneratedSource(ctx context.Context, agentConfigID string, params AgentConfigGeneratedSourceParams, opts ...option.RequestOption) (*AgentConfigGeneratedSource, error)

GeneratedSource calls getAgentConfigGeneratedSource: GET /orgs/{orgID}/projects/{projectID}/agent-configs/{agentConfigID}/generated-source.

func (*AgentConfigService) Get 

func (s *AgentConfigService) Get(ctx context.Context, agentConfigID string, opts ...option.RequestOption) (*AgentConfig, error)

Get calls getAgentConfig: GET /orgs/{orgID}/projects/{projectID}/agent-configs/{agentConfigID}.

func (*AgentConfigService) New 

func (s *AgentConfigService) New(ctx context.Context, params AgentConfigNewParams, opts ...option.RequestOption) (*AgentConfig, error)

New calls createAgentConfig: POST /orgs/{orgID}/projects/{projectID}/agent-configs.

func (*AgentConfigService) ResolveTools 

func (s *AgentConfigService) ResolveTools(ctx context.Context, params AgentConfigResolveToolsParams, opts ...option.RequestOption) (*ResolvedAgentConfigTools, error)

ResolveTools calls resolveAgentConfigTools: POST /orgs/{orgID}/projects/{projectID}/agent-configs/tools.

type AgentConfigSourceFormat 

type AgentConfigSourceFormat string

AgentConfigSourceFormat defines model for AgentConfig.SourceFormat. 

const (
	AgentConfigSourceFormatJSON AgentConfigSourceFormat = "json"
	AgentConfigSourceFormatYaml AgentConfigSourceFormat = "yaml"
)

Defines values for AgentConfigSourceFormat.

func (AgentConfigSourceFormat) Valid 

func (e AgentConfigSourceFormat) Valid() bool

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

type AgentConfigSourceInput 

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

AgentConfigSourceInput Agent config source as YAML or JSON text, or, with source_format json, as a JSON object.

func (AgentConfigSourceInput) AsAgentConfigDefinition 

func (t AgentConfigSourceInput) AsAgentConfigDefinition() (AgentConfigDefinition, error)

AsAgentConfigDefinition returns the union data inside the AgentConfigSourceInput as a AgentConfigDefinition

func (AgentConfigSourceInput) AsAgentConfigSourceInput0 

func (t AgentConfigSourceInput) AsAgentConfigSourceInput0() (AgentConfigSourceInput0, error)

AsAgentConfigSourceInput0 returns the union data inside the AgentConfigSourceInput as a AgentConfigSourceInput0

func (*AgentConfigSourceInput) FromAgentConfigDefinition 

func (t *AgentConfigSourceInput) FromAgentConfigDefinition(v AgentConfigDefinition) error

FromAgentConfigDefinition overwrites any union data inside the AgentConfigSourceInput as the provided AgentConfigDefinition

func (*AgentConfigSourceInput) FromAgentConfigSourceInput0 

func (t *AgentConfigSourceInput) FromAgentConfigSourceInput0(v AgentConfigSourceInput0) error

FromAgentConfigSourceInput0 overwrites any union data inside the AgentConfigSourceInput as the provided AgentConfigSourceInput0

func (AgentConfigSourceInput) MarshalJSON 

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

func (*AgentConfigSourceInput) MergeAgentConfigDefinition 

func (t *AgentConfigSourceInput) MergeAgentConfigDefinition(v AgentConfigDefinition) error

MergeAgentConfigDefinition performs a merge with any union data inside the AgentConfigSourceInput, using the provided AgentConfigDefinition

func (*AgentConfigSourceInput) MergeAgentConfigSourceInput0 

func (t *AgentConfigSourceInput) MergeAgentConfigSourceInput0(v AgentConfigSourceInput0) error

MergeAgentConfigSourceInput0 performs a merge with any union data inside the AgentConfigSourceInput, using the provided AgentConfigSourceInput0

func (*AgentConfigSourceInput) UnmarshalJSON 

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

type AgentConfigSourceInput0 

type AgentConfigSourceInput0 = string

AgentConfigSourceInput0 defines model for .

type AgentConfigSummary 

type AgentConfigSummary struct {
	CreatedAt               Timestamp `json:"created_at"`
	EffectiveDefinitionHash string    `json:"effective_definition_hash"`

	// ID Agent config ID (acfg_...).
	ID              AgentConfigID    `json:"id"`
	InstructionHash *string          `json:"instruction_hash,omitempty"`
	Model           AgentConfigModel `json:"model"`
	OrgID           OrganizationID   `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID    ProjectID                       `json:"project_id"`
	Source       *string                         `json:"source,omitempty"`
	SourceFormat *AgentConfigSummarySourceFormat `json:"source_format,omitempty"`
}

AgentConfigSummary defines model for AgentConfigSummary.

type AgentConfigSummarySourceFormat 

type AgentConfigSummarySourceFormat string

AgentConfigSummarySourceFormat defines model for AgentConfigSummary.SourceFormat. 

const (
	AgentConfigSummarySourceFormatJSON AgentConfigSummarySourceFormat = "json"
	AgentConfigSummarySourceFormatYaml AgentConfigSummarySourceFormat = "yaml"
)

Defines values for AgentConfigSummarySourceFormat.

func (AgentConfigSummarySourceFormat) Valid 

func (e AgentConfigSummarySourceFormat) Valid() bool

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

type AgentConfigToolsDefinition 

type AgentConfigToolsDefinition struct {
	// GitCredentials Integration whose git credentials the agent's machines use.
	GitCredentials *AgentConfigDefinitionGitCredentials `json:"git_credentials,omitempty"`

	// InteractionHandlers Interaction handlers keyed by integration name.
	InteractionHandlers  *AgentConfigDefinitionInteractionHandlers `json:"interaction_handlers,omitempty"`
	MachineSources       *AgentConfigDefinitionMachineSources      `json:"machine_sources,omitempty"`
	Mcp                  *AgentConfigDefinitionMCPServers          `json:"mcp,omitempty"`
	MemoryStores         *AgentConfigDefinitionMemoryStores        `json:"memory_stores,omitempty"`
	Skills               *AgentConfigDefinitionSkills              `json:"skills,omitempty"`
	Subagents            *AgentConfigDefinitionSubagents           `json:"subagents,omitempty"`
	Tools                *AgentConfigDefinitionTools               `json:"tools,omitempty"`
	AdditionalProperties map[string]interface{}                    `json:"-"`
}

AgentConfigToolsDefinition The parts of an agent config definition that determine its effective tools. Other fields are ignored.

func (AgentConfigToolsDefinition) Get 

func (a AgentConfigToolsDefinition) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for AgentConfigToolsDefinition. Returns the specified element and whether it was found

func (AgentConfigToolsDefinition) MarshalJSON 

func (a AgentConfigToolsDefinition) MarshalJSON() ([]byte, error)

Override default JSON handling for AgentConfigToolsDefinition to handle AdditionalProperties

func (*AgentConfigToolsDefinition) Set 

func (a *AgentConfigToolsDefinition) Set(fieldName string, value interface{})

Setter for additional properties for AgentConfigToolsDefinition

func (*AgentConfigToolsDefinition) UnmarshalJSON 

func (a *AgentConfigToolsDefinition) UnmarshalJSON(b []byte) error

Override default JSON handling for AgentConfigToolsDefinition to handle AdditionalProperties

type AgentControlType 

type AgentControlType string

AgentControlType defines model for AgentControlType. 

const (
	AgentControlTypeCancelCurrent AgentControlType = "cancel_current"
)

Defines values for AgentControlType.

func (AgentControlType) Valid 

func (e AgentControlType) Valid() bool

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

type AgentCount 

type AgentCount = int

AgentCount Positive count within an agent timeline.

type AgentCronTriggerTarget 

type AgentCronTriggerTarget struct {
	AgentID AgentID `json:"agent_id"`

	// DeliveryMode Each firing sends a queued or steering message to the agent. Defaults to `queued` on creation; omitted updates preserve the current mode.
	DeliveryMode *CronTriggerDeliveryMode   `json:"delivery_mode,omitempty"`
	Type         AgentCronTriggerTargetType `json:"type"`
}

AgentCronTriggerTarget defines model for AgentCronTriggerTarget.

type AgentCronTriggerTargetType 

type AgentCronTriggerTargetType string

AgentCronTriggerTargetType defines model for AgentCronTriggerTarget.Type. 

const (
	AgentCronTriggerTargetTypeAgent AgentCronTriggerTargetType = "agent"
)

Defines values for AgentCronTriggerTargetType.

func (AgentCronTriggerTargetType) Valid 

func (e AgentCronTriggerTargetType) Valid() bool

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

type AgentEvent 

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

AgentEvent defines model for AgentEvent.

func (AgentEvent) AsAgentInputEvent 

func (t AgentEvent) AsAgentInputEvent() (AgentInputEvent, error)

AsAgentInputEvent returns the union data inside the AgentEvent as a AgentInputEvent

func (AgentEvent) AsAny 

func (t AgentEvent) AsAny() any

AsAny returns the member of AgentEvent named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (AgentEvent) AsContextCheckpointEvent 

func (t AgentEvent) AsContextCheckpointEvent() (ContextCheckpointEvent, error)

AsContextCheckpointEvent returns the union data inside the AgentEvent as a ContextCheckpointEvent

func (AgentEvent) AsExecutorEvent 

func (t AgentEvent) AsExecutorEvent() (ExecutorEvent, error)

AsExecutorEvent returns the union data inside the AgentEvent as a ExecutorEvent

func (AgentEvent) AsModelOutputEvent 

func (t AgentEvent) AsModelOutputEvent() (ModelOutputEvent, error)

AsModelOutputEvent returns the union data inside the AgentEvent as a ModelOutputEvent

func (AgentEvent) AsToolResultEvent 

func (t AgentEvent) AsToolResultEvent() (ToolResultEvent, error)

AsToolResultEvent returns the union data inside the AgentEvent as a ToolResultEvent

func (AgentEvent) Discriminator 

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

func (*AgentEvent) FromAgentInputEvent 

func (t *AgentEvent) FromAgentInputEvent(v AgentInputEvent) error

FromAgentInputEvent overwrites any union data inside the AgentEvent as the provided AgentInputEvent

func (*AgentEvent) FromContextCheckpointEvent 

func (t *AgentEvent) FromContextCheckpointEvent(v ContextCheckpointEvent) error

FromContextCheckpointEvent overwrites any union data inside the AgentEvent as the provided ContextCheckpointEvent

func (*AgentEvent) FromExecutorEvent 

func (t *AgentEvent) FromExecutorEvent(v ExecutorEvent) error

FromExecutorEvent overwrites any union data inside the AgentEvent as the provided ExecutorEvent

func (*AgentEvent) FromModelOutputEvent 

func (t *AgentEvent) FromModelOutputEvent(v ModelOutputEvent) error

FromModelOutputEvent overwrites any union data inside the AgentEvent as the provided ModelOutputEvent

func (*AgentEvent) FromToolResultEvent 

func (t *AgentEvent) FromToolResultEvent(v ToolResultEvent) error

FromToolResultEvent overwrites any union data inside the AgentEvent as the provided ToolResultEvent

func (AgentEvent) MarshalJSON 

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

func (*AgentEvent) MergeAgentInputEvent 

func (t *AgentEvent) MergeAgentInputEvent(v AgentInputEvent) error

MergeAgentInputEvent performs a merge with any union data inside the AgentEvent, using the provided AgentInputEvent

func (*AgentEvent) MergeContextCheckpointEvent 

func (t *AgentEvent) MergeContextCheckpointEvent(v ContextCheckpointEvent) error

MergeContextCheckpointEvent performs a merge with any union data inside the AgentEvent, using the provided ContextCheckpointEvent

func (*AgentEvent) MergeExecutorEvent 

func (t *AgentEvent) MergeExecutorEvent(v ExecutorEvent) error

MergeExecutorEvent performs a merge with any union data inside the AgentEvent, using the provided ExecutorEvent

func (*AgentEvent) MergeModelOutputEvent 

func (t *AgentEvent) MergeModelOutputEvent(v ModelOutputEvent) error

MergeModelOutputEvent performs a merge with any union data inside the AgentEvent, using the provided ModelOutputEvent

func (*AgentEvent) MergeToolResultEvent 

func (t *AgentEvent) MergeToolResultEvent(v ToolResultEvent) error

MergeToolResultEvent performs a merge with any union data inside the AgentEvent, using the provided ToolResultEvent

func (*AgentEvent) UnmarshalJSON 

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

func (AgentEvent) ValueByDiscriminator 

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

type AgentEventDelta 

type AgentEventDelta struct {
	EventID   string              `json:"event_id"`
	EventType string              `json:"event_type"`
	Index     int64               `json:"index"`
	SessionID string              `json:"session_id"`
	Text      string              `json:"text"`
	TurnID    string              `json:"turn_id"`
	Type      AgentEventDeltaType `json:"type"`
}

AgentEventDelta Best-effort preview frame of an agent executor session, sent only with stream_deltas: text appended to content block `index` of the executor event `event_id` before the durable executor_event arrives.

type AgentEventDeltaType 

type AgentEventDeltaType string

AgentEventDeltaType defines model for AgentEventDelta.Type. 

const (
	AgentEventDeltaTypeAgentEventDelta AgentEventDeltaType = "agent_event_delta"
)

Defines values for AgentEventDeltaType.

func (AgentEventDeltaType) Valid 

func (e AgentEventDeltaType) Valid() bool

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

type AgentEventID 

type AgentEventID = string

AgentEventID defines model for AgentEventID.

type AgentEventListParams 

type AgentEventListParams struct {
	SessionID      *string
	BeforeSequence *int64
	AfterSequence  *int64
	Limit          *int32
}

AgentEventListParams are the query, header and body fields of listEvents.

type AgentEventService 

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

AgentEventService groups the agents.events methods.

func (*AgentEventService) List 

func (s *AgentEventService) List(ctx context.Context, agentID string, params AgentEventListParams, opts ...option.RequestOption) (*CursorPage[AgentEvent], error)

List calls listEvents: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/events.

func (*AgentEventService) ListAutoPaging 

func (s *AgentEventService) ListAutoPaging(ctx context.Context, agentID string, params AgentEventListParams, opts ...option.RequestOption) *CursorPageAutoPager[AgentEvent]

ListAutoPaging iterates every item of listEvents across pages.

func (*AgentEventService) Stream 

func (s *AgentEventService) Stream(ctx context.Context, agentID string, params AgentEventStreamParams, opts ...option.RequestOption) *Stream[StreamEventsEvent]

Stream calls streamEvents: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream.

type AgentEventStreamData 

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

AgentEventStreamData One JSON payload from the event stream: an authoritative durable event, a best-effort tool-call update, a best-effort model-output preview, or a stream-closing error. The wire response ends after an error payload; `service_unavailable` is retryable and other current codes are terminal.

func (AgentEventStreamData) AsAgentEvent 

func (t AgentEventStreamData) AsAgentEvent() (AgentEvent, error)

AsAgentEvent returns the union data inside the AgentEventStreamData as a AgentEvent

func (AgentEventStreamData) AsAgentEventDelta 

func (t AgentEventStreamData) AsAgentEventDelta() (AgentEventDelta, error)

AsAgentEventDelta returns the union data inside the AgentEventStreamData as a AgentEventDelta

func (AgentEventStreamData) AsErrorBody 

func (t AgentEventStreamData) AsErrorBody() (ErrorBody, error)

AsErrorBody returns the union data inside the AgentEventStreamData as a ErrorBody

func (AgentEventStreamData) AsExecutorInteractionUpdate 

func (t AgentEventStreamData) AsExecutorInteractionUpdate() (ExecutorInteractionUpdate, error)

AsExecutorInteractionUpdate returns the union data inside the AgentEventStreamData as a ExecutorInteractionUpdate

func (AgentEventStreamData) AsModelOutputDelta 

func (t AgentEventStreamData) AsModelOutputDelta() (ModelOutputDelta, error)

AsModelOutputDelta returns the union data inside the AgentEventStreamData as a ModelOutputDelta

func (AgentEventStreamData) AsToolCallUpdate 

func (t AgentEventStreamData) AsToolCallUpdate() (ToolCallUpdate, error)

AsToolCallUpdate returns the union data inside the AgentEventStreamData as a ToolCallUpdate

func (*AgentEventStreamData) FromAgentEvent 

func (t *AgentEventStreamData) FromAgentEvent(v AgentEvent) error

FromAgentEvent overwrites any union data inside the AgentEventStreamData as the provided AgentEvent

func (*AgentEventStreamData) FromAgentEventDelta 

func (t *AgentEventStreamData) FromAgentEventDelta(v AgentEventDelta) error

FromAgentEventDelta overwrites any union data inside the AgentEventStreamData as the provided AgentEventDelta

func (*AgentEventStreamData) FromErrorBody 

func (t *AgentEventStreamData) FromErrorBody(v ErrorBody) error

FromErrorBody overwrites any union data inside the AgentEventStreamData as the provided ErrorBody

func (*AgentEventStreamData) FromExecutorInteractionUpdate 

func (t *AgentEventStreamData) FromExecutorInteractionUpdate(v ExecutorInteractionUpdate) error

FromExecutorInteractionUpdate overwrites any union data inside the AgentEventStreamData as the provided ExecutorInteractionUpdate

func (*AgentEventStreamData) FromModelOutputDelta 

func (t *AgentEventStreamData) FromModelOutputDelta(v ModelOutputDelta) error

FromModelOutputDelta overwrites any union data inside the AgentEventStreamData as the provided ModelOutputDelta

func (*AgentEventStreamData) FromToolCallUpdate 

func (t *AgentEventStreamData) FromToolCallUpdate(v ToolCallUpdate) error

FromToolCallUpdate overwrites any union data inside the AgentEventStreamData as the provided ToolCallUpdate

func (AgentEventStreamData) MarshalJSON 

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

func (*AgentEventStreamData) MergeAgentEvent 

func (t *AgentEventStreamData) MergeAgentEvent(v AgentEvent) error

MergeAgentEvent performs a merge with any union data inside the AgentEventStreamData, using the provided AgentEvent

func (*AgentEventStreamData) MergeAgentEventDelta 

func (t *AgentEventStreamData) MergeAgentEventDelta(v AgentEventDelta) error

MergeAgentEventDelta performs a merge with any union data inside the AgentEventStreamData, using the provided AgentEventDelta

func (*AgentEventStreamData) MergeErrorBody 

func (t *AgentEventStreamData) MergeErrorBody(v ErrorBody) error

MergeErrorBody performs a merge with any union data inside the AgentEventStreamData, using the provided ErrorBody

func (*AgentEventStreamData) MergeExecutorInteractionUpdate 

func (t *AgentEventStreamData) MergeExecutorInteractionUpdate(v ExecutorInteractionUpdate) error

MergeExecutorInteractionUpdate performs a merge with any union data inside the AgentEventStreamData, using the provided ExecutorInteractionUpdate

func (*AgentEventStreamData) MergeModelOutputDelta 

func (t *AgentEventStreamData) MergeModelOutputDelta(v ModelOutputDelta) error

MergeModelOutputDelta performs a merge with any union data inside the AgentEventStreamData, using the provided ModelOutputDelta

func (*AgentEventStreamData) MergeToolCallUpdate 

func (t *AgentEventStreamData) MergeToolCallUpdate(v ToolCallUpdate) error

MergeToolCallUpdate performs a merge with any union data inside the AgentEventStreamData, using the provided ToolCallUpdate

func (*AgentEventStreamData) UnmarshalJSON 

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

type AgentEventStreamParams 

type AgentEventStreamParams struct {
	SessionID     *string
	AfterSequence *int64
	StreamDeltas  *bool
	LastEventID   *int64
}

AgentEventStreamParams are the query, header and body fields of streamEvents.

type AgentEventWebhookScope 

type AgentEventWebhookScope struct {
	AgentID AgentID                    `json:"agent_id"`
	Type    AgentEventWebhookScopeType `json:"type"`
}

AgentEventWebhookScope Watches only this agent, not its descendants.

type AgentEventWebhookScopeType 

type AgentEventWebhookScopeType string

AgentEventWebhookScopeType defines model for AgentEventWebhookScope.Type. 

const (
	AgentEventWebhookScopeTypeAgent AgentEventWebhookScopeType = "agent"
)

Defines values for AgentEventWebhookScopeType.

func (AgentEventWebhookScopeType) Valid 

func (e AgentEventWebhookScopeType) Valid() bool

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

type AgentExecutorBinding 

type AgentExecutorBinding struct {
	AgentID AgentID `json:"agent_id"`

	// Capability capabilities.agent from the machine executor's latest executor.register, or null before an agent executor has registered.
	Capability *map[string]interface{} `json:"capability"`

	// MachineID Machine ID (mch_...).
	MachineID MachineID `json:"machine_id"`
}

AgentExecutorBinding defines model for AgentExecutorBinding.

type AgentExecutorBindingEnvelope 

type AgentExecutorBindingEnvelope struct {
	ExecutorBinding AgentExecutorBinding `json:"executor_binding"`
}

AgentExecutorBindingEnvelope defines model for AgentExecutorBindingEnvelope.

type AgentExecutorBindingInput 

type AgentExecutorBindingInput struct {
	// MachineID Machine ID (mch_...).
	MachineID MachineID `json:"machine_id"`
}

AgentExecutorBindingInput defines model for AgentExecutorBindingInput.

type AgentExecutorBindingService 

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

AgentExecutorBindingService groups the agents.executorBinding methods.

func (*AgentExecutorBindingService) Get 

func (s *AgentExecutorBindingService) Get(ctx context.Context, agentID string, opts ...option.RequestOption) (*AgentExecutorBindingEnvelope, error)

Get calls GetAgentExecutorBinding: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/executor-binding.

func (*AgentExecutorBindingService) Set 

func (s *AgentExecutorBindingService) Set(ctx context.Context, agentID string, params AgentExecutorBindingSetParams, opts ...option.RequestOption) (*AgentExecutorBindingEnvelope, error)

Set calls PutAgentExecutorBinding: PUT /orgs/{orgID}/projects/{projectID}/agents/{agentID}/executor-binding.

type AgentExecutorBindingSetParams 

type AgentExecutorBindingSetParams struct {
	MachineID MachineID
}

AgentExecutorBindingSetParams are the query, header and body fields of PutAgentExecutorBinding.

type AgentID 

type AgentID = string

AgentID defines model for AgentID.

type AgentIncludeUsage 

type AgentIncludeUsage = bool

AgentIncludeUsage defines model for AgentIncludeUsage.

type AgentInput 

type AgentInput struct {
	ActorID       *ActorID                  `json:"actor_id,omitempty"`
	AgentID       AgentID                   `json:"agent_id"`
	ContentBlocks *[]AgentInputContentBlock `json:"content_blocks,omitempty"`
	DeliveryMode  AgentInputDeliveryMode    `json:"delivery_mode"`
	ID            AgentInputID              `json:"id"`

	// InputIdempotencyKey Idempotency key supplied when this content input was created. Absent for other input kinds.
	InputIdempotencyKey *string        `json:"input_idempotency_key,omitempty"`
	InputKind           AgentInputKind `json:"input_kind"`
	QueuedAt            Timestamp      `json:"queued_at"`
	State               string         `json:"state"`
}

AgentInput defines model for AgentInput.

type AgentInputContentBlock 

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

AgentInputContentBlock defines model for AgentInputContentBlock.

func (AgentInputContentBlock) AsAny 

func (t AgentInputContentBlock) AsAny() any

AsAny returns the member of AgentInputContentBlock named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (AgentInputContentBlock) AsMediaRefContentBlock 

func (t AgentInputContentBlock) AsMediaRefContentBlock() (MediaRefContentBlock, error)

AsMediaRefContentBlock returns the union data inside the AgentInputContentBlock as a MediaRefContentBlock

func (AgentInputContentBlock) AsTextContentBlock 

func (t AgentInputContentBlock) AsTextContentBlock() (TextContentBlock, error)

AsTextContentBlock returns the union data inside the AgentInputContentBlock as a TextContentBlock

func (AgentInputContentBlock) Discriminator 

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

func (*AgentInputContentBlock) FromMediaRefContentBlock 

func (t *AgentInputContentBlock) FromMediaRefContentBlock(v MediaRefContentBlock) error

FromMediaRefContentBlock overwrites any union data inside the AgentInputContentBlock as the provided MediaRefContentBlock

func (*AgentInputContentBlock) FromTextContentBlock 

func (t *AgentInputContentBlock) FromTextContentBlock(v TextContentBlock) error

FromTextContentBlock overwrites any union data inside the AgentInputContentBlock as the provided TextContentBlock

func (AgentInputContentBlock) MarshalJSON 

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

func (*AgentInputContentBlock) MergeMediaRefContentBlock 

func (t *AgentInputContentBlock) MergeMediaRefContentBlock(v MediaRefContentBlock) error

MergeMediaRefContentBlock performs a merge with any union data inside the AgentInputContentBlock, using the provided MediaRefContentBlock

func (*AgentInputContentBlock) MergeTextContentBlock 

func (t *AgentInputContentBlock) MergeTextContentBlock(v TextContentBlock) error

MergeTextContentBlock performs a merge with any union data inside the AgentInputContentBlock, using the provided TextContentBlock

func (*AgentInputContentBlock) UnmarshalJSON 

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

func (AgentInputContentBlock) ValueByDiscriminator 

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

type AgentInputDeliveryMode 

type AgentInputDeliveryMode string

AgentInputDeliveryMode defines model for AgentInputDeliveryMode. 

const (
	AgentInputDeliveryModeImmediate AgentInputDeliveryMode = "immediate"
	AgentInputDeliveryModeQueued    AgentInputDeliveryMode = "queued"
	AgentInputDeliveryModeSteering  AgentInputDeliveryMode = "steering"
)

Defines values for AgentInputDeliveryMode.

func (AgentInputDeliveryMode) Valid 

func (e AgentInputDeliveryMode) Valid() bool

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

type AgentInputEnvelope 

type AgentInputEnvelope struct {
	AgentInput AgentInput `json:"agent_input"`
}

AgentInputEnvelope defines model for AgentInputEnvelope.

type AgentInputEvent 

type AgentInputEvent struct {
	ActorID *ActorID `json:"actor_id,omitempty"`

	// AgentConfigID Agent config ID (acfg_...).
	AgentConfigID *AgentConfigID           `json:"agent_config_id,omitempty"`
	AgentID       AgentID                  `json:"agent_id"`
	AgentInputID  AgentInputID             `json:"agent_input_id"`
	ContentBlocks []AgentInputContentBlock `json:"content_blocks"`
	ControlType   *AgentControlType        `json:"control_type,omitempty"`
	CreatedAt     Timestamp                `json:"created_at"`
	EventKind     AgentInputEventEventKind `json:"event_kind"`
	ID            AgentEventID             `json:"id"`

	// InputIdempotencyKey Echoes the Idempotency-Key of a content-input request so its sender can recognize the durable admission. Absent for other input kinds.
	InputIdempotencyKey *string             `json:"input_idempotency_key,omitempty"`
	InputKind           AgentInputKind      `json:"input_kind"`
	InteractionID       *AgentInteractionID `json:"interaction_id,omitempty"`
	IsOpeningEvent      bool                `json:"is_opening_event"`
	OrgID               OrganizationID      `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// Sequence Positive per-agent event, turn, or live-frame sequence.
	Sequence AgentSequence `json:"sequence"`
	TurnID   AgentTurnID   `json:"turn_id"`

	// TurnSequence Positive per-agent event, turn, or live-frame sequence.
	TurnSequence AgentSequence `json:"turn_sequence"`
}

AgentInputEvent defines model for AgentInputEvent.

type AgentInputEventEventKind 

type AgentInputEventEventKind string

AgentInputEventEventKind defines model for AgentInputEvent.EventKind. 

const (
	AgentInputEventEventKindAgentInput AgentInputEventEventKind = "agent_input"
)

Defines values for AgentInputEventEventKind.

func (AgentInputEventEventKind) Valid 

func (e AgentInputEventEventKind) Valid() bool

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

type AgentInputID 

type AgentInputID = string

AgentInputID defines model for AgentInputID.

type AgentInputKind 

type AgentInputKind string

AgentInputKind defines model for AgentInputKind. 

const (
	AgentInputKindConfigChange        AgentInputKind = "config_change"
	AgentInputKindContent             AgentInputKind = "content"
	AgentInputKindControl             AgentInputKind = "control"
	AgentInputKindInteractionResponse AgentInputKind = "interaction_response"
)

Defines values for AgentInputKind.

func (AgentInputKind) Valid 

func (e AgentInputKind) Valid() bool

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

type AgentInputListBacklogParams 

type AgentInputListBacklogParams struct {
	Limit  *PageLimit
	Cursor *PageCursor
}

AgentInputListBacklogParams are the query, header and body fields of listQueuedBacklogInputs.

type AgentInputMoveParams 

type AgentInputMoveParams struct {
	AnchorInputID *AgentInputID
	Position      MoveQueuedBacklogInputRequestPosition
}

AgentInputMoveParams are the query, header and body fields of moveQueuedBacklogInput.

type AgentInputNewParams 

type AgentInputNewParams struct {
	SessionID              *string
	Actor                  *ExternalActorParams
	CancelOpenInteractions *bool
	ContentBlocks          []CreateAgentInputContentBlock
	DeliveryMode           *CreateAgentInputDeliveryMode
	ModelOverride          *AgentModelOverrideInput
}

AgentInputNewParams are the query, header and body fields of createAgentInput.

type AgentInputPromoteToSteeringParams 

type AgentInputPromoteToSteeringParams struct {
	CancelOpenInteractions *bool
}

AgentInputPromoteToSteeringParams are the query, header and body fields of promoteQueuedInputToSteering.

type AgentInputService 

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

AgentInputService groups the agents.inputs methods.

func (*AgentInputService) Cancel 

func (s *AgentInputService) Cancel(ctx context.Context, agentID string, inputID string, opts ...option.RequestOption) (*OKResponse, error)

Cancel calls cancelQueuedBacklogInput: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/inputs/{inputID}/cancel.

func (*AgentInputService) DemoteToQueued 

func (s *AgentInputService) DemoteToQueued(ctx context.Context, agentID string, inputID string, opts ...option.RequestOption) (*OKResponse, error)

DemoteToQueued calls demoteSteeringInputToQueued: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/inputs/{inputID}/demote_to_queued.

func (*AgentInputService) ListBacklog 

func (s *AgentInputService) ListBacklog(ctx context.Context, agentID string, params AgentInputListBacklogParams, opts ...option.RequestOption) (*CursorPage[AgentInput], error)

ListBacklog calls listQueuedBacklogInputs: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/inputs/backlog.

func (*AgentInputService) ListBacklogAutoPaging 

func (s *AgentInputService) ListBacklogAutoPaging(ctx context.Context, agentID string, params AgentInputListBacklogParams, opts ...option.RequestOption) *CursorPageAutoPager[AgentInput]

ListBacklogAutoPaging iterates every item of listQueuedBacklogInputs across pages.

func (*AgentInputService) Move 

func (s *AgentInputService) Move(ctx context.Context, agentID string, inputID string, params AgentInputMoveParams, opts ...option.RequestOption) (*OKResponse, error)

Move calls moveQueuedBacklogInput: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/inputs/{inputID}/move.

func (*AgentInputService) New 

func (s *AgentInputService) New(ctx context.Context, agentID string, params AgentInputNewParams, opts ...option.RequestOption) (*AgentInputEnvelope, error)

New calls createAgentInput: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/inputs.

func (*AgentInputService) PromoteToSteering 

func (s *AgentInputService) PromoteToSteering(ctx context.Context, agentID string, inputID string, params AgentInputPromoteToSteeringParams, opts ...option.RequestOption) (*OKResponse, error)

PromoteToSteering calls promoteQueuedInputToSteering: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/inputs/{inputID}/promote_to_steering.

type AgentInteraction 

type AgentInteraction struct {
	AgentID AgentID `json:"agent_id"`

	// AgentName Agent name. Empty means the agent is unnamed; non-empty values use the ResourceName policy.
	AgentName *AgentName `json:"agent_name,omitempty"`
	CreatedAt Timestamp  `json:"created_at"`

	// Destination Immutable handler and destination captured when the interaction was created. Provider delivery and callbacks check current integration and handler authority. Dashboard/API resolution remains available independently.
	Destination     *AgentInteractionDestination `json:"destination,omitempty"`
	ID              AgentInteractionID           `json:"id"`
	InteractionKind AgentInteractionKind         `json:"interaction_kind"`
	OrgID           OrganizationID               `json:"org_id"`

	// PresentationReceipt Confirmed provider presentation metadata, when recorded. This is not an execution grant or a delivery guarantee. Absence does not prove a remote send failed. Customer-hosted presenters maintain their own delivery records.
	PresentationReceipt *InteractionPresentationReceipt `json:"presentation_receipt,omitempty"`

	// ProjectID Project ID (proj_...).
	ProjectID         ProjectID              `json:"project_id"`
	Request           InteractionForm        `json:"request"`
	Resolution        *InteractionResolution `json:"resolution,omitempty"`
	ResolvedAt        *Timestamp             `json:"resolved_at,omitempty"`
	ResolvedByInputID *AgentInputID          `json:"resolved_by_input_id,omitempty"`
	State             AgentInteractionState  `json:"state"`

	// SubagentKey Present when the interaction belongs to a subagent of the listed agent.
	SubagentKey *string    `json:"subagent_key,omitempty"`
	ToolCallID  ToolCallID `json:"tool_call_id"`

	// ToolName The tool whose invocation a permission interaction guards. Present only when interaction_kind is permission.
	ToolName *string `json:"tool_name,omitempty"`

	// ToolUseID For an approval raised by an agent executor, the id of the agent.tool_use event it refers to (tool_call_id then identifies the approval itself). Absent for native tool calls.
	ToolUseID *string `json:"tool_use_id,omitempty"`
}

AgentInteraction defines model for AgentInteraction.

type AgentInteractionDestination 

type AgentInteractionDestination struct {
	// Conversation One concrete provider address, validated by the integration's capabilities.subscription.conversation_schema. Slack uses channel_id and optional thread_ts; Discord uses channel_id for a channel or thread_id for a thread; GitHub uses repository_id and pull_request. Discord accepts optional parent channel_id and guild_id alongside thread_id and validates their ID format, but subscription creation does not verify them against Discord or retain them as routing restrictions. Only thread_id is retained in a canonical thread address and returned by create/list responses. No credentials or runtime state.
	Conversation  IntegrationConversation `json:"conversation"`
	HandlerKey    string                  `json:"handler_key"`
	IntegrationID IntegrationID           `json:"integration_id"`

	// IntegrationKind Registered integration implementation; independent of the saved integration's name and immutable ID.
	IntegrationKind     IntegrationKind     `json:"integration_kind"`
	IntegrationTargetID IntegrationTargetID `json:"integration_target_id"`
}

AgentInteractionDestination Immutable handler and destination captured when the interaction was created. Provider delivery and callbacks check current integration and handler authority. Dashboard/API resolution remains available independently.

type AgentInteractionID 

type AgentInteractionID = string

AgentInteractionID defines model for AgentInteractionID.

type AgentInteractionKind 

type AgentInteractionKind string

AgentInteractionKind defines model for AgentInteractionKind. 

const (
	AgentInteractionKindPermission AgentInteractionKind = "permission"
	AgentInteractionKindQuestion   AgentInteractionKind = "question"
)

Defines values for AgentInteractionKind.

func (AgentInteractionKind) Valid 

func (e AgentInteractionKind) Valid() bool

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

type AgentInteractionListParams 

type AgentInteractionListParams struct {
	State            *AgentInteractionState
	IncludeSubagents *bool
	Limit            *PageLimit
	Cursor           *PageCursor
}

AgentInteractionListParams are the query, header and body fields of listAgentInteractions.

type AgentInteractionResolveParams 

type AgentInteractionResolveParams struct {
	Actor   *ExternalActorParams
	Answers []InteractionAnswer
}

AgentInteractionResolveParams are the query, header and body fields of resolveAgentInteraction.

type AgentInteractionService 

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

AgentInteractionService groups the agents.interactions methods.

func (*AgentInteractionService) List 

func (s *AgentInteractionService) List(ctx context.Context, agentID string, params AgentInteractionListParams, opts ...option.RequestOption) (*CursorPage[AgentInteraction], error)

List calls listAgentInteractions: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/interactions.

func (*AgentInteractionService) ListAutoPaging 

func (s *AgentInteractionService) ListAutoPaging(ctx context.Context, agentID string, params AgentInteractionListParams, opts ...option.RequestOption) *CursorPageAutoPager[AgentInteraction]

ListAutoPaging iterates every item of listAgentInteractions across pages.

func (*AgentInteractionService) Resolve 

func (s *AgentInteractionService) Resolve(ctx context.Context, agentID string, interactionID string, params AgentInteractionResolveParams, opts ...option.RequestOption) (*AgentInteraction, error)

Resolve calls resolveAgentInteraction: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/interactions/{interactionID}/resolve.

type AgentInteractionState 

type AgentInteractionState string

AgentInteractionState defines model for AgentInteractionState. 

const (
	AgentInteractionStateCanceled AgentInteractionState = "canceled"
	AgentInteractionStateOpen     AgentInteractionState = "open"
	AgentInteractionStateResolved AgentInteractionState = "resolved"
)

Defines values for AgentInteractionState.

func (AgentInteractionState) Valid 

func (e AgentInteractionState) Valid() bool

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

type AgentInteractionUpdate 

type AgentInteractionUpdate struct {
	ID              AgentInteractionID    `json:"id"`
	InteractionKind AgentInteractionKind  `json:"interaction_kind"`
	State           AgentInteractionState `json:"state"`
}

AgentInteractionUpdate defines model for AgentInteractionUpdate.

type AgentLaunchInitialInput 

type AgentLaunchInitialInput struct {
	// Actor Identity and attributes of an external actor. Actors are upserted by (provider_tenant_id, provider_user_id) with the external provider. Omitted attributes keep their stored values; provided attributes are overwritten, including empty values. bma actors are implicit and hosted integrations own their own actor identities.
	Actor         *ExternalActorParams `json:"actor,omitempty"`
	ContentBlocks []TextContentBlock   `json:"content_blocks"`
}

AgentLaunchInitialInput Initial queued text input, committed atomically with the agent and any derived config. Mutually exclusive with message. Initial inline media is not supported; upload it through the agent input endpoint after launch.

type AgentListParams 

type AgentListParams struct {
	Name             *ResourceNameFilter
	AgentProfileID   *AgentProfileID
	ParentAgentID    *AgentID
	IncludeSubagents *bool
	IncludeArchived  *bool
	IncludeUsage     *AgentIncludeUsage
	Sort             *ResourceListSort
	Limit            *PageLimit
	Cursor           *PageCursor
}

AgentListParams are the query, header and body fields of listAgents.

type AgentMCPConnection 

type AgentMCPConnection struct {
	CreatedAt       Timestamp               `json:"created_at"`
	EndpointURL     string                  `json:"endpoint_url"`
	InitializeError string                  `json:"initialize_error"`
	ProtocolVersion *string                 `json:"protocol_version,omitempty"`
	ServerKey       string                  `json:"server_key"`
	State           AgentMCPConnectionState `json:"state"`
	UpdatedAt       Timestamp               `json:"updated_at"`
}

AgentMCPConnection defines model for AgentMCPConnection.

type AgentMCPConnectionState 

type AgentMCPConnectionState string

AgentMCPConnectionState defines model for AgentMCPConnection.State. 

const (
	AgentMCPConnectionStateExpired      AgentMCPConnectionState = "expired"
	AgentMCPConnectionStateFailed       AgentMCPConnectionState = "failed"
	AgentMCPConnectionStateInitializing AgentMCPConnectionState = "initializing"
	AgentMCPConnectionStateReady        AgentMCPConnectionState = "ready"
)

Defines values for AgentMCPConnectionState.

func (AgentMCPConnectionState) Valid 

func (e AgentMCPConnectionState) Valid() bool

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

type AgentMachine 

type AgentMachine struct {
	ConnectionState MachineConnectionState `json:"connection_state"`

	// CPU The machine shape BMA reports, or null before the provider resolves it.
	CPU       *int32    `json:"cpu"`
	CreatedAt Timestamp `json:"created_at"`

	// DisplayName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	DisplayName ResourceName `json:"display_name"`

	// ID Machine ID (mch_...).
	ID MachineID `json:"id"`

	// Kind Persistent machines are kept for a person and never deleted for being idle; ephemeral machines serve turns and are deleted after their idle window.
	Kind           AgentMachineKind      `json:"kind"`
	LifecycleState MachineLifecycleState `json:"lifecycle_state"`
	MachinePoolID  *MachinePoolID        `json:"machine_pool_id"`

	// MachinePoolName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	MachinePoolName ResourceName `json:"machine_pool_name"`

	// MemoryMb The machine shape BMA reports, or null before the provider resolves it.
	MemoryMb *int32 `json:"memory_mb"`
}

AgentMachine defines model for AgentMachine.

type AgentMachineBinding 

type AgentMachineBinding struct {
	AgentID     AgentID                 `json:"agent_id"`
	BindingKind AgentMachineBindingKind `json:"binding_kind"`
	CreatedAt   Timestamp               `json:"created_at"`
	Cwd         string                  `json:"cwd"`
	Description string                  `json:"description"`

	// EnvOverlay Env overlay applied to processes launched through this binding. For pool bindings it is also applied to the machine environment when the pool machine is provisioned, so the provider_options startup_script and the daemon run with it; connected machines keep their own environment. A null entry removes the key.
	EnvOverlay map[string]*string    `json:"env_overlay"`
	ID         AgentMachineBindingID `json:"id"`

	// MachineID Machine ID (mch_...).
	MachineID MachineID `json:"machine_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// SecretEnvOverlay Secret env overlay applied to processes launched through this binding. For pool bindings it is also applied to the machine environment when the pool machine is provisioned, so the provider_options startup_script and the daemon run with it; connected machines keep their own environment. A null entry removes the key.
	SecretEnvOverlay map[string]*SecretID     `json:"secret_env_overlay"`
	State            AgentMachineBindingState `json:"state"`
	UpdatedAt        Timestamp                `json:"updated_at"`
}

AgentMachineBinding defines model for AgentMachineBinding.

type AgentMachineBindingID 

type AgentMachineBindingID = string

AgentMachineBindingID defines model for AgentMachineBindingID.

type AgentMachineBindingKind 

type AgentMachineBindingKind string

AgentMachineBindingKind defines model for AgentMachineBindingKind. 

const (
	AgentMachineBindingKindExplicit AgentMachineBindingKind = "explicit"
	AgentMachineBindingKindPool     AgentMachineBindingKind = "pool"
)

Defines values for AgentMachineBindingKind.

func (AgentMachineBindingKind) Valid 

func (e AgentMachineBindingKind) Valid() bool

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

type AgentMachineBindingState 

type AgentMachineBindingState string

AgentMachineBindingState defines model for AgentMachineBindingState. 

const (
	AgentMachineBindingStateAttached AgentMachineBindingState = "attached"
	AgentMachineBindingStateReleased AgentMachineBindingState = "released"
)

Defines values for AgentMachineBindingState.

func (AgentMachineBindingState) Valid 

func (e AgentMachineBindingState) Valid() bool

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

type AgentMachineKind 

type AgentMachineKind string

AgentMachineKind Persistent machines are kept for a person and never deleted for being idle; ephemeral machines serve turns and are deleted after their idle window. 

const (
	AgentMachineKindEphemeral  AgentMachineKind = "ephemeral"
	AgentMachineKindPersistent AgentMachineKind = "persistent"
)

Defines values for AgentMachineKind.

func (AgentMachineKind) Valid 

func (e AgentMachineKind) Valid() bool

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

type AgentMachineNewParams 

type AgentMachineNewParams struct {
	DisplayName   *ResourceName
	MachinePoolID *MachinePoolID
	Template      string
}

AgentMachineNewParams are the query, header and body fields of createAgentPersistentMachine.

type AgentMachineService 

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

AgentMachineService groups the agents.machines methods.

func (*AgentMachineService) Delete 

func (s *AgentMachineService) Delete(ctx context.Context, agentID string, machineID string, opts ...option.RequestOption) error

Delete calls deleteAgentMachine: DELETE /orgs/{orgID}/projects/{projectID}/agents/{agentID}/machines/{machineID}.

func (*AgentMachineService) List 

func (s *AgentMachineService) List(ctx context.Context, agentID string, opts ...option.RequestOption) (*ListAgentMachinesResponse, error)

List calls listAgentMachines: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/machines.

func (*AgentMachineService) New 

func (s *AgentMachineService) New(ctx context.Context, agentID string, params AgentMachineNewParams, opts ...option.RequestOption) (*AgentMachine, error)

New calls createAgentPersistentMachine: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/machines.

type AgentModel 

type AgentModel struct {
	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`

	// ProviderConfig Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	ProviderConfig ResourceName `json:"provider_config"`
}

AgentModel defines model for AgentModel.

type AgentModelOverride 

type AgentModelOverride struct {
	AgentID          string    `json:"agent_id"`
	APIFormat        string    `json:"api_format"`
	APIVariant       *string   `json:"api_variant,omitempty"`
	BaseURL          string    `json:"base_url"`
	ConsumeAfterTurn *bool     `json:"consume_after_turn,omitempty"`
	CreatedAt        time.Time `json:"created_at"`
	EndpointPath     *string   `json:"endpoint_path,omitempty"`

	// ExpiresAt Absent for a session-lifetime override.
	ExpiresAt *time.Time `json:"expires_at,omitempty"`

	// ExpiresWithSession The override stays active until its session is archived.
	ExpiresWithSession bool `json:"expires_with_session"`

	// Fingerprint First 16 hex chars of sha256(key).
	Fingerprint string `json:"fingerprint"`
	ID          string `json:"id"`

	// KeyHint Last 4 characters of the key, never the key.
	KeyHint   *string                  `json:"key_hint,omitempty"`
	Model     string                   `json:"model"`
	RevokedAt *time.Time               `json:"revoked_at,omitempty"`
	SessionID string                   `json:"session_id"`
	Status    AgentModelOverrideStatus `json:"status"`
}

AgentModelOverride defines model for AgentModelOverride.

type AgentModelOverrideEnvelope 

type AgentModelOverrideEnvelope struct {
	ModelOverride AgentModelOverride `json:"model_override"`
}

AgentModelOverrideEnvelope defines model for AgentModelOverrideEnvelope.

type AgentModelOverrideInput 

type AgentModelOverrideInput struct {
	// APIKey Write-only. Never returned, logged, or emitted; encrypted at rest.
	APIKey *string `json:"api_key,omitempty"`

	// AutoCompactWindowTokens Compact the session as if the context window were this size, to bound per-turn cost and latency on large-window models. Must not exceed the context window.
	AutoCompactWindowTokens *int `json:"auto_compact_window_tokens,omitempty"`

	// ContextWindowTokens Model context window in tokens. When omitted, BMA reads it from the provider's models endpoint, then a public model catalog, and otherwise uses 128000.
	ContextWindowTokens *int `json:"context_window_tokens,omitempty"`

	// ExpiresWithSession Keep the override active until the session is archived instead of a TTL.
	ExpiresWithSession *bool `json:"expires_with_session,omitempty"`

	// MaxOutputTokens Maximum output tokens per response; must be below the context window. When omitted, BMA keeps its default output policy for the API format.
	MaxOutputTokens *int `json:"max_output_tokens,omitempty"`

	// Model Provider model slug (for example deepseek-flash).
	Model      string                      `json:"model"`
	Provider   *AgentModelOverrideProvider `json:"provider,omitempty"`
	TTLSeconds *int                        `json:"ttl_seconds,omitempty"`
}

AgentModelOverrideInput defines model for AgentModelOverrideInput.

type AgentModelOverridePatch 

type AgentModelOverridePatch struct {
	APIKey     *string                     `json:"api_key,omitempty"`
	Model      *string                     `json:"model,omitempty"`
	Provider   *AgentModelOverrideProvider `json:"provider,omitempty"`
	TTLSeconds *int                        `json:"ttl_seconds,omitempty"`
}

AgentModelOverridePatch defines model for AgentModelOverridePatch.

type AgentModelOverrideProvider 

type AgentModelOverrideProvider struct {
	APIFormat  AgentModelOverrideProviderAPIFormat   `json:"api_format"`
	APIVariant *AgentModelOverrideProviderAPIVariant `json:"api_variant,omitempty"`

	// BaseURL HTTPS origin only; must not contain userinfo, query, fragment or a trailing slash. Private and link-local hosts are rejected by provider validation.
	BaseURL      string  `json:"base_url"`
	EndpointPath *string `json:"endpoint_path,omitempty"`
}

AgentModelOverrideProvider defines model for AgentModelOverrideProvider.

type AgentModelOverrideProviderAPIFormat 

type AgentModelOverrideProviderAPIFormat string

AgentModelOverrideProviderAPIFormat defines model for AgentModelOverrideProvider.APIFormat. 

const (
	AnthropicMessages     AgentModelOverrideProviderAPIFormat = "anthropic-messages"
	OpenaiChatCompletions AgentModelOverrideProviderAPIFormat = "openai-chat-completions"
	OpenaiResponses       AgentModelOverrideProviderAPIFormat = "openai-responses"
)

Defines values for AgentModelOverrideProviderAPIFormat.

func (AgentModelOverrideProviderAPIFormat) Valid 

func (e AgentModelOverrideProviderAPIFormat) Valid() bool

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

type AgentModelOverrideProviderAPIVariant 

type AgentModelOverrideProviderAPIVariant string

AgentModelOverrideProviderAPIVariant defines model for AgentModelOverrideProvider.APIVariant. 

const (
	AgentModelOverrideProviderAPIVariantDefault    AgentModelOverrideProviderAPIVariant = "default"
	AgentModelOverrideProviderAPIVariantOpenrouter AgentModelOverrideProviderAPIVariant = "openrouter"
)

Defines values for AgentModelOverrideProviderAPIVariant.

func (AgentModelOverrideProviderAPIVariant) Valid 

func (e AgentModelOverrideProviderAPIVariant) Valid() bool

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

type AgentModelOverrideService 

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

AgentModelOverrideService groups the agents.modelOverride methods.

func (*AgentModelOverrideService) Delete 

func (s *AgentModelOverrideService) Delete(ctx context.Context, agentID string, opts ...option.RequestOption) error

Delete calls DeleteAgentModelOverride: DELETE /orgs/{orgID}/projects/{projectID}/agents/{agentID}/model-override.

func (*AgentModelOverrideService) Get 

func (s *AgentModelOverrideService) Get(ctx context.Context, agentID string, opts ...option.RequestOption) (*AgentModelOverrideEnvelope, error)

Get calls GetAgentModelOverride: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/model-override.

func (*AgentModelOverrideService) Set 

func (s *AgentModelOverrideService) Set(ctx context.Context, agentID string, params AgentModelOverrideSetParams, opts ...option.RequestOption) (*AgentModelOverrideEnvelope, error)

Set calls PutAgentModelOverride: PUT /orgs/{orgID}/projects/{projectID}/agents/{agentID}/model-override.

func (*AgentModelOverrideService) Update 

func (s *AgentModelOverrideService) Update(ctx context.Context, agentID string, params AgentModelOverrideUpdateParams, opts ...option.RequestOption) (*AgentModelOverrideEnvelope, error)

Update calls PatchAgentModelOverride: PATCH /orgs/{orgID}/projects/{projectID}/agents/{agentID}/model-override.

type AgentModelOverrideSetParams 

type AgentModelOverrideSetParams struct {
	APIKey                  *string
	AutoCompactWindowTokens *int
	ContextWindowTokens     *int
	ExpiresWithSession      *bool
	MaxOutputTokens         *int
	Model                   string
	Provider                *AgentModelOverrideProvider
	TTLSeconds              *int
}

AgentModelOverrideSetParams are the query, header and body fields of PutAgentModelOverride.

type AgentModelOverrideStatus 

type AgentModelOverrideStatus string

AgentModelOverrideStatus defines model for AgentModelOverride.Status. 

const (
	AgentModelOverrideStatusActive  AgentModelOverrideStatus = "active"
	AgentModelOverrideStatusExpired AgentModelOverrideStatus = "expired"
	AgentModelOverrideStatusRevoked AgentModelOverrideStatus = "revoked"
)

Defines values for AgentModelOverrideStatus.

func (AgentModelOverrideStatus) Valid 

func (e AgentModelOverrideStatus) Valid() bool

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

type AgentModelOverrideUpdateParams 

type AgentModelOverrideUpdateParams struct {
	APIKey     *string
	Model      *string
	Provider   *AgentModelOverrideProvider
	TTLSeconds *int
}

AgentModelOverrideUpdateParams are the query, header and body fields of PatchAgentModelOverride.

type AgentName 

type AgentName = string

AgentName Agent name. Empty means the agent is unnamed; non-empty values use the ResourceName policy.

type AgentNewParams 

type AgentNewParams struct {
	Config              *AgentConfigID
	ConfigSource        *CreateAgentConfigRequest
	InitialInput        *AgentLaunchInitialInput
	InteractionHandlers *map[string]AgentConfigDefinitionInteractionHandler
	Message             *string
	Name                *AgentName
	Profile             *AgentProfileID
	Subscriptions       *[]IntegrationSubscriptionAttachment
	Tools               *map[string]AgentConfigDefinitionTool
}

AgentNewParams are the query, header and body fields of createAgent.

type AgentNewResponse 

type AgentNewResponse struct {
	CurrentAgentResponse *CurrentAgentResponse // 200
	LaunchAgentResponse  *LaunchAgentResponse  // 201
}

AgentNewResponse holds the body of whichever success status createAgent returned.

type AgentProfile 

type AgentProfile struct {
	CreatedAt     Timestamp   `json:"created_at"`
	CurrentConfig AgentConfig `json:"current_config"`

	// CurrentConfigID Agent config ID (acfg_...).
	CurrentConfigID   AgentConfigID `json:"current_config_id"`
	CurrentGeneration int32         `json:"current_generation"`

	// Description Caller-owned free-text description of the profile.
	Description *string        `json:"description,omitempty"`
	ID          AgentProfileID `json:"id"`

	// Metadata Caller-owned labels of an agent profile (string keys and values).
	Metadata *AgentProfileMetadata `json:"metadata,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name  ResourceName   `json:"name"`
	OrgID OrganizationID `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`
	UpdatedAt Timestamp `json:"updated_at"`
}

AgentProfile defines model for AgentProfile.

type AgentProfileCronTriggerTarget 

type AgentProfileCronTriggerTarget struct {
	AgentProfileID AgentProfileID                    `json:"agent_profile_id"`
	Type           AgentProfileCronTriggerTargetType `json:"type"`
}

AgentProfileCronTriggerTarget defines model for AgentProfileCronTriggerTarget.

type AgentProfileCronTriggerTargetType 

type AgentProfileCronTriggerTargetType string

AgentProfileCronTriggerTargetType defines model for AgentProfileCronTriggerTarget.Type. 

const (
	Profile AgentProfileCronTriggerTargetType = "profile"
)

Defines values for AgentProfileCronTriggerTargetType.

func (AgentProfileCronTriggerTargetType) Valid 

func (e AgentProfileCronTriggerTargetType) Valid() bool

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

type AgentProfileEventWebhookScope 

type AgentProfileEventWebhookScope struct {
	AgentProfileID AgentProfileID                    `json:"agent_profile_id"`
	Type           AgentProfileEventWebhookScopeType `json:"type"`
}

AgentProfileEventWebhookScope defines model for AgentProfileEventWebhookScope.

type AgentProfileEventWebhookScopeType 

type AgentProfileEventWebhookScopeType string

AgentProfileEventWebhookScopeType defines model for AgentProfileEventWebhookScope.Type. 

const (
	AgentProfileEventWebhookScopeTypeProfile AgentProfileEventWebhookScopeType = "profile"
)

Defines values for AgentProfileEventWebhookScopeType.

func (AgentProfileEventWebhookScopeType) Valid 

func (e AgentProfileEventWebhookScopeType) Valid() bool

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

type AgentProfileID 

type AgentProfileID = string

AgentProfileID defines model for AgentProfileID.

type AgentProfileIncludeStats 

type AgentProfileIncludeStats = bool

AgentProfileIncludeStats defines model for AgentProfileIncludeStats.

type AgentProfileListParams 

type AgentProfileListParams struct {
	Name         *ResourceNameFilter
	IncludeStats *AgentProfileIncludeStats
	StatsSince   *AgentProfileStatsSince
	Sort         *ResourceListSort
	Limit        *PageLimit
	Cursor       *PageCursor
}

AgentProfileListParams are the query, header and body fields of listAgentProfiles.

type AgentProfileMetadata 

type AgentProfileMetadata map[string]string

AgentProfileMetadata Caller-owned labels of an agent profile (string keys and values).

type AgentProfileNewParams 

type AgentProfileNewParams struct {
	Config      AgentConfigID
	Description *string
	Metadata    *AgentProfileMetadata
	Name        ResourceName
}

AgentProfileNewParams are the query, header and body fields of createAgentProfile.

type AgentProfileRenameParams 

type AgentProfileRenameParams struct {
	Description *string
	Metadata    *AgentProfileMetadata
	Name        ResourceName
}

AgentProfileRenameParams are the query, header and body fields of renameAgentProfile.

type AgentProfileService 

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

AgentProfileService groups the agentProfiles methods.

func (*AgentProfileService) Delete 

func (s *AgentProfileService) Delete(ctx context.Context, agentProfileID string, opts ...option.RequestOption) error

Delete calls deleteAgentProfile: DELETE /orgs/{orgID}/projects/{projectID}/agent-profiles/{agentProfileID}.

func (*AgentProfileService) Get 

func (s *AgentProfileService) Get(ctx context.Context, agentProfileID string, opts ...option.RequestOption) (*AgentProfile, error)

Get calls getAgentProfile: GET /orgs/{orgID}/projects/{projectID}/agent-profiles/{agentProfileID}.

func (*AgentProfileService) List 

func (s *AgentProfileService) List(ctx context.Context, params AgentProfileListParams, opts ...option.RequestOption) (*CursorPage[AgentProfileSummary], error)

List calls listAgentProfiles: GET /orgs/{orgID}/projects/{projectID}/agent-profiles.

func (*AgentProfileService) ListAutoPaging 

func (s *AgentProfileService) ListAutoPaging(ctx context.Context, params AgentProfileListParams, opts ...option.RequestOption) *CursorPageAutoPager[AgentProfileSummary]

ListAutoPaging iterates every item of listAgentProfiles across pages.

func (*AgentProfileService) New 

func (s *AgentProfileService) New(ctx context.Context, params AgentProfileNewParams, opts ...option.RequestOption) (*AgentProfile, error)

New calls createAgentProfile: POST /orgs/{orgID}/projects/{projectID}/agent-profiles.

func (*AgentProfileService) Rename 

func (s *AgentProfileService) Rename(ctx context.Context, agentProfileID string, params AgentProfileRenameParams, opts ...option.RequestOption) (*AgentProfile, error)

Rename calls renameAgentProfile: PATCH /orgs/{orgID}/projects/{projectID}/agent-profiles/{agentProfileID}.

func (*AgentProfileService) UpdateConfig 

func (s *AgentProfileService) UpdateConfig(ctx context.Context, agentProfileID string, params AgentProfileUpdateConfigParams, opts ...option.RequestOption) (*AgentProfile, error)

UpdateConfig calls updateAgentProfile: POST /orgs/{orgID}/projects/{projectID}/agent-profiles/{agentProfileID}/config.

func (*AgentProfileService) Usage 

func (s *AgentProfileService) Usage(ctx context.Context, agentProfileID string, params AgentProfileUsageParams, opts ...option.RequestOption) (*UsageReport, error)

Usage calls getAgentProfileUsage: GET /orgs/{orgID}/projects/{projectID}/agent-profiles/{agentProfileID}/usage.

type AgentProfileStats 

type AgentProfileStats struct {
	// AgentCount Unarchived top-level agents launched from the profile.
	AgentCount int64       `json:"agent_count"`
	Usage      UsageTotals `json:"usage"`
}

AgentProfileStats Present when the list was requested with `include_stats`.

type AgentProfileStatsSince 

type AgentProfileStatsSince = time.Time

AgentProfileStatsSince defines model for AgentProfileStatsSince.

type AgentProfileSummary 

type AgentProfileSummary struct {
	CreatedAt     Timestamp          `json:"created_at"`
	CurrentConfig AgentConfigSummary `json:"current_config"`

	// CurrentConfigID Agent config ID (acfg_...).
	CurrentConfigID   AgentConfigID `json:"current_config_id"`
	CurrentGeneration int32         `json:"current_generation"`

	// Description Caller-owned free-text description of the profile.
	Description *string        `json:"description,omitempty"`
	ID          AgentProfileID `json:"id"`

	// Metadata Caller-owned labels of an agent profile (string keys and values).
	Metadata *AgentProfileMetadata `json:"metadata,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name  ResourceName   `json:"name"`
	OrgID OrganizationID `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// Stats Present when the list was requested with `include_stats`.
	Stats     *AgentProfileStats `json:"stats,omitempty"`
	UpdatedAt Timestamp          `json:"updated_at"`
}

AgentProfileSummary defines model for AgentProfileSummary.

type AgentProfileUpdateConfigParams 

type AgentProfileUpdateConfigParams struct {
	Config                  AgentConfigID
	ExpectedCurrentConfigID AgentConfigID
}

AgentProfileUpdateConfigParams are the query, header and body fields of updateAgentProfile.

type AgentProfileUsageParams 

type AgentProfileUsageParams struct {
	Since            *UsageSince
	Until            *UsageUntil
	IncludeSubagents *bool
}

AgentProfileUsageParams are the query, header and body fields of getAgentProfileUsage.

type AgentSequence 

type AgentSequence = int

AgentSequence Positive per-agent event, turn, or live-frame sequence.

type AgentSequenceCursor 

type AgentSequenceCursor = int

AgentSequenceCursor Non-negative agent timeline cursor.

type AgentService 

type AgentService struct {
	Sessions        *AgentSessionService
	Inputs          *AgentInputService
	Events          *AgentEventService
	Turns           *AgentTurnService
	ToolCalls       *AgentToolCallService
	Interactions    *AgentInteractionService
	Machines        *AgentMachineService
	ModelOverride   *AgentModelOverrideService
	ExecutorBinding *AgentExecutorBindingService
	Artifacts       *AgentArtifactService
	// contains filtered or unexported fields
}

AgentService groups the agents methods.

func (*AgentService) Archive 

func (s *AgentService) Archive(ctx context.Context, agentID string, opts ...option.RequestOption) (*CurrentAgentResponse, error)

Archive calls archiveAgent: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/archive.

func (*AgentService) Cancel 

func (s *AgentService) Cancel(ctx context.Context, agentID string, params AgentCancelParams, opts ...option.RequestOption) (*CancelAgentResponse, error)

Cancel calls cancelAgent: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/cancel.

func (*AgentService) Get 

func (s *AgentService) Get(ctx context.Context, agentID string, opts ...option.RequestOption) (*GetAgentResponse, error)

Get calls getAgent: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}.

func (*AgentService) List 

func (s *AgentService) List(ctx context.Context, params AgentListParams, opts ...option.RequestOption) (*CursorPage[Agent], error)

List calls listAgents: GET /orgs/{orgID}/projects/{projectID}/agents.

func (*AgentService) ListAutoPaging 

func (s *AgentService) ListAutoPaging(ctx context.Context, params AgentListParams, opts ...option.RequestOption) *CursorPageAutoPager[Agent]

ListAutoPaging iterates every item of listAgents across pages.

func (*AgentService) New 

func (s *AgentService) New(ctx context.Context, params AgentNewParams, opts ...option.RequestOption) (*AgentNewResponse, error)

New calls createAgent: POST /orgs/{orgID}/projects/{projectID}/agents.

func (*AgentService) UpdateConfig 

func (s *AgentService) UpdateConfig(ctx context.Context, agentID string, params AgentUpdateConfigParams, opts ...option.RequestOption) (*UpdateAgentConfigResponse, error)

UpdateConfig calls updateAgentConfig: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/config.

func (*AgentService) Usage 

func (s *AgentService) Usage(ctx context.Context, agentID string, params AgentUsageParams, opts ...option.RequestOption) (*UsageReport, error)

Usage calls getAgentUsage: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/usage.

type AgentSession 

type AgentSession struct {
	AgentConfigID string     `json:"agent_config_id"`
	AgentID       string     `json:"agent_id"`
	ArchivedAt    *time.Time `json:"archived_at,omitempty"`

	// ConfigOrigin `agent` follows agents.current_config_id (the default session only); `session` pins this session to its immutable agent_config_id.
	ConfigOrigin AgentSessionConfigOrigin `json:"config_origin"`
	CreatedAt    time.Time                `json:"created_at"`

	// EnvironmentID Opaque UHP environment reference.
	EnvironmentID     *string                `json:"environment_id,omitempty"`
	ID                string                 `json:"id"`
	IsDefault         bool                   `json:"is_default"`
	Metadata          map[string]interface{} `json:"metadata"`
	NextEventSequence int64                  `json:"next_event_sequence"`
	NextTurnSequence  int64                  `json:"next_turn_sequence"`
	OrgID             string                 `json:"org_id"`
	ProjectID         string                 `json:"project_id"`
	State             AgentSessionState      `json:"state"`

	// Status Runtime status of this session's own execution. `idle` has no work in flight, including while an open permission or question waits for the caller. `running` has a live turn or queued work with a machine that can execute it. `rescheduling` has queued work but no machine that can run it yet, so BMA retries after the machine is provisioned, resumed or restored. `terminated` is an archived session; its history stays readable.
	Status    AgentSessionStatus `json:"status"`
	UpdatedAt time.Time          `json:"updated_at"`
}

AgentSession defines model for AgentSession.

type AgentSessionArtifactListParams 

type AgentSessionArtifactListParams struct {
	Limit  *int32
	Cursor *string
}

AgentSessionArtifactListParams are the query, header and body fields of listSessionArtifacts.

type AgentSessionArtifactPromoteParams 

type AgentSessionArtifactPromoteParams struct {
	Filename *string
	Metadata *map[string]string
	Scope    *PromoteSessionArtifactRequestScope
}

AgentSessionArtifactPromoteParams are the query, header and body fields of promoteSessionArtifact.

type AgentSessionArtifactService 

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

AgentSessionArtifactService groups the agents.sessions.artifacts methods.

func (*AgentSessionArtifactService) Download 

func (s *AgentSessionArtifactService) Download(ctx context.Context, agentID string, sessionID string, artifactID string, opts ...option.RequestOption) (*http.Response, error)

Download calls getSessionArtifactContent: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}/artifacts/{artifactID}/content. The caller closes the response body.

func (*AgentSessionArtifactService) List 

func (s *AgentSessionArtifactService) List(ctx context.Context, agentID string, sessionID string, params AgentSessionArtifactListParams, opts ...option.RequestOption) (*CursorPage[Artifact], error)

List calls listSessionArtifacts: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}/artifacts.

func (*AgentSessionArtifactService) ListAutoPaging 

func (s *AgentSessionArtifactService) ListAutoPaging(ctx context.Context, agentID string, sessionID string, params AgentSessionArtifactListParams, opts ...option.RequestOption) *CursorPageAutoPager[Artifact]

ListAutoPaging iterates every item of listSessionArtifacts across pages.

func (*AgentSessionArtifactService) Promote 

func (s *AgentSessionArtifactService) Promote(ctx context.Context, agentID string, sessionID string, artifactID string, params AgentSessionArtifactPromoteParams, opts ...option.RequestOption) (*File, error)

Promote calls promoteSessionArtifact: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}/artifacts/{artifactID}/promote.

func (*AgentSessionArtifactService) Upload 

func (s *AgentSessionArtifactService) Upload(ctx context.Context, agentID string, sessionID string, params AgentSessionArtifactUploadParams, opts ...option.RequestOption) (*Artifact, error)

Upload calls uploadSessionArtifact: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}/artifacts.

type AgentSessionArtifactUploadParams 

type AgentSessionArtifactUploadParams struct {
	Filename string
	Body     io.Reader
}

AgentSessionArtifactUploadParams are the query, header and body fields of uploadSessionArtifact.

type AgentSessionCancelParams 

type AgentSessionCancelParams struct {
	Actor *ExternalActorParams
}

AgentSessionCancelParams are the query, header and body fields of cancelAgentSession.

type AgentSessionConfigOrigin 

type AgentSessionConfigOrigin string

AgentSessionConfigOrigin `agent` follows agents.current_config_id (the default session only); `session` pins this session to its immutable agent_config_id. 

const (
	AgentSessionConfigOriginAgent   AgentSessionConfigOrigin = "agent"
	AgentSessionConfigOriginSession AgentSessionConfigOrigin = "session"
)

Defines values for AgentSessionConfigOrigin.

func (AgentSessionConfigOrigin) Valid 

func (e AgentSessionConfigOrigin) Valid() bool

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

type AgentSessionEnvelope 

type AgentSessionEnvelope struct {
	Session AgentSession `json:"session"`
}

AgentSessionEnvelope defines model for AgentSessionEnvelope.

type AgentSessionListParams 

type AgentSessionListParams struct {
	IncludeArchived *bool
	BeforeID        *string
	Limit           *int32
}

AgentSessionListParams are the query, header and body fields of listAgentSessions.

type AgentSessionModelOverrideService 

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

AgentSessionModelOverrideService groups the agents.sessions.modelOverride methods.

func (*AgentSessionModelOverrideService) Delete 

func (s *AgentSessionModelOverrideService) Delete(ctx context.Context, agentID string, sessionID string, opts ...option.RequestOption) error

Delete calls DeleteAgentSessionModelOverride: DELETE /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}/model-override.

func (*AgentSessionModelOverrideService) Get 

func (s *AgentSessionModelOverrideService) Get(ctx context.Context, agentID string, sessionID string, opts ...option.RequestOption) (*AgentModelOverrideEnvelope, error)

Get calls GetAgentSessionModelOverride: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}/model-override.

func (*AgentSessionModelOverrideService) Set 

func (s *AgentSessionModelOverrideService) Set(ctx context.Context, agentID string, sessionID string, params AgentSessionModelOverrideSetParams, opts ...option.RequestOption) (*AgentModelOverrideEnvelope, error)

Set calls PutAgentSessionModelOverride: PUT /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}/model-override.

func (*AgentSessionModelOverrideService) Update 

func (s *AgentSessionModelOverrideService) Update(ctx context.Context, agentID string, sessionID string, params AgentSessionModelOverrideUpdateParams, opts ...option.RequestOption) (*AgentModelOverrideEnvelope, error)

Update calls PatchAgentSessionModelOverride: PATCH /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}/model-override.

type AgentSessionModelOverrideSetParams 

type AgentSessionModelOverrideSetParams struct {
	APIKey                  *string
	AutoCompactWindowTokens *int
	ContextWindowTokens     *int
	ExpiresWithSession      *bool
	MaxOutputTokens         *int
	Model                   string
	Provider                *AgentModelOverrideProvider
	TTLSeconds              *int
}

AgentSessionModelOverrideSetParams are the query, header and body fields of PutAgentSessionModelOverride.

type AgentSessionModelOverrideUpdateParams 

type AgentSessionModelOverrideUpdateParams struct {
	APIKey     *string
	Model      *string
	Provider   *AgentModelOverrideProvider
	TTLSeconds *int
}

AgentSessionModelOverrideUpdateParams are the query, header and body fields of PatchAgentSessionModelOverride.

type AgentSessionNewParams 

type AgentSessionNewParams struct {
	AgentConfigID  *string
	ConfigSource   *CreateAgentConfigRequest
	EnvironmentID  *openapi_types.UUID
	IdempotencyKey *string
	Metadata       *map[string]interface{}
	ModelOverride  *AgentModelOverrideInput
	Resources      *[]FileResourceParams
}

AgentSessionNewParams are the query, header and body fields of createAgentSession.

type AgentSessionResourceAddParams 

type AgentSessionResourceAddParams struct {
	FileID    FileID
	MountPath *string
	Type      FileResourceParamsType
}

AgentSessionResourceAddParams are the query, header and body fields of addSessionResource.

type AgentSessionResourceService 

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

AgentSessionResourceService groups the agents.sessions.resources methods.

func (*AgentSessionResourceService) Add 

func (s *AgentSessionResourceService) Add(ctx context.Context, agentID string, sessionID string, params AgentSessionResourceAddParams, opts ...option.RequestOption) (*SessionFileResource, error)

Add calls addSessionResource: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}/resources.

func (*AgentSessionResourceService) Delete 

func (s *AgentSessionResourceService) Delete(ctx context.Context, agentID string, sessionID string, resourceID string, opts ...option.RequestOption) (*DeletedSessionResource, error)

Delete calls deleteSessionResource: DELETE /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}/resources/{resourceID}.

func (*AgentSessionResourceService) List 

func (s *AgentSessionResourceService) List(ctx context.Context, agentID string, sessionID string, opts ...option.RequestOption) (*SessionFileResourceList, error)

List calls listSessionResources: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}/resources.

type AgentSessionService 

type AgentSessionService struct {
	ModelOverride *AgentSessionModelOverrideService
	Artifacts     *AgentSessionArtifactService
	Resources     *AgentSessionResourceService
	// contains filtered or unexported fields
}

AgentSessionService groups the agents.sessions methods.

func (*AgentSessionService) Archive 

func (s *AgentSessionService) Archive(ctx context.Context, agentID string, sessionID string, opts ...option.RequestOption) (*AgentSessionEnvelope, error)

Archive calls archiveAgentSession: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}/archive.

func (*AgentSessionService) Cancel 

func (s *AgentSessionService) Cancel(ctx context.Context, agentID string, sessionID string, params AgentSessionCancelParams, opts ...option.RequestOption) (*CancelAgentResponse, error)

Cancel calls cancelAgentSession: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}/cancel.

func (*AgentSessionService) Get 

func (s *AgentSessionService) Get(ctx context.Context, agentID string, sessionID string, opts ...option.RequestOption) (*AgentSessionEnvelope, error)

Get calls getAgentSession: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}.

func (*AgentSessionService) List 

func (s *AgentSessionService) List(ctx context.Context, agentID string, params AgentSessionListParams, opts ...option.RequestOption) (*CursorPage[AgentSession], error)

List calls listAgentSessions: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions.

func (*AgentSessionService) ListAutoPaging 

func (s *AgentSessionService) ListAutoPaging(ctx context.Context, agentID string, params AgentSessionListParams, opts ...option.RequestOption) *CursorPageAutoPager[AgentSession]

ListAutoPaging iterates every item of listAgentSessions across pages.

func (*AgentSessionService) New 

func (s *AgentSessionService) New(ctx context.Context, agentID string, params AgentSessionNewParams, opts ...option.RequestOption) (*AgentSessionEnvelope, error)

New calls createAgentSession: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions.

func (*AgentSessionService) Update 

func (s *AgentSessionService) Update(ctx context.Context, agentID string, sessionID string, params AgentSessionUpdateParams, opts ...option.RequestOption) (*AgentSessionEnvelope, error)

Update calls updateAgentSession: PATCH /orgs/{orgID}/projects/{projectID}/agents/{agentID}/sessions/{sessionID}.

type AgentSessionState 

type AgentSessionState string

AgentSessionState defines model for AgentSession.State. 

const (
	Active   AgentSessionState = "active"
	Archived AgentSessionState = "archived"
)

Defines values for AgentSessionState.

func (AgentSessionState) Valid 

func (e AgentSessionState) Valid() bool

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

type AgentSessionStatus 

type AgentSessionStatus string

AgentSessionStatus Runtime status of this session's own execution. `idle` has no work in flight, including while an open permission or question waits for the caller. `running` has a live turn or queued work with a machine that can execute it. `rescheduling` has queued work but no machine that can run it yet, so BMA retries after the machine is provisioned, resumed or restored. `terminated` is an archived session; its history stays readable. 

const (
	AgentSessionStatusIdle         AgentSessionStatus = "idle"
	AgentSessionStatusRescheduling AgentSessionStatus = "rescheduling"
	AgentSessionStatusRunning      AgentSessionStatus = "running"
	AgentSessionStatusTerminated   AgentSessionStatus = "terminated"
)

Defines values for AgentSessionStatus.

func (AgentSessionStatus) Valid 

func (e AgentSessionStatus) Valid() bool

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

type AgentSessionUpdateParams 

type AgentSessionUpdateParams struct {
	AgentConfigID     *string
	EnvironmentID     *openapi_types.UUID
	ExpectedUpdatedAt *time.Time
	Metadata          *map[string]interface{}
}

AgentSessionUpdateParams are the query, header and body fields of updateAgentSession.

type AgentState 

type AgentState string

AgentState defines model for Agent.State. 

const (
	AgentStateActive   AgentState = "active"
	AgentStateArchived AgentState = "archived"
)

Defines values for AgentState.

func (AgentState) Valid 

func (e AgentState) Valid() bool

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

type AgentStreamEvent 

type AgentStreamEvent = StreamEventsEvent

AgentStreamEvent is one frame of Agents.Events.Stream.

type AgentToolCallListParams 

type AgentToolCallListParams struct {
	State            *ToolCallState
	Type             *ToolCallType
	IncludeSubagents *bool
	Limit            *PageLimit
	Cursor           *PageCursor
}

AgentToolCallListParams are the query, header and body fields of listToolCalls.

type AgentToolCallService 

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

AgentToolCallService groups the agents.toolCalls methods.

func (*AgentToolCallService) Get 

func (s *AgentToolCallService) Get(ctx context.Context, agentID string, toolCallID string, opts ...option.RequestOption) (*ToolCallEnvelope, error)

Get calls getToolCall: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/tool-calls/{toolCallID}.

func (*AgentToolCallService) List 

func (s *AgentToolCallService) List(ctx context.Context, agentID string, params AgentToolCallListParams, opts ...option.RequestOption) (*CursorPage[ToolCall], error)

List calls listToolCalls: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/tool-calls.

func (*AgentToolCallService) ListAutoPaging 

func (s *AgentToolCallService) ListAutoPaging(ctx context.Context, agentID string, params AgentToolCallListParams, opts ...option.RequestOption) *CursorPageAutoPager[ToolCall]

ListAutoPaging iterates every item of listToolCalls across pages.

func (*AgentToolCallService) Runner 

func (s *AgentToolCallService) Runner(agentID string, params ToolRunnerParams, opts ...option.RequestOption) *ToolRunner

Runner returns a runner for agentID; call Run.

func (*AgentToolCallService) SubmitResult 

func (s *AgentToolCallService) SubmitResult(ctx context.Context, agentID string, toolCallID string, params AgentToolCallSubmitResultParams, opts ...option.RequestOption) (*SubmitToolCallResultResponse, error)

SubmitResult calls submitToolCallResult: POST /orgs/{orgID}/projects/{projectID}/agents/{agentID}/tool-calls/{toolCallID}/result.

type AgentToolCallSubmitResultParams 

type AgentToolCallSubmitResultParams struct {
	ContentBlocks []SubmitToolResultContentBlock
	Outcome       SubmitToolCallResultRequestOutcome
}

AgentToolCallSubmitResultParams are the query, header and body fields of submitToolCallResult.

type AgentTurn 

type AgentTurn struct {
	AgentID AgentID `json:"agent_id"`

	// EventCount Positive count within an agent timeline.
	EventCount          AgentCount   `json:"event_count"`
	ID                  AgentTurnID  `json:"id"`
	LatestEvent         *AgentEvent  `json:"latest_event,omitempty"`
	LatestSemanticEvent *AgentEvent  `json:"latest_semantic_event,omitempty"`
	OpeningEvents       []AgentEvent `json:"opening_events"`
	StartedAt           Timestamp    `json:"started_at"`

	// TurnSequence Positive per-agent event, turn, or live-frame sequence.
	TurnSequence AgentSequence `json:"turn_sequence"`
	UpdatedAt    Timestamp     `json:"updated_at"`
}

AgentTurn defines model for AgentTurn.

type AgentTurnEventListParams 

type AgentTurnEventListParams struct {
	SessionID      *string
	BeforeSequence *int64
	Limit          *int32
}

AgentTurnEventListParams are the query, header and body fields of listTurnEvents.

type AgentTurnEventService 

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

AgentTurnEventService groups the agents.turns.events methods.

func (*AgentTurnEventService) List 

func (s *AgentTurnEventService) List(ctx context.Context, agentID string, turnID string, params AgentTurnEventListParams, opts ...option.RequestOption) (*CursorPage[AgentEvent], error)

List calls listTurnEvents: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/turns/{turnID}/events.

func (*AgentTurnEventService) ListAutoPaging 

func (s *AgentTurnEventService) ListAutoPaging(ctx context.Context, agentID string, turnID string, params AgentTurnEventListParams, opts ...option.RequestOption) *CursorPageAutoPager[AgentEvent]

ListAutoPaging iterates every item of listTurnEvents across pages.

type AgentTurnID 

type AgentTurnID = string

AgentTurnID defines model for AgentTurnID.

type AgentTurnListParams 

type AgentTurnListParams struct {
	SessionID          *string
	BeforeTurnSequence *int64
	Limit              *int32
}

AgentTurnListParams are the query, header and body fields of listTurns.

type AgentTurnService 

type AgentTurnService struct {
	Events *AgentTurnEventService
	// contains filtered or unexported fields
}

AgentTurnService groups the agents.turns methods.

func (*AgentTurnService) List 

func (s *AgentTurnService) List(ctx context.Context, agentID string, params AgentTurnListParams, opts ...option.RequestOption) (*CursorPage[AgentTurn], error)

List calls listTurns: GET /orgs/{orgID}/projects/{projectID}/agents/{agentID}/turns.

func (*AgentTurnService) ListAutoPaging 

func (s *AgentTurnService) ListAutoPaging(ctx context.Context, agentID string, params AgentTurnListParams, opts ...option.RequestOption) *CursorPageAutoPager[AgentTurn]

ListAutoPaging iterates every item of listTurns across pages.

type AgentUpdateConfigParams 

type AgentUpdateConfigParams struct {
	ExpectedCurrentConfigID *AgentConfigID
	Source                  AgentConfigSourceInput
	SourceFormat            UpdateAgentConfigRequestSourceFormat
}

AgentUpdateConfigParams are the query, header and body fields of updateAgentConfig.

type AgentUsageParams 

type AgentUsageParams struct {
	Since            *UsageSince
	Until            *UsageUntil
	IncludeSubagents *bool
}

AgentUsageParams are the query, header and body fields of getAgentUsage.

type Artifact 

type Artifact struct {
	AgentID     AgentID        `json:"agent_id"`
	ContentType *string        `json:"content_type,omitempty"`
	CreatedAt   Timestamp      `json:"created_at"`
	Digest      *string        `json:"digest,omitempty"`
	Filename    *string        `json:"filename,omitempty"`
	ID          ArtifactID     `json:"id"`
	OrgID       OrganizationID `json:"org_id"`

	// Origin input: uploaded to the session, sent as message media or received from an integration. machine_upload: uploaded by the agent from its machine (storage_upload). tool_output: written by a tool (oversized results, MCP media, viewed images).
	Origin *ArtifactOrigin `json:"origin,omitempty"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// SessionID Session that owns the artifact; absent for an agent-level artifact.
	SessionID *string `json:"session_id,omitempty"`
	SizeBytes *int64  `json:"size_bytes,omitempty"`
}

Artifact defines model for Artifact.

type ArtifactID 

type ArtifactID = string

ArtifactID defines model for ArtifactID.

type ArtifactOrigin 

type ArtifactOrigin string

ArtifactOrigin input: uploaded to the session, sent as message media or received from an integration. machine_upload: uploaded by the agent from its machine (storage_upload). tool_output: written by a tool (oversized results, MCP media, viewed images). 

const (
	Input         ArtifactOrigin = "input"
	MachineUpload ArtifactOrigin = "machine_upload"
	ToolOutput    ArtifactOrigin = "tool_output"
)

Defines values for ArtifactOrigin.

func (ArtifactOrigin) Valid 

func (e ArtifactOrigin) Valid() bool

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

type BadRequest 

type BadRequest = ErrorBody

BadRequest defines model for BadRequest.

type BootstrapDaemonResponse 

type BootstrapDaemonResponse struct {
	InstallationID InstallationID `json:"installation_id"`

	// MachineID Machine ID (mch_...).
	MachineID MachineID `json:"machine_id"`
}

BootstrapDaemonResponse defines model for BootstrapDaemonResponse.

type CancelAgentJSONRequestBody 

type CancelAgentJSONRequestBody = CancelAgentRequest

CancelAgentJSONRequestBody defines body for CancelAgent for application/json ContentType.

type CancelAgentRequest 

type CancelAgentRequest struct {
	// Actor Identity and attributes of an external actor. Actors are upserted by (provider_tenant_id, provider_user_id) with the external provider. Omitted attributes keep their stored values; provided attributes are overwritten, including empty values. bma actors are implicit and hosted integrations own their own actor identities.
	Actor *ExternalActorParams `json:"actor,omitempty"`
}

CancelAgentRequest defines model for CancelAgentRequest.

type CancelAgentResponse 

type CancelAgentResponse struct {
	ActorID *ActorID `json:"actor_id,omitempty"`

	// Affected Whether this request changed any cancelable work.
	Affected bool        `json:"affected"`
	Event    *AgentEvent `json:"event"`

	// RuntimeCancelRequested Whether this request created or observed a durable runtime cancel request. Immediate delivery is best effort; runtime-lock renewal observes the durable request.
	RuntimeCancelRequested bool `json:"runtime_cancel_requested"`
}

CancelAgentResponse defines model for CancelAgentResponse.

type CancelAgentSessionJSONRequestBody 

type CancelAgentSessionJSONRequestBody = CancelAgentRequest

CancelAgentSessionJSONRequestBody defines body for CancelAgentSession for application/json ContentType.

type ChatIntegrationLauncher 

type ChatIntegrationLauncher struct {
	// Profiles One profile launches immediately; several offer a choice of exactly one.
	Profiles []AgentProfileID `json:"profiles"`
}

ChatIntegrationLauncher defines model for ChatIntegrationLauncher.

type ChatIntegrationSettings 

type ChatIntegrationSettings struct {
	Launcher *ChatIntegrationLauncher `json:"launcher,omitempty"`
}

ChatIntegrationSettings defines model for ChatIntegrationSettings.

type CheckMachinePoolConnectionJSONRequestBody 

type CheckMachinePoolConnectionJSONRequestBody = CheckMachinePoolConnectionRequest

CheckMachinePoolConnectionJSONRequestBody defines body for CheckMachinePoolConnection for application/json ContentType.

type CheckMachinePoolConnectionRequest 

type CheckMachinePoolConnectionRequest struct {
	DefaultMachineProviderOptions *map[string]interface{} `json:"default_machine_provider_options,omitempty"`
	Provider                      string                  `json:"provider"`

	// ProviderAuthSecretID Secret ID (sec_...).
	ProviderAuthSecretID SecretID                `json:"provider_auth_secret_id"`
	ProviderConfig       *map[string]interface{} `json:"provider_config,omitempty"`
}

CheckMachinePoolConnectionRequest defines model for CheckMachinePoolConnectionRequest.

type Client 

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

Client is the BMA REST client. Its fields are the top-level resources.

func NewClient 

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

NewClient returns a client. Options set defaults for every request: option.WithToken (default BMA_TOKEN; required), option.WithBaseURL (the deployment origin; default BMA_BASE_URL, else DefaultBaseURL), option.WithOrg / option.WithProject (default BMA_ORG_ID / BMA_PROJECT_ID), option.WithMaxRetries (default 2), option.WithRequestTimeout (default 60s; 0 disables it). A missing token or an invalid base URL is reported by the first request.

type ClientError 

type ClientError struct {
	// Code Stable error code carried by 4XX statuses. Subset of the Error code enum whose statuses are client errors.
	Code ClientErrorCode `json:"code"`

	// Error Human-readable error message. Do not match on it programmatically.
	Error string `json:"error"`
}

ClientError defines model for ClientError.

type ClientErrorCode 

type ClientErrorCode = string

ClientErrorCode Stable error code carried by 4XX statuses. Subset of the Error code enum whose statuses are client errors.

type CompiledAgentConfig 

type CompiledAgentConfig struct {
	// GitCredentials Pinned GitHub integration supplying machine Git credentials, optionally limited to repositories and read-only access.
	GitCredentials *CompiledGitCredentials `json:"git_credentials,omitempty"`

	// Harness Experimental. A non-default harness; absent for the BMA harness on the server. Where it runs is not part of the agent config: it follows the session's machine sources.
	Harness             *CompiledHarness                          `json:"harness,omitempty"`
	Instruction         string                                    `json:"instruction"`
	InteractionHandlers *map[string]CompiledIntegrationCapability `json:"interaction_handlers,omitempty"`
	MachineSources      *[]CompiledMachineSource                  `json:"machine_sources,omitempty"`
	MaxDepth            *int                                      `json:"max_depth,omitempty"`
	MaxSubagents        *int                                      `json:"max_subagents,omitempty"`
	Mcp                 *map[string]CompiledMCPServer             `json:"mcp,omitempty"`
	MemoryStores        *[]CompiledMemoryStore                    `json:"memory_stores,omitempty"`
	Model               CompiledAgentModel                        `json:"model"`
	Skills              *[]CompiledSkill                          `json:"skills,omitempty"`
	Subagents           *map[string]CompiledSubagent              `json:"subagents,omitempty"`
	Tools               *map[string]CompiledTool                  `json:"tools,omitempty"`
	Version             *string                                   `json:"version,omitempty"`
}

CompiledAgentConfig Read-only saved compiled configuration, including default tools and derived subagent overrides.

type CompiledAgentModel 

type CompiledAgentModel struct {
	// CacheRetention Prompt-cache preference for model requests; `short` when omitted. `short` applies the route's default caching (explicit cache breakpoints where the provider requires them) and, where the route accepts one, a stable conversation key for cache-aware routing. `long` prefers the route's extended cache lifetime where one exists (currently Anthropic's one-hour cache, which on Bedrock requires Claude 4.5 or newer) and behaves like `short` elsewhere. `none` sends no BMA-managed cache controls or conversation key; providers may still cache prefixes on their own.
	CacheRetention         *ModelCacheRetention    `json:"cache_retention,omitempty"`
	ConfiguredModelID      ConfiguredModelID       `json:"configured_model_id"`
	ContextWindowTokens    *int                    `json:"context_window_tokens,omitempty"`
	DefaultMaxOutputTokens *int                    `json:"default_max_output_tokens,omitempty"`
	Reasoning              *CompiledModelReasoning `json:"reasoning,omitempty"`
}

CompiledAgentModel defines model for CompiledAgentModel.

type CompiledGitCredentials 

type CompiledGitCredentials struct {
	// Integration Immutable, project-unique integration name used in config keys and qualified tool names.
	Integration   IntegrationName `json:"integration"`
	IntegrationID IntegrationID   `json:"integration_id"`
	ReadOnly      *bool           `json:"read_only,omitempty"`
	RepositoryIDs *[]int64        `json:"repository_ids,omitempty"`
}

CompiledGitCredentials Pinned GitHub integration supplying machine Git credentials, optionally limited to repositories and read-only access.

type CompiledHarness 

type CompiledHarness struct {
	Agent string              `json:"agent"`
	Kind  CompiledHarnessKind `json:"kind"`
}

CompiledHarness Experimental. A non-default harness; absent for the BMA harness on the server. Where it runs is not part of the agent config: it follows the session's machine sources.

type CompiledHarnessKind 

type CompiledHarnessKind string

CompiledHarnessKind defines model for CompiledHarness.Kind. 

const (
	Acp CompiledHarnessKind = "acp"
)

Defines values for CompiledHarnessKind.

func (CompiledHarnessKind) Valid 

func (e CompiledHarnessKind) Valid() bool

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

type CompiledIntegrationCapability 

type CompiledIntegrationCapability struct {
	IntegrationID IntegrationID `json:"integration_id"`
}

CompiledIntegrationCapability defines model for CompiledIntegrationCapability.

type CompiledMCPAuth 

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

CompiledMCPAuth defines model for CompiledMCPAuth.

func (CompiledMCPAuth) AsAny 

func (t CompiledMCPAuth) AsAny() any

AsAny returns the member of CompiledMCPAuth named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (CompiledMCPAuth) AsCompiledMCPAuthBearer 

func (t CompiledMCPAuth) AsCompiledMCPAuthBearer() (CompiledMCPAuthBearer, error)

AsCompiledMCPAuthBearer returns the union data inside the CompiledMCPAuth as a CompiledMCPAuthBearer

func (CompiledMCPAuth) AsCompiledMCPAuthOAuth 

func (t CompiledMCPAuth) AsCompiledMCPAuthOAuth() (CompiledMCPAuthOAuth, error)

AsCompiledMCPAuthOAuth returns the union data inside the CompiledMCPAuth as a CompiledMCPAuthOAuth

func (CompiledMCPAuth) AsCompiledMCPAuthSigV4 

func (t CompiledMCPAuth) AsCompiledMCPAuthSigV4() (CompiledMCPAuthSigV4, error)

AsCompiledMCPAuthSigV4 returns the union data inside the CompiledMCPAuth as a CompiledMCPAuthSigV4

func (CompiledMCPAuth) Discriminator 

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

func (*CompiledMCPAuth) FromCompiledMCPAuthBearer 

func (t *CompiledMCPAuth) FromCompiledMCPAuthBearer(v CompiledMCPAuthBearer) error

FromCompiledMCPAuthBearer overwrites any union data inside the CompiledMCPAuth as the provided CompiledMCPAuthBearer

func (*CompiledMCPAuth) FromCompiledMCPAuthOAuth 

func (t *CompiledMCPAuth) FromCompiledMCPAuthOAuth(v CompiledMCPAuthOAuth) error

FromCompiledMCPAuthOAuth overwrites any union data inside the CompiledMCPAuth as the provided CompiledMCPAuthOAuth

func (*CompiledMCPAuth) FromCompiledMCPAuthSigV4 

func (t *CompiledMCPAuth) FromCompiledMCPAuthSigV4(v CompiledMCPAuthSigV4) error

FromCompiledMCPAuthSigV4 overwrites any union data inside the CompiledMCPAuth as the provided CompiledMCPAuthSigV4

func (CompiledMCPAuth) MarshalJSON 

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

func (*CompiledMCPAuth) MergeCompiledMCPAuthBearer 

func (t *CompiledMCPAuth) MergeCompiledMCPAuthBearer(v CompiledMCPAuthBearer) error

MergeCompiledMCPAuthBearer performs a merge with any union data inside the CompiledMCPAuth, using the provided CompiledMCPAuthBearer

func (*CompiledMCPAuth) MergeCompiledMCPAuthOAuth 

func (t *CompiledMCPAuth) MergeCompiledMCPAuthOAuth(v CompiledMCPAuthOAuth) error

MergeCompiledMCPAuthOAuth performs a merge with any union data inside the CompiledMCPAuth, using the provided CompiledMCPAuthOAuth

func (*CompiledMCPAuth) MergeCompiledMCPAuthSigV4 

func (t *CompiledMCPAuth) MergeCompiledMCPAuthSigV4(v CompiledMCPAuthSigV4) error

MergeCompiledMCPAuthSigV4 performs a merge with any union data inside the CompiledMCPAuth, using the provided CompiledMCPAuthSigV4

func (*CompiledMCPAuth) UnmarshalJSON 

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

func (CompiledMCPAuth) ValueByDiscriminator 

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

type CompiledMCPAuthBearer 

type CompiledMCPAuthBearer struct {
	// SecretID Secret ID (sec_...).
	SecretID SecretID                  `json:"secret_id"`
	Type     CompiledMCPAuthBearerType `json:"type"`
}

CompiledMCPAuthBearer defines model for CompiledMCPAuthBearer.

type CompiledMCPAuthBearerType 

type CompiledMCPAuthBearerType string

CompiledMCPAuthBearerType defines model for CompiledMCPAuthBearer.Type. 

const (
	CompiledMCPAuthBearerTypeBearer CompiledMCPAuthBearerType = "bearer"
)

Defines values for CompiledMCPAuthBearerType.

func (CompiledMCPAuthBearerType) Valid 

func (e CompiledMCPAuthBearerType) Valid() bool

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

type CompiledMCPAuthOAuth 

type CompiledMCPAuthOAuth struct {
	// SecretID Secret ID (sec_...).
	SecretID SecretID                 `json:"secret_id"`
	Type     CompiledMCPAuthOAuthType `json:"type"`
}

CompiledMCPAuthOAuth defines model for CompiledMCPAuthOAuth.

type CompiledMCPAuthOAuthType 

type CompiledMCPAuthOAuthType string

CompiledMCPAuthOAuthType defines model for CompiledMCPAuthOAuth.Type. 

const (
	CompiledMCPAuthOAuthTypeOAuth CompiledMCPAuthOAuthType = "oauth"
)

Defines values for CompiledMCPAuthOAuthType.

func (CompiledMCPAuthOAuthType) Valid 

func (e CompiledMCPAuthOAuthType) Valid() bool

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

type CompiledMCPAuthSigV4 

type CompiledMCPAuthSigV4 struct {
	Region string `json:"region"`

	// SecretID Secret ID (sec_...).
	SecretID SecretID                 `json:"secret_id"`
	Service  string                   `json:"service"`
	Type     CompiledMCPAuthSigV4Type `json:"type"`
}

CompiledMCPAuthSigV4 defines model for CompiledMCPAuthSigV4.

type CompiledMCPAuthSigV4Type 

type CompiledMCPAuthSigV4Type string

CompiledMCPAuthSigV4Type defines model for CompiledMCPAuthSigV4.Type. 

const (
	CompiledMCPAuthSigV4TypeSigV4 CompiledMCPAuthSigV4Type = "sigv4"
)

Defines values for CompiledMCPAuthSigV4Type.

func (CompiledMCPAuthSigV4Type) Valid 

func (e CompiledMCPAuthSigV4Type) Valid() bool

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

type CompiledMCPServer 

type CompiledMCPServer struct {
	Auth *CompiledMCPAuth `json:"auth,omitempty"`

	// ConnectionOrigin Who connects an MCP server. `environment` means the executor starts or connects it in its own credential scope; `service` means the harness connects it and keeps its credentials.
	ConnectionOrigin *MCPConnectionOrigin        `json:"connection_origin,omitempty"`
	DefaultEnabled   bool                        `json:"default_enabled"`
	Deferred         *bool                       `json:"deferred,omitempty"`
	Permission       ToolPermissionSelection     `json:"permission"`
	Tools            *map[string]CompiledMCPTool `json:"tools,omitempty"`

	// Transport Transport of an environment-origin MCP server.
	Transport *CompiledMCPTransport `json:"transport,omitempty"`
	URL       *string               `json:"url,omitempty"`
}

CompiledMCPServer defines model for CompiledMCPServer.

type CompiledMCPTool 

type CompiledMCPTool struct {
	Deferred   *bool                    `json:"deferred,omitempty"`
	Enabled    *bool                    `json:"enabled,omitempty"`
	Permission *ToolPermissionSelection `json:"permission,omitempty"`
}

CompiledMCPTool defines model for CompiledMCPTool.

type CompiledMCPTransport 

type CompiledMCPTransport struct {
	Args          *[]string          `json:"args,omitempty"`
	Command       *string            `json:"command,omitempty"`
	CommandSha256 *string            `json:"command_sha256,omitempty"`
	Cwd           *string            `json:"cwd,omitempty"`
	Env           *map[string]string `json:"env,omitempty"`
	TimeoutMs     *int               `json:"timeout_ms,omitempty"`

	// Type Transport of an MCP server.
	Type MCPTransportType `json:"type"`
	URL  *string          `json:"url,omitempty"`
}

CompiledMCPTransport Transport of an environment-origin MCP server.

type CompiledMachineSource 

type CompiledMachineSource struct {
	Cwd                    *string             `json:"cwd,omitempty"`
	DeleteAfterIdleMinutes *int                `json:"delete_after_idle_minutes,omitempty"`
	Description            *string             `json:"description,omitempty"`
	EnvOverlay             *map[string]*string `json:"env_overlay,omitempty"`
	InitialNumMachines     *int                `json:"initial_num_machines,omitempty"`
	MachineCPU             *int                `json:"machine_cpu,omitempty"`

	// MachineID Machine ID (mch_...).
	MachineID       *MachineID `json:"machine_id,omitempty"`
	MachineMemoryMb *int       `json:"machine_memory_mb,omitempty"`

	// MachinePoolID Machine pool ID (mpo_...).
	MachinePoolID                 *MachinePoolID          `json:"machine_pool_id,omitempty"`
	MachineProviderOptionsOverlay *map[string]interface{} `json:"machine_provider_options_overlay,omitempty"`
	MaxMachines                   *int                    `json:"max_machines,omitempty"`
	SecretEnvOverlay              *map[string]*SecretID   `json:"secret_env_overlay,omitempty"`
}

CompiledMachineSource defines model for CompiledMachineSource.

type CompiledMemoryStore 

type CompiledMemoryStore struct {
	Access MemoryStoreAccess `json:"access"`
	ID     MemoryStoreID     `json:"id"`
}

CompiledMemoryStore defines model for CompiledMemoryStore.

type CompiledModelReasoning 

type CompiledModelReasoning struct {
	Effort string `json:"effort"`
}

CompiledModelReasoning defines model for CompiledModelReasoning.

type CompiledProfileSubagent 

type CompiledProfileSubagent struct {
	ArchiveAfterIdleMinutes *int                        `json:"archive_after_idle_minutes,omitempty"`
	Description             *string                     `json:"description,omitempty"`
	InstructionAppend       *string                     `json:"instruction_append,omitempty"`
	MaxInstances            *int                        `json:"max_instances,omitempty"`
	Model                   *CompiledSubagentModel      `json:"model,omitempty"`
	ProfileID               AgentProfileID              `json:"profile_id"`
	Type                    CompiledProfileSubagentType `json:"type"`
}

CompiledProfileSubagent defines model for CompiledProfileSubagent.

type CompiledProfileSubagentType 

type CompiledProfileSubagentType string

CompiledProfileSubagentType defines model for CompiledProfileSubagent.Type. 

const (
	CompiledProfileSubagentTypeProfile CompiledProfileSubagentType = "profile"
)

Defines values for CompiledProfileSubagentType.

func (CompiledProfileSubagentType) Valid 

func (e CompiledProfileSubagentType) Valid() bool

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

type CompiledSelfSubagent 

type CompiledSelfSubagent struct {
	ArchiveAfterIdleMinutes *int                     `json:"archive_after_idle_minutes,omitempty"`
	Description             *string                  `json:"description,omitempty"`
	InstructionAppend       *string                  `json:"instruction_append,omitempty"`
	MaxInstances            *int                     `json:"max_instances,omitempty"`
	Model                   *CompiledSubagentModel   `json:"model,omitempty"`
	Type                    CompiledSelfSubagentType `json:"type"`
}

CompiledSelfSubagent defines model for CompiledSelfSubagent.

type CompiledSelfSubagentType 

type CompiledSelfSubagentType string

CompiledSelfSubagentType defines model for CompiledSelfSubagent.Type. 

const (
	CompiledSelfSubagentTypeSelf CompiledSelfSubagentType = "self"
)

Defines values for CompiledSelfSubagentType.

func (CompiledSelfSubagentType) Valid 

func (e CompiledSelfSubagentType) Valid() bool

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

type CompiledSkill 

type CompiledSkill struct {
	ID SkillID `json:"id"`
}

CompiledSkill defines model for CompiledSkill.

type CompiledSubagent 

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

CompiledSubagent defines model for CompiledSubagent.

func (CompiledSubagent) AsAny 

func (t CompiledSubagent) AsAny() any

AsAny returns the member of CompiledSubagent named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (CompiledSubagent) AsCompiledProfileSubagent 

func (t CompiledSubagent) AsCompiledProfileSubagent() (CompiledProfileSubagent, error)

AsCompiledProfileSubagent returns the union data inside the CompiledSubagent as a CompiledProfileSubagent

func (CompiledSubagent) AsCompiledSelfSubagent 

func (t CompiledSubagent) AsCompiledSelfSubagent() (CompiledSelfSubagent, error)

AsCompiledSelfSubagent returns the union data inside the CompiledSubagent as a CompiledSelfSubagent

func (CompiledSubagent) Discriminator 

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

func (*CompiledSubagent) FromCompiledProfileSubagent 

func (t *CompiledSubagent) FromCompiledProfileSubagent(v CompiledProfileSubagent) error

FromCompiledProfileSubagent overwrites any union data inside the CompiledSubagent as the provided CompiledProfileSubagent

func (*CompiledSubagent) FromCompiledSelfSubagent 

func (t *CompiledSubagent) FromCompiledSelfSubagent(v CompiledSelfSubagent) error

FromCompiledSelfSubagent overwrites any union data inside the CompiledSubagent as the provided CompiledSelfSubagent

func (CompiledSubagent) MarshalJSON 

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

func (*CompiledSubagent) MergeCompiledProfileSubagent 

func (t *CompiledSubagent) MergeCompiledProfileSubagent(v CompiledProfileSubagent) error

MergeCompiledProfileSubagent performs a merge with any union data inside the CompiledSubagent, using the provided CompiledProfileSubagent

func (*CompiledSubagent) MergeCompiledSelfSubagent 

func (t *CompiledSubagent) MergeCompiledSelfSubagent(v CompiledSelfSubagent) error

MergeCompiledSelfSubagent performs a merge with any union data inside the CompiledSubagent, using the provided CompiledSelfSubagent

func (*CompiledSubagent) UnmarshalJSON 

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

func (CompiledSubagent) ValueByDiscriminator 

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

type CompiledSubagentModel 

type CompiledSubagentModel struct {
	// CacheRetention Prompt-cache preference for model requests; `short` when omitted. `short` applies the route's default caching (explicit cache breakpoints where the provider requires them) and, where the route accepts one, a stable conversation key for cache-aware routing. `long` prefers the route's extended cache lifetime where one exists (currently Anthropic's one-hour cache, which on Bedrock requires Claude 4.5 or newer) and behaves like `short` elsewhere. `none` sends no BMA-managed cache controls or conversation key; providers may still cache prefixes on their own.
	CacheRetention         *ModelCacheRetention    `json:"cache_retention,omitempty"`
	ConfiguredModelID      *ConfiguredModelID      `json:"configured_model_id,omitempty"`
	ContextWindowTokens    *int                    `json:"context_window_tokens,omitempty"`
	DefaultMaxOutputTokens *int                    `json:"default_max_output_tokens,omitempty"`
	Reasoning              *CompiledModelReasoning `json:"reasoning,omitempty"`
}

CompiledSubagentModel defines model for CompiledSubagentModel.

type CompiledTool 

type CompiledTool struct {
	Deferred      *bool                   `json:"deferred,omitempty"`
	Description   *string                 `json:"description,omitempty"`
	Enabled       bool                    `json:"enabled"`
	InputSchema   *map[string]interface{} `json:"input_schema,omitempty"`
	IntegrationID *IntegrationID          `json:"integration_id,omitempty"`
	Permission    ToolPermissionSelection `json:"permission"`
	Type          *CompiledToolType       `json:"type,omitempty"`
}

CompiledTool defines model for CompiledTool.

type CompiledToolType 

type CompiledToolType string

CompiledToolType defines model for CompiledTool.Type. 

const (
	CompiledToolTypeBuiltIn CompiledToolType = "built_in"
	CompiledToolTypeCustom  CompiledToolType = "custom"
)

Defines values for CompiledToolType.

func (CompiledToolType) Valid 

func (e CompiledToolType) Valid() bool

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

type ConfigureIntegrationJSONRequestBody 

type ConfigureIntegrationJSONRequestBody = ConfigureIntegrationRequest

ConfigureIntegrationJSONRequestBody defines body for ConfigureIntegration for application/json ContentType.

type ConfigureIntegrationRequest 

type ConfigureIntegrationRequest struct {
	// CredentialSecretID Secret ID (sec_...).
	CredentialSecretID    SecretID `json:"credential_secret_id"`
	ExpectedSetupRevision int      `json:"expected_setup_revision"`

	// ProviderAccountRef Required GitHub Installation ID. Optional for Discord; an explicitly supplied bot User ID must match the token.
	ProviderAccountRef *string `json:"provider_account_ref,omitempty"`

	// ProviderAgentDisplayName Provider account display label, at most 512 UTF-8 bytes. Leading and trailing whitespace is trimmed on save. Empty means no label; an omitted or empty value clears the label on account-management updates.
	ProviderAgentDisplayName *IntegrationProviderDisplayName `json:"provider_agent_display_name,omitempty"`

	// ProviderConfig Non-secret provider configuration, validated for the selected provider. Slack and GitHub integrations require an empty object. Discord accepts only public_key (optional, a 32-byte hex-encoded Ed25519 verification key for interaction callbacks). BMA manages one Gateway connection per Discord integration. Credentials and integration behavior are not accepted here.
	ProviderConfig   *IntegrationProviderConfig `json:"provider_config,omitempty"`
	ProviderTenantID string                     `json:"provider_tenant_id"`
}

ConfigureIntegrationRequest Verifies credentials for this saved integration. GitHub tenant/account are the numeric App ID and Installation ID; the secret is github_app_credentials. Discord tenant is the Application ID; its generic secret contains the bot token, from which the bot User ID is discovered automatically. Reconnect preserves the original verified provider identity. A concurrent setup change rejects this request. Credential payloads are never returned.

type ConfiguredModel 

type ConfiguredModel struct {
	// APIVariantOptions Extra top-level JSON fields to include in provider requests for this configured model. Use this for provider-specific settings that BMA does not expose as typed fields, such as OpenRouter `provider` routing or sampling parameters. BMA still controls the fields it needs to run the agent correctly, including the model, prompt/messages, streaming, tools, output-token limit, and selected reasoning policy. Provider passthrough values for those fields are ignored. For OpenRouter routing options, see https://openrouter.ai/docs/guides/routing/provider-selection and general request parameters at https://openrouter.ai/docs/api/reference/parameters. BMA-managed OpenRouter providers accept only sampling, reasoning, and per-model routing options here.
	APIVariantOptions ModelAPIVariantOptions `json:"api_variant_options"`

	// ContextWindowTokens Context budget for input and output tokens. Triggers compaction when estimated input exceeds the remaining budget after output and safety reserves. The turn fails if compaction cannot make it fit.
	ContextWindowTokens int                       `json:"context_window_tokens"`
	CreatedAt           Timestamp                 `json:"created_at"`
	CurrentRevisionID   ConfiguredModelRevisionID `json:"current_revision_id"`

	// DefaultCacheRetention Prompt-cache preference for model requests; `short` when omitted. `short` applies the route's default caching (explicit cache breakpoints where the provider requires them) and, where the route accepts one, a stable conversation key for cache-aware routing. `long` prefers the route's extended cache lifetime where one exists (currently Anthropic's one-hour cache, which on Bedrock requires Claude 4.5 or newer) and behaves like `short` elsewhere. `none` sends no BMA-managed cache controls or conversation key; providers may still cache prefixes on their own.
	DefaultCacheRetention *ModelCacheRetention `json:"default_cache_retention,omitempty"`

	// DefaultMaxOutputTokens Default per-request output-token cap sent to the provider unless an agent config overrides it.
	DefaultMaxOutputTokens *int `json:"default_max_output_tokens,omitempty"`

	// DefaultReasoningEffort Default reasoning effort to send for models/API formats that support effort-style reasoning controls.
	DefaultReasoningEffort string            `json:"default_reasoning_effort"`
	ID                     ConfiguredModelID `json:"id"`

	// InputModalities Input types this configured model accepts. BMA recognizes text, image, and file; an empty list leaves capabilities unspecified.
	InputModalities []string `json:"input_modalities"`

	// ManagementKind Lifecycle owner. Tenant-managed resources can be changed through tenant APIs. Cluster-managed resources are installed and lifecycle-managed by the control plane; individual APIs may explicitly expose tenant-editable settings.
	ManagementKind ManagementKind `json:"management_kind"`

	// MaxOutputTokens Known output-token ceiling for this model, or null when unknown.
	MaxOutputTokens       *int                  `json:"max_output_tokens"`
	ModelProviderConfigID ModelProviderConfigID `json:"model_provider_config_id"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name  ResourceName   `json:"name"`
	OrgID OrganizationID `json:"org_id"`

	// OutputModalities Output types this configured model can return.
	OutputModalities []string `json:"output_modalities"`

	// ProviderModelSlug Exact provider model slug sent to the provider endpoint by the current revision.
	ProviderModelSlug string    `json:"provider_model_slug"`
	RevisionCreatedAt Timestamp `json:"revision_created_at"`

	// SupportedReasoningEfforts Reasoning effort values this configured model accepts.
	SupportedReasoningEfforts []string `json:"supported_reasoning_efforts"`

	// SupportsReasoning Whether BMA should use this model's reasoning features.
	SupportsReasoning bool `json:"supports_reasoning"`

	// SupportsTools Whether this configured model can receive tool definitions and emit tool calls.
	SupportsTools bool      `json:"supports_tools"`
	UpdatedAt     Timestamp `json:"updated_at"`
}

ConfiguredModel defines model for ConfiguredModel.

type ConfiguredModelID 

type ConfiguredModelID = string

ConfiguredModelID defines model for ConfiguredModelID.

type ConfiguredModelList 

type ConfiguredModelList struct {
	Data       []ConfiguredModel `json:"data"`
	NextCursor *string           `json:"next_cursor"`
}

ConfiguredModelList defines model for ConfiguredModelList.

type ConfiguredModelRevisionID 

type ConfiguredModelRevisionID = string

ConfiguredModelRevisionID defines model for ConfiguredModelRevisionID.

type ConfiguredModelSummary 

type ConfiguredModelSummary struct {
	CreatedAt             Timestamp             `json:"created_at"`
	ID                    ConfiguredModelID     `json:"id"`
	ModelProviderConfigID ModelProviderConfigID `json:"model_provider_config_id"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name  ResourceName   `json:"name"`
	OrgID OrganizationID `json:"org_id"`

	// ProviderConfig Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	ProviderConfig ResourceName `json:"provider_config"`

	// ProviderModelSlug Exact provider model slug sent to the provider endpoint by the current revision.
	ProviderModelSlug string    `json:"provider_model_slug"`
	UpdatedAt         Timestamp `json:"updated_at"`
}

ConfiguredModelSummary defines model for ConfiguredModelSummary.

type ConfirmDesktopActionJSONRequestBody 

type ConfirmDesktopActionJSONRequestBody = DesktopGenerationRequest

ConfirmDesktopActionJSONRequestBody defines body for ConfirmDesktopAction for application/json ContentType.

type Conflict 

type Conflict = ErrorBody

Conflict defines model for Conflict.

type ConnectBYOMachineJSONRequestBody 

type ConnectBYOMachineJSONRequestBody = ConnectBYOMachineRequest

ConnectBYOMachineJSONRequestBody defines body for ConnectBYOMachine for application/json ContentType.

type ConnectBYOMachineRequest 

type ConnectBYOMachineRequest struct {
	// Cwd Default working directory for processes started on the machine.
	Cwd *string `json:"cwd,omitempty"`

	// Description Optional description of the machine.
	Description *string `json:"description,omitempty"`

	// DisplayName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	DisplayName ResourceName `json:"display_name"`

	// Env Environment variables set for processes started on the machine.
	Env *map[string]string `json:"env,omitempty"`

	// Metadata User-supplied metadata stored on a machine, provided directly or copied from the machine pool that provisions it. A restriction of Metadata that leaves room for one reserved pair - BMA sets observed_platform on the machine to the platform reported by its daemon, so the key is reserved and at most 15 user pairs are accepted.
	Metadata *MachineMetadata `json:"metadata,omitempty"`

	// ProjectIDs Projects to grant the machine to in the same call (up to 100).
	ProjectIDs *[]ProjectID `json:"project_ids,omitempty"`

	// SecretEnv Environment variable names mapped to secret IDs (sec_...) whose values are set for processes started on the machine.
	SecretEnv *map[string]SecretID `json:"secret_env,omitempty"`

	// TokenName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	TokenName *ResourceName `json:"token_name,omitempty"`
}

ConnectBYOMachineRequest defines model for ConnectBYOMachineRequest.

type ConnectBYOMachineResponse 

type ConnectBYOMachineResponse struct {
	Machine       Machine               `json:"machine"`
	ProjectGrants []ProjectMachineGrant `json:"project_grants"`

	// Token Opaque bearer credential.
	Token       string             `json:"token"`
	TokenRecord MachineDaemonToken `json:"token_record"`
}

ConnectBYOMachineResponse defines model for ConnectBYOMachineResponse.

type ConnectionTicket 

type ConnectionTicket struct {
	ExpiresAt time.Time `json:"expires_at"`

	// ID Connection ticket ID (tkt_...).
	ID          ConnectionTicketID      `json:"id"`
	Permissions []string                `json:"permissions"`
	Purpose     ConnectionTicketPurpose `json:"purpose"`
	Subprotocol string                  `json:"subprotocol"`

	// Ticket Opaque single-use ticket. Returned once and never logged.
	Ticket string `json:"ticket"`

	// WsURL WebSocket URL without the ticket.
	WsURL string `json:"ws_url"`
}

ConnectionTicket defines model for ConnectionTicket.

type ConnectionTicketID 

type ConnectionTicketID = string

ConnectionTicketID Connection ticket ID (tkt_...).

type ConnectionTicketPurpose 

type ConnectionTicketPurpose string

ConnectionTicketPurpose defines model for ConnectionTicket.Purpose. 

const (
	DesktopWatch    ConnectionTicketPurpose = "desktop_watch"
	TerminalConnect ConnectionTicketPurpose = "terminal_connect"
)

Defines values for ConnectionTicketPurpose.

func (ConnectionTicketPurpose) Valid 

func (e ConnectionTicketPurpose) Valid() bool

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

type ContentBlockMetadata 

type ContentBlockMetadata = Metadata

ContentBlockMetadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.

type ContextCheckpointEvent 

type ContextCheckpointEvent struct {
	AgentID             AgentID                              `json:"agent_id"`
	ContextCheckpointID ContextCheckpointID                  `json:"context_checkpoint_id"`
	CreatedAt           Timestamp                            `json:"created_at"`
	EventKind           ContextCheckpointEventEventKind      `json:"event_kind"`
	ID                  AgentEventID                         `json:"id"`
	IsOpeningEvent      ContextCheckpointEventIsOpeningEvent `json:"is_opening_event"`
	OrgID               OrganizationID                       `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// Sequence Positive per-agent event, turn, or live-frame sequence.
	Sequence AgentSequence `json:"sequence"`

	// SummarizedThroughEventSequence Positive per-agent event, turn, or live-frame sequence.
	SummarizedThroughEventSequence AgentSequence `json:"summarized_through_event_sequence"`
	Summary                        string        `json:"summary"`
	TurnID                         AgentTurnID   `json:"turn_id"`

	// TurnSequence Positive per-agent event, turn, or live-frame sequence.
	TurnSequence AgentSequence `json:"turn_sequence"`
}

ContextCheckpointEvent defines model for ContextCheckpointEvent.

type ContextCheckpointEventEventKind 

type ContextCheckpointEventEventKind string

ContextCheckpointEventEventKind defines model for ContextCheckpointEvent.EventKind. 

const (
	ContextCheckpoint ContextCheckpointEventEventKind = "context_checkpoint"
)

Defines values for ContextCheckpointEventEventKind.

func (ContextCheckpointEventEventKind) Valid 

func (e ContextCheckpointEventEventKind) Valid() bool

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

type ContextCheckpointEventIsOpeningEvent 

type ContextCheckpointEventIsOpeningEvent bool

ContextCheckpointEventIsOpeningEvent defines model for ContextCheckpointEvent.IsOpeningEvent. 

const (
	ContextCheckpointEventIsOpeningEventFalse ContextCheckpointEventIsOpeningEvent = false
)

Defines values for ContextCheckpointEventIsOpeningEvent.

func (ContextCheckpointEventIsOpeningEvent) Valid 

func (e ContextCheckpointEventIsOpeningEvent) Valid() bool

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

type ContextCheckpointID 

type ContextCheckpointID = string

ContextCheckpointID defines model for ContextCheckpointID.

type CreateAgentConfigJSONRequestBody 

type CreateAgentConfigJSONRequestBody = CreateAgentConfigRequest

CreateAgentConfigJSONRequestBody defines body for CreateAgentConfig for application/json ContentType.

type CreateAgentConfigRequest 

type CreateAgentConfigRequest struct {
	// Source Agent config source as YAML or JSON text, or, with source_format json, as a JSON object.
	Source AgentConfigSourceInput `json:"source"`

	// SourceFormat Format of source: yaml or json.
	SourceFormat CreateAgentConfigRequestSourceFormat `json:"source_format"`
}

CreateAgentConfigRequest An agent config to compile. YAML sources are stored verbatim, so comments and formatting survive; JSON sources, as text or as an object, are stored canonicalized, so the same JSON definition always maps to the same config.

type CreateAgentConfigRequestSourceFormat 

type CreateAgentConfigRequestSourceFormat string

CreateAgentConfigRequestSourceFormat Format of source: yaml or json. 

const (
	CreateAgentConfigRequestSourceFormatJSON CreateAgentConfigRequestSourceFormat = "json"
	CreateAgentConfigRequestSourceFormatYaml CreateAgentConfigRequestSourceFormat = "yaml"
)

Defines values for CreateAgentConfigRequestSourceFormat.

func (CreateAgentConfigRequestSourceFormat) Valid 

func (e CreateAgentConfigRequestSourceFormat) Valid() bool

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

type CreateAgentInputContentBlock 

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

CreateAgentInputContentBlock defines model for CreateAgentInputContentBlock.

func NewMediaInputBlock 

func NewMediaInputBlock(mediaType, filename string, data []byte) CreateAgentInputContentBlock

NewMediaInputBlock builds an inline media block of AgentInputNewParams.ContentBlocks.

func NewTextInputBlock 

func NewTextInputBlock(text string) CreateAgentInputContentBlock

NewTextInputBlock builds a text block of AgentInputNewParams.ContentBlocks.

func (CreateAgentInputContentBlock) AsAny 

func (t CreateAgentInputContentBlock) AsAny() any

AsAny returns the member of CreateAgentInputContentBlock named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (CreateAgentInputContentBlock) AsInlineMediaContentBlock 

func (t CreateAgentInputContentBlock) AsInlineMediaContentBlock() (InlineMediaContentBlock, error)

AsInlineMediaContentBlock returns the union data inside the CreateAgentInputContentBlock as a InlineMediaContentBlock

func (CreateAgentInputContentBlock) AsTextContentBlock 

func (t CreateAgentInputContentBlock) AsTextContentBlock() (TextContentBlock, error)

AsTextContentBlock returns the union data inside the CreateAgentInputContentBlock as a TextContentBlock

func (CreateAgentInputContentBlock) Discriminator 

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

func (*CreateAgentInputContentBlock) FromInlineMediaContentBlock 

func (t *CreateAgentInputContentBlock) FromInlineMediaContentBlock(v InlineMediaContentBlock) error

FromInlineMediaContentBlock overwrites any union data inside the CreateAgentInputContentBlock as the provided InlineMediaContentBlock

func (*CreateAgentInputContentBlock) FromTextContentBlock 

func (t *CreateAgentInputContentBlock) FromTextContentBlock(v TextContentBlock) error

FromTextContentBlock overwrites any union data inside the CreateAgentInputContentBlock as the provided TextContentBlock

func (CreateAgentInputContentBlock) MarshalJSON 

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

func (*CreateAgentInputContentBlock) MergeInlineMediaContentBlock 

func (t *CreateAgentInputContentBlock) MergeInlineMediaContentBlock(v InlineMediaContentBlock) error

MergeInlineMediaContentBlock performs a merge with any union data inside the CreateAgentInputContentBlock, using the provided InlineMediaContentBlock

func (*CreateAgentInputContentBlock) MergeTextContentBlock 

func (t *CreateAgentInputContentBlock) MergeTextContentBlock(v TextContentBlock) error

MergeTextContentBlock performs a merge with any union data inside the CreateAgentInputContentBlock, using the provided TextContentBlock

func (*CreateAgentInputContentBlock) UnmarshalJSON 

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

func (CreateAgentInputContentBlock) ValueByDiscriminator 

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

type CreateAgentInputDeliveryMode 

type CreateAgentInputDeliveryMode string

CreateAgentInputDeliveryMode defines model for CreateAgentInputDeliveryMode. 

const (
	CreateAgentInputDeliveryModeQueued   CreateAgentInputDeliveryMode = "queued"
	CreateAgentInputDeliveryModeSteering CreateAgentInputDeliveryMode = "steering"
)

Defines values for CreateAgentInputDeliveryMode.

func (CreateAgentInputDeliveryMode) Valid 

func (e CreateAgentInputDeliveryMode) Valid() bool

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

type CreateAgentInputJSONRequestBody 

type CreateAgentInputJSONRequestBody = CreateAgentInputRequest

CreateAgentInputJSONRequestBody defines body for CreateAgentInput for application/json ContentType.

type CreateAgentInputParams 

type CreateAgentInputParams struct {
	// SessionID Agent session ID (ses_...). Omit to use the agent's default session.
	SessionID *string `form:"session_id,omitempty" json:"session_id,omitempty"`

	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreateAgentInputParams defines parameters for CreateAgentInput.

type CreateAgentInputRequest 

type CreateAgentInputRequest struct {
	// Actor Identity and attributes of an external actor. Actors are upserted by (provider_tenant_id, provider_user_id) with the external provider. Omitted attributes keep their stored values; provided attributes are overwritten, including empty values. bma actors are implicit and hosted integrations own their own actor identities.
	Actor *ExternalActorParams `json:"actor,omitempty"`

	// CancelOpenInteractions Only valid when delivery_mode is steering. When true, atomically cancels open interactions associated with the current turn's unfinished tool calls before creating the steering input. Their parent tool calls complete as canceled; the turn, runtime, and unrelated tool calls are preserved.
	CancelOpenInteractions *bool `json:"cancel_open_interactions,omitempty"`

	// ContentBlocks At most 20 inline media blocks per submission, each holding up to 10 MiB of decoded media and up to 24 MiB decoded across the submission. Non-media blocks may hold up to 1 MiB combined. The whole request body is capped at 48 MiB.
	ContentBlocks []CreateAgentInputContentBlock `json:"content_blocks"`
	DeliveryMode  *CreateAgentInputDeliveryMode  `json:"delivery_mode,omitempty"`
	ModelOverride *AgentModelOverrideInput       `json:"model_override,omitempty"`
}

CreateAgentInputRequest defines model for CreateAgentInputRequest.

type CreateAgentJSONRequestBody 

type CreateAgentJSONRequestBody = CreateAgentRequest

CreateAgentJSONRequestBody defines body for CreateAgent for application/json ContentType.

type CreateAgentParams 

type CreateAgentParams struct {
	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreateAgentParams defines parameters for CreateAgent.

type CreateAgentPersistentMachineJSONRequestBody 

type CreateAgentPersistentMachineJSONRequestBody = CreateAgentPersistentMachineRequest

CreateAgentPersistentMachineJSONRequestBody defines body for CreateAgentPersistentMachine for application/json ContentType.

type CreateAgentPersistentMachineParams 

type CreateAgentPersistentMachineParams struct {
	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreateAgentPersistentMachineParams defines parameters for CreateAgentPersistentMachine.

type CreateAgentPersistentMachineRequest 

type CreateAgentPersistentMachineRequest struct {
	// DisplayName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	DisplayName *ResourceName `json:"display_name,omitempty"`

	// MachinePoolID Machine pool ID (mpo_...).
	MachinePoolID *MachinePoolID `json:"machine_pool_id,omitempty"`

	// Template The sold machine-class template (for example base-2c4g, base-2c8g or base-8c32g). It must be allowed by the machine pool's provider configuration.
	Template string `json:"template"`
}

CreateAgentPersistentMachineRequest defines model for CreateAgentPersistentMachineRequest.

type CreateAgentProfileJSONRequestBody 

type CreateAgentProfileJSONRequestBody = CreateAgentProfileRequest

CreateAgentProfileJSONRequestBody defines body for CreateAgentProfile for application/json ContentType.

type CreateAgentProfileParams 

type CreateAgentProfileParams struct {
	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreateAgentProfileParams defines parameters for CreateAgentProfile.

type CreateAgentProfileRequest 

type CreateAgentProfileRequest struct {
	// Config Agent config ID (acfg_...).
	Config AgentConfigID `json:"config"`

	// Description Caller-owned free-text description of the profile.
	Description *string `json:"description,omitempty"`

	// Metadata Caller-owned labels of an agent profile (string keys and values).
	Metadata *AgentProfileMetadata `json:"metadata,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`
}

CreateAgentProfileRequest defines model for CreateAgentProfileRequest.

type CreateAgentRequest 

type CreateAgentRequest struct {
	// Config Agent config ID (acfg_...).
	Config *AgentConfigID `json:"config,omitempty"`

	// ConfigSource An agent config to compile. YAML sources are stored verbatim, so comments and formatting survive; JSON sources, as text or as an object, are stored canonicalized, so the same JSON definition always maps to the same config.
	ConfigSource *CreateAgentConfigRequest `json:"config_source,omitempty"`

	// InitialInput Initial queued text input, committed atomically with the agent and any derived config. Mutually exclusive with message. Initial inline media is not supported; upload it through the agent input endpoint after launch.
	InitialInput *AgentLaunchInitialInput `json:"initial_input,omitempty"`

	// InteractionHandlers Additional integration interaction handlers, keyed by immutable integration name with empty object values. Slack and Discord handlers require an assigned conversation and accept empty runtime args. Adding a handler does not assign a conversation. Existing entries win unchanged. Requires project management permission.
	InteractionHandlers *map[string]AgentConfigDefinitionInteractionHandler `json:"interaction_handlers,omitempty"`

	// Message Optional initial text message. Mutually exclusive with initial_input.
	Message *string `json:"message,omitempty"`

	// Name Agent name. Empty means the agent is unnamed; non-empty values use the ResourceName policy.
	Name    *AgentName      `json:"name,omitempty"`
	Profile *AgentProfileID `json:"profile,omitempty"`

	// Subscriptions Integration-owned conversation subscriptions attached atomically with launch and initial input. Requires project management permission. Subscriptions alone preserve the pinned config. Launch replay never adds or restores subscriptions.
	Subscriptions *[]IntegrationSubscriptionAttachment `json:"subscriptions,omitempty"`

	// Tools Additional integration tool entries (int__<integration-name>__<operation>) and optional list_interaction_handlers or set_interaction_handler tools for this agent. Other tool names are not accepted here. Existing config entries win unchanged. Requires project management permission. The derived config is created atomically with the agent and initial input; the profile is unchanged.
	Tools *map[string]AgentConfigDefinitionTool `json:"tools,omitempty"`
	// contains filtered or unexported fields
}

CreateAgentRequest Send at least one of profile, config, or config_source, and not both config and config_source. With only profile, the agent runs the profile's current config. With profile and config or config_source, the agent is attributed to the profile but runs the given config, which need not be one of the profile's versions. config_source is compiled and saved as a new config during the launch.

func (CreateAgentRequest) AsCreateAgentRequest0 

func (t CreateAgentRequest) AsCreateAgentRequest0() (CreateAgentRequest0, error)

AsCreateAgentRequest0 returns the union data inside the CreateAgentRequest as a CreateAgentRequest0

func (CreateAgentRequest) AsCreateAgentRequest1 

func (t CreateAgentRequest) AsCreateAgentRequest1() (CreateAgentRequest1, error)

AsCreateAgentRequest1 returns the union data inside the CreateAgentRequest as a CreateAgentRequest1

func (CreateAgentRequest) AsCreateAgentRequest2 

func (t CreateAgentRequest) AsCreateAgentRequest2() (CreateAgentRequest2, error)

AsCreateAgentRequest2 returns the union data inside the CreateAgentRequest as a CreateAgentRequest2

func (*CreateAgentRequest) FromCreateAgentRequest0 

func (t *CreateAgentRequest) FromCreateAgentRequest0(v CreateAgentRequest0) error

FromCreateAgentRequest0 overwrites any union data inside the CreateAgentRequest as the provided CreateAgentRequest0

func (*CreateAgentRequest) FromCreateAgentRequest1 

func (t *CreateAgentRequest) FromCreateAgentRequest1(v CreateAgentRequest1) error

FromCreateAgentRequest1 overwrites any union data inside the CreateAgentRequest as the provided CreateAgentRequest1

func (*CreateAgentRequest) FromCreateAgentRequest2 

func (t *CreateAgentRequest) FromCreateAgentRequest2(v CreateAgentRequest2) error

FromCreateAgentRequest2 overwrites any union data inside the CreateAgentRequest as the provided CreateAgentRequest2

func (CreateAgentRequest) MarshalJSON 

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

func (*CreateAgentRequest) MergeCreateAgentRequest0 

func (t *CreateAgentRequest) MergeCreateAgentRequest0(v CreateAgentRequest0) error

MergeCreateAgentRequest0 performs a merge with any union data inside the CreateAgentRequest, using the provided CreateAgentRequest0

func (*CreateAgentRequest) MergeCreateAgentRequest1 

func (t *CreateAgentRequest) MergeCreateAgentRequest1(v CreateAgentRequest1) error

MergeCreateAgentRequest1 performs a merge with any union data inside the CreateAgentRequest, using the provided CreateAgentRequest1

func (*CreateAgentRequest) MergeCreateAgentRequest2 

func (t *CreateAgentRequest) MergeCreateAgentRequest2(v CreateAgentRequest2) error

MergeCreateAgentRequest2 performs a merge with any union data inside the CreateAgentRequest, using the provided CreateAgentRequest2

func (*CreateAgentRequest) UnmarshalJSON 

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

type CreateAgentRequest0 

type CreateAgentRequest0 struct {
	Profile AgentProfileID `json:"profile"`
}

CreateAgentRequest0 defines model for .

type CreateAgentRequest1 

type CreateAgentRequest1 struct {
	// Config Agent config ID (acfg_...).
	Config AgentConfigID `json:"config"`
}

CreateAgentRequest1 defines model for .

type CreateAgentRequest2 

type CreateAgentRequest2 struct {
	// ConfigSource An agent config to compile. YAML sources are stored verbatim, so comments and formatting survive; JSON sources, as text or as an object, are stored canonicalized, so the same JSON definition always maps to the same config.
	ConfigSource CreateAgentConfigRequest `json:"config_source"`
}

CreateAgentRequest2 defines model for .

type CreateAgentSessionJSONRequestBody 

type CreateAgentSessionJSONRequestBody = CreateAgentSessionRequest

CreateAgentSessionJSONRequestBody defines body for CreateAgentSession for application/json ContentType.

type CreateAgentSessionRequest 

type CreateAgentSessionRequest struct {
	AgentConfigID *string `json:"agent_config_id,omitempty"`

	// ConfigSource An agent config to compile. YAML sources are stored verbatim, so comments and formatting survive; JSON sources, as text or as an object, are stored canonicalized, so the same JSON definition always maps to the same config.
	ConfigSource  *CreateAgentConfigRequest `json:"config_source,omitempty"`
	EnvironmentID *openapi_types.UUID       `json:"environment_id,omitempty"`

	// IdempotencyKey Replays the original session for this agent. A replay with a different pinned config, environment or metadata is a 409 conflict.
	IdempotencyKey *string                  `json:"idempotency_key,omitempty"`
	Metadata       *map[string]interface{}  `json:"metadata,omitempty"`
	ModelOverride  *AgentModelOverrideInput `json:"model_override,omitempty"`

	// Resources Project files to mount into the new session, as with POST .../resources. A replay of an idempotent create mounts nothing new.
	Resources *[]FileResourceParams `json:"resources,omitempty"`
}

CreateAgentSessionRequest defines model for CreateAgentSessionRequest.

type CreateBYOMachineDaemonTokenJSONRequestBody 

type CreateBYOMachineDaemonTokenJSONRequestBody = CreateMachineDaemonTokenRequest

CreateBYOMachineDaemonTokenJSONRequestBody defines body for CreateBYOMachineDaemonToken for application/json ContentType.

type CreateConfiguredModelJSONRequestBody 

type CreateConfiguredModelJSONRequestBody = CreateConfiguredModelRequest

CreateConfiguredModelJSONRequestBody defines body for CreateConfiguredModel for application/json ContentType.

type CreateConfiguredModelRequest 

type CreateConfiguredModelRequest struct {
	// APIVariantOptions Extra top-level JSON fields to include in provider requests for this configured model. Use this for provider-specific settings that BMA does not expose as typed fields, such as OpenRouter `provider` routing or sampling parameters. BMA still controls the fields it needs to run the agent correctly, including the model, prompt/messages, streaming, tools, output-token limit, and selected reasoning policy. Provider passthrough values for those fields are ignored. For OpenRouter routing options, see https://openrouter.ai/docs/guides/routing/provider-selection and general request parameters at https://openrouter.ai/docs/api/reference/parameters. BMA-managed OpenRouter providers accept only sampling, reasoning, and per-model routing options here.
	APIVariantOptions *ModelAPIVariantOptions `json:"api_variant_options,omitempty"`

	// ContextWindowTokens Context budget for input and output tokens. Triggers compaction when estimated input exceeds the remaining budget after output and safety reserves. The turn fails if compaction cannot make it fit.
	ContextWindowTokens int `json:"context_window_tokens"`

	// DefaultCacheRetention Prompt-cache preference for model requests; `short` when omitted. `short` applies the route's default caching (explicit cache breakpoints where the provider requires them) and, where the route accepts one, a stable conversation key for cache-aware routing. `long` prefers the route's extended cache lifetime where one exists (currently Anthropic's one-hour cache, which on Bedrock requires Claude 4.5 or newer) and behaves like `short` elsewhere. `none` sends no BMA-managed cache controls or conversation key; providers may still cache prefixes on their own.
	DefaultCacheRetention *ModelCacheRetention `json:"default_cache_retention,omitempty"`

	// DefaultMaxOutputTokens Optional normal per-request output allowance. Discovery never populates this field. When omitted, requests use the known output ceiling. If both are absent, Messages uses 64000 tokens; other formats omit the allowance. Runtime allowances are fitted to available context.
	DefaultMaxOutputTokens *int `json:"default_max_output_tokens,omitempty"`

	// DefaultReasoningEffort Default reasoning effort to send for models/API formats that support effort-style reasoning controls. Requires supports_reasoning=true. When supported_reasoning_efforts is present, this value must be listed there.
	DefaultReasoningEffort *string `json:"default_reasoning_effort,omitempty"`

	// InputModalities Input types this configured model accepts. BMA recognizes text, image, and file; an empty list leaves capabilities unspecified.
	InputModalities *[]string `json:"input_modalities,omitempty"`

	// MaxOutputTokens Optional known output-token ceiling. Omitted capacity remains unknown; selecting a discovered model can supply its published ceiling. Explicit values must not exceed the provider's supported limit.
	MaxOutputTokens *int `json:"max_output_tokens,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`

	// OutputModalities Output types this configured model can return. BMA currently consumes text output.
	OutputModalities *[]string `json:"output_modalities,omitempty"`

	// ProviderModelSlug Exact provider model slug sent to the provider endpoint. Free-pool, `:online`, and preset model ids are not accepted on BMA-managed OpenRouter providers.
	ProviderModelSlug string `json:"provider_model_slug"`

	// SupportedReasoningEfforts Reasoning effort values this configured model accepts. Requires supports_reasoning=true when non-empty.
	SupportedReasoningEfforts *[]string `json:"supported_reasoning_efforts,omitempty"`

	// SupportsReasoning Whether BMA should use this model's reasoning features. For OpenAI Responses, this also enables encrypted reasoning replay for stateless calls.
	SupportsReasoning *bool `json:"supports_reasoning,omitempty"`

	// SupportsTools Whether this configured model can receive tool definitions and emit tool calls. Agent configs with enabled tools are rejected when this is false.
	SupportsTools *bool `json:"supports_tools,omitempty"`
}

CreateConfiguredModelRequest defines model for CreateConfiguredModelRequest.

type CreateConnectionTicketRequest 

type CreateConnectionTicketRequest struct {
	TTLSeconds *int32 `json:"ttl_seconds,omitempty"`
}

CreateConnectionTicketRequest defines model for CreateConnectionTicketRequest.

type CreateCronTriggerJSONRequestBody 

type CreateCronTriggerJSONRequestBody = CreateCronTriggerRequest

CreateCronTriggerJSONRequestBody defines body for CreateCronTrigger for application/json ContentType.

type CreateCronTriggerParams 

type CreateCronTriggerParams struct {
	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreateCronTriggerParams defines parameters for CreateCronTrigger.

type CreateCronTriggerRequest 

type CreateCronTriggerRequest struct {
	// Cron Standard five-field cron expression (minute, hour, day of month, month, day of week). `TZ=`/`CRON_TZ=` prefixes are rejected; set the `timezone` field instead.
	Cron CronExpression `json:"cron"`

	// Enabled Whether the trigger fires on schedule; false pauses it.
	Enabled *bool `json:"enabled,omitempty"`

	// MessageTemplate Go text/template rendered on each firing to produce the message sent to the target. The template receives a `trigger` value with `name`, `fired_at`, `last_fired_at`, and `local_date` fields. Timestamps remain UTC; local_date is the scheduled occurrence's ISO date in the schedule timezone. Required for agent and profile targets; omitted for integration targets, which use their own settings. Rendering is capped at 64 KiB of output and one second of wall-clock time, and `printf` width and precision specifiers are capped at 1024; a firing whose template fails to render is recorded in `failure_report` without sending a message.
	MessageTemplate *CronMessageTemplate `json:"message_template,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`

	// Target What each firing does: type agent sends the message to an existing agent, type profile launches a new agent from a profile, and type integration hands the firing to an integration, such as a new Slack or Discord thread.
	Target CronTriggerTarget `json:"target"`

	// Timezone IANA time zone the schedule is evaluated in.
	Timezone *CronTimezone `json:"timezone,omitempty"`
}

CreateCronTriggerRequest defines model for CreateCronTriggerRequest.

type CreateDesktopSessionJSONRequestBody 

type CreateDesktopSessionJSONRequestBody = CreateDesktopSessionRequest

CreateDesktopSessionJSONRequestBody defines body for CreateDesktopSession for application/json ContentType.

type CreateDesktopSessionRequest 

type CreateDesktopSessionRequest struct {
	AgentID      *AgentID                    `json:"agent_id,omitempty"`
	Capabilities *DesktopCapabilitiesRequest `json:"capabilities,omitempty"`
	LeaseSeconds *int32                      `json:"lease_seconds,omitempty"`
	ReadOnly     *bool                       `json:"read_only,omitempty"`
}

CreateDesktopSessionRequest defines model for CreateDesktopSessionRequest.

type CreateEventWebhookJSONRequestBody 

type CreateEventWebhookJSONRequestBody = CreateEventWebhookRequest

CreateEventWebhookJSONRequestBody defines body for CreateEventWebhook for application/json ContentType.

type CreateEventWebhookRequest 

type CreateEventWebhookRequest struct {
	EventTypes []EventWebhookEventType `json:"event_types"`
	Scope      EventWebhookScope       `json:"scope"`

	// SigningSecretID Secret ID (sec_...).
	SigningSecretID *SecretID `json:"signing_secret_id,omitempty"`

	// URL Public HTTPS endpoint, at most 2048 bytes after URL encoding.
	URL string `json:"url"`
}

CreateEventWebhookRequest defines model for CreateEventWebhookRequest.

type CreateGitHubSetupRequest 

type CreateGitHubSetupRequest struct {
	// AppName Optional initial GitHub App name suggestion. When omitted, the user chooses a name on GitHub during registration.
	AppName               *string `json:"app_name,omitempty"`
	ExpectedSetupRevision int     `json:"expected_setup_revision"`

	// Organization GitHub organization login. Omit to register under a personal account.
	Organization *string `json:"organization,omitempty"`
}

CreateGitHubSetupRequest defines model for CreateGitHubSetupRequest.

type CreateIntegrationGitHubSetupJSONRequestBody 

type CreateIntegrationGitHubSetupJSONRequestBody = CreateGitHubSetupRequest

CreateIntegrationGitHubSetupJSONRequestBody defines body for CreateIntegrationGitHubSetup for application/json ContentType.

type CreateIntegrationJSONRequestBody 

type CreateIntegrationJSONRequestBody = CreateIntegrationRequest

CreateIntegrationJSONRequestBody defines body for CreateIntegration for application/json ContentType.

type CreateIntegrationOAuthSetupJSONRequestBody 

type CreateIntegrationOAuthSetupJSONRequestBody = CreateIntegrationOAuthSetupRequest

CreateIntegrationOAuthSetupJSONRequestBody defines body for CreateIntegrationOAuthSetup for application/json ContentType.

type CreateIntegrationOAuthSetupRequest 

type CreateIntegrationOAuthSetupRequest struct {
	ClientID      string  `json:"client_id"`
	ClientSecret  string  `json:"client_secret"`
	ReturnTo      *string `json:"return_to,omitempty"`
	SigningSecret string  `json:"signing_secret"`
}

CreateIntegrationOAuthSetupRequest defines model for CreateIntegrationOAuthSetupRequest.

type CreateIntegrationRequest 

type CreateIntegrationRequest struct {
	// IntegrationKind Registered integration implementation; independent of the saved integration's name and immutable ID.
	IntegrationKind IntegrationKind `json:"integration_kind"`

	// Name Immutable, project-unique integration name used in config keys and qualified tool names.
	Name IntegrationName `json:"name"`

	// Settings Integration-owned settings JSON. Validate against capabilities.settings.input_schema from the integration catalog. Public profile references use aprf_ IDs and resolve at runtime. GitHub integrations use GitHubIntegrationSettings; Slack and Discord integrations use ChatIntegrationSettings.
	Settings IntegrationSettings `json:"settings"`
}

CreateIntegrationRequest Creates a disconnected integration. Name and integration_kind are immutable. Configure credentials through this integration's setup endpoints.

type CreateIntegrationSlackSetupJSONRequestBody 

type CreateIntegrationSlackSetupJSONRequestBody = CreateSlackSetupRequest

CreateIntegrationSlackSetupJSONRequestBody defines body for CreateIntegrationSlackSetup for application/json ContentType.

type CreateIntegrationSubscriptionJSONRequestBody 

type CreateIntegrationSubscriptionJSONRequestBody = CreateIntegrationSubscriptionRequest

CreateIntegrationSubscriptionJSONRequestBody defines body for CreateIntegrationSubscription for application/json ContentType.

type CreateIntegrationSubscriptionRequest 

type CreateIntegrationSubscriptionRequest struct {
	AgentID AgentID `json:"agent_id"`

	// Conversation One concrete provider address, validated by the integration's capabilities.subscription.conversation_schema. Slack uses channel_id and optional thread_ts; Discord uses channel_id for a channel or thread_id for a thread; GitHub uses repository_id and pull_request. Discord accepts optional parent channel_id and guild_id alongside thread_id and validates their ID format, but subscription creation does not verify them against Discord or retain them as routing restrictions. Only thread_id is retained in a canonical thread address and returned by create/list responses. No credentials or runtime state.
	Conversation IntegrationConversation `json:"conversation"`
}

CreateIntegrationSubscriptionRequest defines model for CreateIntegrationSubscriptionRequest.

type CreateMachineDaemonTokenRequest 

type CreateMachineDaemonTokenRequest struct {
	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata *Metadata `json:"metadata,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name *ResourceName `json:"name,omitempty"`
}

CreateMachineDaemonTokenRequest defines model for CreateMachineDaemonTokenRequest.

type CreateMachineDaemonTokenResponse 

type CreateMachineDaemonTokenResponse struct {
	// Token Opaque bearer credential.
	Token       string             `json:"token"`
	TokenRecord MachineDaemonToken `json:"token_record"`
}

CreateMachineDaemonTokenResponse defines model for CreateMachineDaemonTokenResponse.

type CreateMachineJSONRequestBody 

type CreateMachineJSONRequestBody = CreateMachineRequest

CreateMachineJSONRequestBody defines body for CreateMachine for application/json ContentType.

type CreateMachineParams 

type CreateMachineParams struct {
	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreateMachineParams defines parameters for CreateMachine.

type CreateMachinePoolJSONRequestBody 

type CreateMachinePoolJSONRequestBody = CreateMachinePoolRequest

CreateMachinePoolJSONRequestBody defines body for CreateMachinePool for application/json ContentType.

type CreateMachinePoolRequest 

type CreateMachinePoolRequest struct {
	// ArchiveAfterPausedDays Days a machine stays paused before it is archived. An archived machine is restored on the next access. Requires pause_after_idle_minutes.
	ArchiveAfterPausedDays *int32  `json:"archive_after_paused_days,omitempty"`
	DefaultCwd             *string `json:"default_cwd,omitempty"`
	DefaultMachineCPU      *int32  `json:"default_machine_cpu,omitempty"`

	// DefaultMachineEnv Default environment for pool machines. A machine's environment, including resolved secret_env values, is applied to the provider machine at provisioning, so the provider_options startup_script and the daemon run with it, and is resolved again for each process at launch.
	DefaultMachineEnv             *map[string]string     `json:"default_machine_env,omitempty"`
	DefaultMachineMemoryMb        *int32                 `json:"default_machine_memory_mb,omitempty"`
	DefaultMachineProviderOptions map[string]interface{} `json:"default_machine_provider_options"`

	// DefaultMachineSecretEnv Default secret environment for pool machines, mapping env names to generic secret references. References are resolved to secret values wherever the machine environment is applied.
	DefaultMachineSecretEnv *map[string]SecretID `json:"default_machine_secret_env,omitempty"`

	// DeleteAfterIdleMinutes Idle minutes before deleting a machine from this pool. Omit to leave the pool default unset; a grant or agent source may still override it.
	DeleteAfterIdleMinutes *int32 `json:"delete_after_idle_minutes,omitempty"`

	// DeleteAfterPausedDays Days a machine stays paused before it is deleted, counted from when it paused; a resume ends the paused period and the next pause starts a new one. A session that receives input after its machine was deleted gets a fresh machine. Machines kept for a person (idle deletion disabled with 0 on their binding or grant) are never deleted by it. Requires pause_after_idle_minutes; cannot be combined with archive_after_paused_days.
	DeleteAfterPausedDays *int32  `json:"delete_after_paused_days,omitempty"`
	Description           *string `json:"description,omitempty"`
	MaxMachineCPU         *int32  `json:"max_machine_cpu,omitempty"`
	MaxMachineMemoryMb    *int32  `json:"max_machine_memory_mb,omitempty"`

	// MaxTotalCPU Deprecated, not enforced: organization and project in-use machine CPU quotas govern capacity.
	MaxTotalCPU *int32 `json:"max_total_cpu,omitempty"`

	// MaxTotalMachines Deprecated, not enforced: how many machines a pool has no longer blocks new machines. Organization and project quotas over in-use machines (org resource limits max_in_use_pool_machines_per_project and max_in_use_pool_machines_per_org) govern capacity.
	MaxTotalMachines int32 `json:"max_total_machines"`

	// MaxTotalMemoryMb Deprecated, not enforced: organization and project in-use machine memory quotas govern capacity.
	MaxTotalMemoryMb *int32 `json:"max_total_memory_mb,omitempty"`

	// Metadata User-supplied metadata stored on a machine, provided directly or copied from the machine pool that provisions it. A restriction of Metadata that leaves room for one reserved pair - BMA sets observed_platform on the machine to the platform reported by its daemon, so the key is reserved and at most 15 user pairs are accepted.
	Metadata           *MachineMetadata `json:"metadata,omitempty"`
	MinMachineCPU      *int32           `json:"min_machine_cpu,omitempty"`
	MinMachineMemoryMb *int32           `json:"min_machine_memory_mb,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`

	// PauseAfterIdleMinutes Idle minutes before pausing a machine from this pool. A paused machine keeps its disk and resumes on the next command, terminal, desktop, or explicit resume. Exclusive with delete_after_idle_minutes; a grant or agent source delete policy still wins.
	PauseAfterIdleMinutes *int32 `json:"pause_after_idle_minutes,omitempty"`
	Provider              string `json:"provider"`

	// ProviderAuthSecretID Secret ID (sec_...).
	ProviderAuthSecretID SecretID                `json:"provider_auth_secret_id"`
	ProviderConfig       *map[string]interface{} `json:"provider_config,omitempty"`

	// RuntimeProtectionEnabled Whether BMA should delete a pool machine when its provider remains running after its daemon becomes inactive. Defaults to false when omitted.
	RuntimeProtectionEnabled *bool `json:"runtime_protection_enabled,omitempty"`
	// contains filtered or unexported fields
}

CreateMachinePoolRequest defines model for CreateMachinePoolRequest.

func (CreateMachinePoolRequest) AsCreateMachinePoolRequest0 

func (t CreateMachinePoolRequest) AsCreateMachinePoolRequest0() (CreateMachinePoolRequest0, error)

AsCreateMachinePoolRequest0 returns the union data inside the CreateMachinePoolRequest as a CreateMachinePoolRequest0

func (CreateMachinePoolRequest) AsCreateMachinePoolRequest1 

func (t CreateMachinePoolRequest) AsCreateMachinePoolRequest1() (CreateMachinePoolRequest1, error)

AsCreateMachinePoolRequest1 returns the union data inside the CreateMachinePoolRequest as a CreateMachinePoolRequest1

func (CreateMachinePoolRequest) AsCreateMachinePoolRequest2 

func (t CreateMachinePoolRequest) AsCreateMachinePoolRequest2() (CreateMachinePoolRequest2, error)

AsCreateMachinePoolRequest2 returns the union data inside the CreateMachinePoolRequest as a CreateMachinePoolRequest2

func (*CreateMachinePoolRequest) FromCreateMachinePoolRequest0 

func (t *CreateMachinePoolRequest) FromCreateMachinePoolRequest0(v CreateMachinePoolRequest0) error

FromCreateMachinePoolRequest0 overwrites any union data inside the CreateMachinePoolRequest as the provided CreateMachinePoolRequest0

func (*CreateMachinePoolRequest) FromCreateMachinePoolRequest1 

func (t *CreateMachinePoolRequest) FromCreateMachinePoolRequest1(v CreateMachinePoolRequest1) error

FromCreateMachinePoolRequest1 overwrites any union data inside the CreateMachinePoolRequest as the provided CreateMachinePoolRequest1

func (*CreateMachinePoolRequest) FromCreateMachinePoolRequest2 

func (t *CreateMachinePoolRequest) FromCreateMachinePoolRequest2(v CreateMachinePoolRequest2) error

FromCreateMachinePoolRequest2 overwrites any union data inside the CreateMachinePoolRequest as the provided CreateMachinePoolRequest2

func (CreateMachinePoolRequest) MarshalJSON 

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

func (*CreateMachinePoolRequest) MergeCreateMachinePoolRequest0 

func (t *CreateMachinePoolRequest) MergeCreateMachinePoolRequest0(v CreateMachinePoolRequest0) error

MergeCreateMachinePoolRequest0 performs a merge with any union data inside the CreateMachinePoolRequest, using the provided CreateMachinePoolRequest0

func (*CreateMachinePoolRequest) MergeCreateMachinePoolRequest1 

func (t *CreateMachinePoolRequest) MergeCreateMachinePoolRequest1(v CreateMachinePoolRequest1) error

MergeCreateMachinePoolRequest1 performs a merge with any union data inside the CreateMachinePoolRequest, using the provided CreateMachinePoolRequest1

func (*CreateMachinePoolRequest) MergeCreateMachinePoolRequest2 

func (t *CreateMachinePoolRequest) MergeCreateMachinePoolRequest2(v CreateMachinePoolRequest2) error

MergeCreateMachinePoolRequest2 performs a merge with any union data inside the CreateMachinePoolRequest, using the provided CreateMachinePoolRequest2

func (*CreateMachinePoolRequest) UnmarshalJSON 

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

type CreateMachinePoolRequest0 

type CreateMachinePoolRequest0 struct {
	DefaultMachineCPU      int32                             `json:"default_machine_cpu"`
	DefaultMachineMemoryMb int32                             `json:"default_machine_memory_mb"`
	MaxMachineCPU          int32                             `json:"max_machine_cpu"`
	MaxMachineMemoryMb     int32                             `json:"max_machine_memory_mb"`
	MaxTotalCPU            int32                             `json:"max_total_cpu"`
	MaxTotalMemoryMb       int32                             `json:"max_total_memory_mb"`
	Provider               CreateMachinePoolRequest0Provider `json:"provider"`
}

CreateMachinePoolRequest0 defines model for .

type CreateMachinePoolRequest0Provider 

type CreateMachinePoolRequest0Provider string

CreateMachinePoolRequest0Provider defines model for CreateMachinePoolRequest.0.Provider. 

const (
	Arker     CreateMachinePoolRequest0Provider = "arker"
	Freestyle CreateMachinePoolRequest0Provider = "freestyle"
	Modal     CreateMachinePoolRequest0Provider = "modal"
	Tenki     CreateMachinePoolRequest0Provider = "tenki"
	Unikraft  CreateMachinePoolRequest0Provider = "unikraft"
)

Defines values for CreateMachinePoolRequest0Provider.

func (CreateMachinePoolRequest0Provider) Valid 

func (e CreateMachinePoolRequest0Provider) Valid() bool

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

type CreateMachinePoolRequest1 

type CreateMachinePoolRequest1 struct {
	MaxMachineCPU      int32                             `json:"max_machine_cpu"`
	MaxMachineMemoryMb int32                             `json:"max_machine_memory_mb"`
	MaxTotalCPU        int32                             `json:"max_total_cpu"`
	MaxTotalMemoryMb   int32                             `json:"max_total_memory_mb"`
	Provider           CreateMachinePoolRequest1Provider `json:"provider"`
}

CreateMachinePoolRequest1 defines model for .

type CreateMachinePoolRequest1Provider 

type CreateMachinePoolRequest1Provider string

CreateMachinePoolRequest1Provider defines model for CreateMachinePoolRequest.1.Provider. 

const (
	Boxd       CreateMachinePoolRequest1Provider = "boxd"
	Createos   CreateMachinePoolRequest1Provider = "createos"
	Daytona    CreateMachinePoolRequest1Provider = "daytona"
	E2B        CreateMachinePoolRequest1Provider = "e2b"
	Superserve CreateMachinePoolRequest1Provider = "superserve"
)

Defines values for CreateMachinePoolRequest1Provider.

func (CreateMachinePoolRequest1Provider) Valid 

func (e CreateMachinePoolRequest1Provider) Valid() bool

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

type CreateMachinePoolRequest2 

type CreateMachinePoolRequest2 struct {
	DefaultMachineMemoryMb int32                             `json:"default_machine_memory_mb"`
	MaxMachineMemoryMb     int32                             `json:"max_machine_memory_mb"`
	MaxTotalMemoryMb       int32                             `json:"max_total_memory_mb"`
	Provider               CreateMachinePoolRequest2Provider `json:"provider"`
}

CreateMachinePoolRequest2 defines model for .

type CreateMachinePoolRequest2Provider 

type CreateMachinePoolRequest2Provider string

CreateMachinePoolRequest2Provider defines model for CreateMachinePoolRequest.2.Provider. 

const (
	Blaxel CreateMachinePoolRequest2Provider = "blaxel"
)

Defines values for CreateMachinePoolRequest2Provider.

func (CreateMachinePoolRequest2Provider) Valid 

func (e CreateMachinePoolRequest2Provider) Valid() bool

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

type CreateMachinePoolRequestBase 

type CreateMachinePoolRequestBase struct {
	// ArchiveAfterPausedDays Days a machine stays paused before it is archived. An archived machine is restored on the next access. Requires pause_after_idle_minutes.
	ArchiveAfterPausedDays *int32  `json:"archive_after_paused_days,omitempty"`
	DefaultCwd             *string `json:"default_cwd,omitempty"`
	DefaultMachineCPU      *int32  `json:"default_machine_cpu,omitempty"`

	// DefaultMachineEnv Default environment for pool machines. A machine's environment, including resolved secret_env values, is applied to the provider machine at provisioning, so the provider_options startup_script and the daemon run with it, and is resolved again for each process at launch.
	DefaultMachineEnv             *map[string]string     `json:"default_machine_env,omitempty"`
	DefaultMachineMemoryMb        *int32                 `json:"default_machine_memory_mb,omitempty"`
	DefaultMachineProviderOptions map[string]interface{} `json:"default_machine_provider_options"`

	// DefaultMachineSecretEnv Default secret environment for pool machines, mapping env names to generic secret references. References are resolved to secret values wherever the machine environment is applied.
	DefaultMachineSecretEnv *map[string]SecretID `json:"default_machine_secret_env,omitempty"`

	// DeleteAfterIdleMinutes Idle minutes before deleting a machine from this pool. Omit to leave the pool default unset; a grant or agent source may still override it.
	DeleteAfterIdleMinutes *int32 `json:"delete_after_idle_minutes,omitempty"`

	// DeleteAfterPausedDays Days a machine stays paused before it is deleted, counted from when it paused; a resume ends the paused period and the next pause starts a new one. A session that receives input after its machine was deleted gets a fresh machine. Machines kept for a person (idle deletion disabled with 0 on their binding or grant) are never deleted by it. Requires pause_after_idle_minutes; cannot be combined with archive_after_paused_days.
	DeleteAfterPausedDays *int32  `json:"delete_after_paused_days,omitempty"`
	Description           *string `json:"description,omitempty"`
	MaxMachineCPU         *int32  `json:"max_machine_cpu,omitempty"`
	MaxMachineMemoryMb    *int32  `json:"max_machine_memory_mb,omitempty"`

	// MaxTotalCPU Deprecated, not enforced: organization and project in-use machine CPU quotas govern capacity.
	MaxTotalCPU *int32 `json:"max_total_cpu,omitempty"`

	// MaxTotalMachines Deprecated, not enforced: how many machines a pool has no longer blocks new machines. Organization and project quotas over in-use machines (org resource limits max_in_use_pool_machines_per_project and max_in_use_pool_machines_per_org) govern capacity.
	MaxTotalMachines int32 `json:"max_total_machines"`

	// MaxTotalMemoryMb Deprecated, not enforced: organization and project in-use machine memory quotas govern capacity.
	MaxTotalMemoryMb *int32 `json:"max_total_memory_mb,omitempty"`

	// Metadata User-supplied metadata stored on a machine, provided directly or copied from the machine pool that provisions it. A restriction of Metadata that leaves room for one reserved pair - BMA sets observed_platform on the machine to the platform reported by its daemon, so the key is reserved and at most 15 user pairs are accepted.
	Metadata           *MachineMetadata `json:"metadata,omitempty"`
	MinMachineCPU      *int32           `json:"min_machine_cpu,omitempty"`
	MinMachineMemoryMb *int32           `json:"min_machine_memory_mb,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`

	// PauseAfterIdleMinutes Idle minutes before pausing a machine from this pool. A paused machine keeps its disk and resumes on the next command, terminal, desktop, or explicit resume. Exclusive with delete_after_idle_minutes; a grant or agent source delete policy still wins.
	PauseAfterIdleMinutes *int32 `json:"pause_after_idle_minutes,omitempty"`
	Provider              string `json:"provider"`

	// ProviderAuthSecretID Secret ID (sec_...).
	ProviderAuthSecretID SecretID                `json:"provider_auth_secret_id"`
	ProviderConfig       *map[string]interface{} `json:"provider_config,omitempty"`

	// RuntimeProtectionEnabled Whether BMA should delete a pool machine when its provider remains running after its daemon becomes inactive. Defaults to false when omitted.
	RuntimeProtectionEnabled *bool `json:"runtime_protection_enabled,omitempty"`
}

CreateMachinePoolRequestBase defines model for CreateMachinePoolRequestBase.

type CreateMachineRequest 

type CreateMachineRequest struct {
	Cwd         *string `json:"cwd,omitempty"`
	Description *string `json:"description,omitempty"`

	// DisplayName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	DisplayName ResourceName       `json:"display_name"`
	Env         *map[string]string `json:"env,omitempty"`

	// Metadata User-supplied metadata stored on a machine, provided directly or copied from the machine pool that provisions it. A restriction of Metadata that leaves room for one reserved pair - BMA sets observed_platform on the machine to the platform reported by its daemon, so the key is reserved and at most 15 user pairs are accepted.
	Metadata  *MachineMetadata     `json:"metadata,omitempty"`
	SecretEnv *map[string]SecretID `json:"secret_env,omitempty"`
}

CreateMachineRequest defines model for CreateMachineRequest.

type CreateMemoryStore 

type CreateMemoryStore struct {
	AgentAccess *MemoryStoreAccess `json:"agent_access,omitempty"`
	Description *string            `json:"description,omitempty"`

	// Name Machine-readable memory store identifier consisting of lowercase ASCII segments separated by single hyphens.
	Name MemoryStoreName `json:"name"`
}

CreateMemoryStore defines model for CreateMemoryStore.

type CreateMemoryStoreJSONRequestBody 

type CreateMemoryStoreJSONRequestBody = CreateMemoryStore

CreateMemoryStoreJSONRequestBody defines body for CreateMemoryStore for application/json ContentType.

type CreateModelProviderConfigJSONRequestBody 

type CreateModelProviderConfigJSONRequestBody = CreateModelProviderConfigRequest

CreateModelProviderConfigJSONRequestBody defines body for CreateModelProviderConfig for application/json ContentType.

type CreateModelProviderConfigRequest 

type CreateModelProviderConfigRequest struct {
	// APIFormat Wire protocol the model endpoint speaks: openai-responses, openai-chat-completions, or anthropic-messages.
	APIFormat *ModelAPIFormat `json:"api_format,omitempty"`

	// APIVariant Provider-specific flavor of the API format: default, openrouter, or bedrock.
	APIVariant *ModelProviderAPIVariant `json:"api_variant,omitempty"`

	// AuthKind How the credential is sent: bearer_token, api_key_header, or sigv4 (AWS).
	AuthKind *ModelProviderAuthKind `json:"auth_kind,omitempty"`

	// AuthOptions Non-secret authentication settings. Use an empty object with bearer_token. With api_key_header, set {"header_name":"..."}; Anthropic Messages defaults to {"header_name":"x-api-key"}. With sigv4, set the AWS signing service and region.
	AuthOptions *struct {
		HeaderName *string `json:"header_name,omitempty"`
		Region     *string `json:"region,omitempty"`
		Service    *string `json:"service,omitempty"`
	} `json:"auth_options,omitempty"`

	// BaseURL Provider endpoint base URL. Normal API mode requires a public HTTPS endpoint; localhost and loopback endpoints are accepted only when the API is running in insecure dev mode.
	BaseURL *string `json:"base_url,omitempty"`

	// CredentialSecretID Secret ID (sec_...).
	CredentialSecretID SecretID `json:"credential_secret_id"`

	// EndpointPath URL path under base_url. Defaults to /responses for OpenAI Responses, /chat/completions for Chat Completions, and /messages for Anthropic Messages.
	EndpointPath *string `json:"endpoint_path,omitempty"`

	// Headers Extra HTTP headers sent with every request to this provider. Values are stored and returned as plain text; use secret_headers for keys and tokens.
	Headers *map[string]string `json:"headers,omitempty"`

	// IdleTimeoutMs Maximum wait for response headers or the next response bytes, in milliseconds. Heartbeats count as activity. Defaults to 300000 (5 minutes). Local response processing does not consume this idle budget.
	IdleTimeoutMs *int `json:"idle_timeout_ms,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`

	// Preset Built-in provider settings: openai, openrouter, or anthropic. A preset fills in api_format, api_variant, base_url, endpoint_path, auth_kind, and auth_options, so omit those when using one.
	Preset *CreateModelProviderConfigRequestPreset `json:"preset,omitempty"`

	// RequestTimeoutMs Total deadline for one provider attempt, including reasoning and response streaming, in milliseconds. Defaults to 3600000 (60 minutes). Retries have separate deadlines.
	RequestTimeoutMs *int `json:"request_timeout_ms,omitempty"`

	// SecretHeaders Extra HTTP headers whose values come from org-owned generic secrets, mapping header names to secret references.
	SecretHeaders *map[string]SecretID `json:"secret_headers,omitempty"`
}

CreateModelProviderConfigRequest Connect BMA to a model API endpoint. Use a preset for built-in providers, or provide api_format and base_url for a custom endpoint. When omitted, endpoint_path and auth settings are filled from api_format.

type CreateModelProviderConfigRequestPreset 

type CreateModelProviderConfigRequestPreset string

CreateModelProviderConfigRequestPreset Built-in provider settings: openai, openrouter, or anthropic. A preset fills in api_format, api_variant, base_url, endpoint_path, auth_kind, and auth_options, so omit those when using one. 

const (
	CreateModelProviderConfigRequestPresetAnthropic  CreateModelProviderConfigRequestPreset = "anthropic"
	CreateModelProviderConfigRequestPresetOpenai     CreateModelProviderConfigRequestPreset = "openai"
	CreateModelProviderConfigRequestPresetOpenrouter CreateModelProviderConfigRequestPreset = "openrouter"
)

Defines values for CreateModelProviderConfigRequestPreset.

func (CreateModelProviderConfigRequestPreset) Valid 

func (e CreateModelProviderConfigRequestPreset) Valid() bool

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

type CreateModelProviderConfigResponse 

type CreateModelProviderConfigResponse struct {
	Config ModelProviderConfig `json:"config"`

	// ModelCatalog The provider's model catalog, obtained by validating the configured credential and probing the provider's /models endpoint. A failed probe does not affect the stored config; treat it as a warning that the base URL or API key may be invalid.
	ModelCatalog ModelCatalog `json:"model_catalog"`
}

CreateModelProviderConfigResponse defines model for CreateModelProviderConfigResponse.

type CreateOrgAPIKeyJSONRequestBody 

type CreateOrgAPIKeyJSONRequestBody = CreateOrgAPIKeyRequest

CreateOrgAPIKeyJSONRequestBody defines body for CreateOrgAPIKey for application/json ContentType.

type CreateOrgAPIKeyRequest 

type CreateOrgAPIKeyRequest struct {
	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`

	// OrgRole The key's org role. Org API keys can never hold the owner role.
	OrgRole OrgAPIKeyRole `json:"org_role"`
}

CreateOrgAPIKeyRequest defines model for CreateOrgAPIKeyRequest.

type CreateOrgAPIKeyResponse 

type CreateOrgAPIKeyResponse struct {
	APIKey OrgAPIKey `json:"api_key"`

	// Token Opaque bearer credential.
	Token string `json:"token"`
}

CreateOrgAPIKeyResponse defines model for CreateOrgAPIKeyResponse.

type CreateOrgInvitationJSONRequestBody 

type CreateOrgInvitationJSONRequestBody = CreateOrgInvitationRequest

CreateOrgInvitationJSONRequestBody defines body for CreateOrgInvitation for application/json ContentType.

type CreateOrgInvitationRequest 

type CreateOrgInvitationRequest struct {
	Email openapi_types.Email `json:"email"`
	Role  string              `json:"role"`
}

CreateOrgInvitationRequest defines model for CreateOrgInvitationRequest.

type CreateOrganizationJSONRequestBody 

type CreateOrganizationJSONRequestBody = CreateOrganizationRequest

CreateOrganizationJSONRequestBody defines body for CreateOrganization for application/json ContentType.

type CreateOrganizationParams 

type CreateOrganizationParams struct {
	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreateOrganizationParams defines parameters for CreateOrganization.

type CreateOrganizationRequest 

type CreateOrganizationRequest struct {
	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`
}

CreateOrganizationRequest defines model for CreateOrganizationRequest.

type CreateOrganizationResponse 

type CreateOrganizationResponse struct {
	Membership OrganizationMembership `json:"membership"`
	Org        Organization           `json:"org"`
	Project    Project                `json:"project"`
}

CreateOrganizationResponse defines model for CreateOrganizationResponse.

type CreatePersonalAccessTokenJSONRequestBody 

type CreatePersonalAccessTokenJSONRequestBody = CreatePersonalAccessTokenRequest

CreatePersonalAccessTokenJSONRequestBody defines body for CreatePersonalAccessToken for application/json ContentType.

type CreatePersonalAccessTokenRequest 

type CreatePersonalAccessTokenRequest struct {
	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`
}

CreatePersonalAccessTokenRequest defines model for CreatePersonalAccessTokenRequest.

type CreatePersonalAccessTokenResponse 

type CreatePersonalAccessTokenResponse struct {
	// Token Opaque bearer credential.
	Token       string              `json:"token"`
	TokenRecord PersonalAccessToken `json:"token_record"`
}

CreatePersonalAccessTokenResponse defines model for CreatePersonalAccessTokenResponse.

type CreateProjectJSONRequestBody 

type CreateProjectJSONRequestBody = CreateProjectRequest

CreateProjectJSONRequestBody defines body for CreateProject for application/json ContentType.

type CreateProjectMachineGrantJSONRequestBody 

type CreateProjectMachineGrantJSONRequestBody = CreateProjectMachineGrantRequest

CreateProjectMachineGrantJSONRequestBody defines body for CreateProjectMachineGrant for application/json ContentType.

type CreateProjectMachineGrantParams 

type CreateProjectMachineGrantParams struct {
	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreateProjectMachineGrantParams defines parameters for CreateProjectMachineGrant.

type CreateProjectMachineGrantRequest 

type CreateProjectMachineGrantRequest struct {
	// Description Optional note about this grant.
	Description *string `json:"description,omitempty"`

	// MachineID Machine ID (mch_...).
	MachineID MachineID `json:"machine_id"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata *Metadata `json:"metadata,omitempty"`
}

CreateProjectMachineGrantRequest defines model for CreateProjectMachineGrantRequest.

type CreateProjectMachineGrantResponse 

type CreateProjectMachineGrantResponse struct {
	Grant   ProjectMachineGrant `json:"grant"`
	Machine Machine             `json:"machine"`
}

CreateProjectMachineGrantResponse defines model for CreateProjectMachineGrantResponse.

type CreateProjectMachinePoolGrantJSONRequestBody 

type CreateProjectMachinePoolGrantJSONRequestBody = CreateProjectMachinePoolGrantRequest

CreateProjectMachinePoolGrantJSONRequestBody defines body for CreateProjectMachinePoolGrant for application/json ContentType.

type CreateProjectMachinePoolGrantParams 

type CreateProjectMachinePoolGrantParams struct {
	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreateProjectMachinePoolGrantParams defines parameters for CreateProjectMachinePoolGrant.

type CreateProjectMachinePoolGrantRequest 

type CreateProjectMachinePoolGrantRequest struct {
	// DefaultCwd Default working directory for processes on this project's machines from the pool.
	DefaultCwd *string `json:"default_cwd,omitempty"`

	// DefaultMachineCPU Default CPU count for machines this project creates from the pool, overriding the pool's default.
	DefaultMachineCPU *int32 `json:"default_machine_cpu,omitempty"`

	// DefaultMachineEnvOverlay Env overlay merged over the pool's default_machine_env for machines materialized through this grant; a null entry removes the key.
	DefaultMachineEnvOverlay *map[string]*string `json:"default_machine_env_overlay,omitempty"`

	// DefaultMachineMemoryMb Default memory in MB for machines this project creates from the pool, overriding the pool's default.
	DefaultMachineMemoryMb *int32 `json:"default_machine_memory_mb,omitempty"`

	// DefaultMachineProviderOptionsOverlay Provider-specific options layered over the pool's provider options for this project's machines.
	DefaultMachineProviderOptionsOverlay *map[string]interface{} `json:"default_machine_provider_options_overlay,omitempty"`

	// DefaultMachineSecretEnvOverlay Secret env overlay merged over the pool's default_machine_secret_env for machines materialized through this grant; a null entry removes the key.
	DefaultMachineSecretEnvOverlay *map[string]*string `json:"default_machine_secret_env_overlay,omitempty"`

	// DeleteAfterIdleMinutes Idle minutes before deleting a machine created through this grant. Use 0 to disable for this grant; omit to inherit the pool default. Values from 1 through 4 are invalid.
	DeleteAfterIdleMinutes *int32 `json:"delete_after_idle_minutes,omitempty"`

	// Description Optional note about this grant.
	Description *string `json:"description,omitempty"`

	// MachinePoolID Machine pool ID (mpo_...).
	MachinePoolID MachinePoolID `json:"machine_pool_id"`

	// MaxMachineCPU Largest CPU count one of this project's machines can request.
	MaxMachineCPU *int32 `json:"max_machine_cpu,omitempty"`

	// MaxMachineMemoryMb Largest memory in MB one of this project's machines can request.
	MaxMachineMemoryMb *int32 `json:"max_machine_memory_mb,omitempty"`

	// MaxTotalCPU Maximum total CPU across this project's live machines from the pool.
	MaxTotalCPU *int32 `json:"max_total_cpu,omitempty"`

	// MaxTotalMachines Maximum number of live machines this project can have from the pool.
	MaxTotalMachines *int32 `json:"max_total_machines,omitempty"`

	// MaxTotalMemoryMb Maximum total memory in MB across this project's live machines from the pool.
	MaxTotalMemoryMb *int32 `json:"max_total_memory_mb,omitempty"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata *Metadata `json:"metadata,omitempty"`

	// MinMachineCPU Smallest CPU count one of this project's machines can request.
	MinMachineCPU *int32 `json:"min_machine_cpu,omitempty"`

	// MinMachineMemoryMb Smallest memory in MB one of this project's machines can request.
	MinMachineMemoryMb *int32 `json:"min_machine_memory_mb,omitempty"`
}

CreateProjectMachinePoolGrantRequest defines model for CreateProjectMachinePoolGrantRequest.

type CreateProjectModelGrantJSONRequestBody 

type CreateProjectModelGrantJSONRequestBody = CreateProjectModelGrantRequest

CreateProjectModelGrantJSONRequestBody defines body for CreateProjectModelGrant for application/json ContentType.

type CreateProjectModelGrantRequest 

type CreateProjectModelGrantRequest struct {
	ConfiguredModelID ConfiguredModelID `json:"configured_model_id"`

	// ContextWindowTokens Optional project context budget for input and output tokens. Cannot exceed the configured model's budget. Triggers compaction when estimated input exceeds the remaining budget after output and safety reserves. The turn fails if compaction cannot make it fit.
	ContextWindowTokens *int `json:"context_window_tokens,omitempty"`

	// DefaultCacheRetention Prompt-cache preference for model requests; `short` when omitted. `short` applies the route's default caching (explicit cache breakpoints where the provider requires them) and, where the route accepts one, a stable conversation key for cache-aware routing. `long` prefers the route's extended cache lifetime where one exists (currently Anthropic's one-hour cache, which on Bedrock requires Claude 4.5 or newer) and behaves like `short` elsewhere. `none` sends no BMA-managed cache controls or conversation key; providers may still cache prefixes on their own.
	DefaultCacheRetention *ModelCacheRetention `json:"default_cache_retention,omitempty"`

	// DefaultMaxOutputTokens Optional project default per-request output-token cap.
	DefaultMaxOutputTokens *int `json:"default_max_output_tokens,omitempty"`

	// DefaultReasoningEffort Optional project default reasoning effort.
	DefaultReasoningEffort *string `json:"default_reasoning_effort,omitempty"`

	// InputModalities Optional project subset of configured-model input types (text, image, or file). Empty or omitted means inherit.
	InputModalities *[]string `json:"input_modalities,omitempty"`

	// MaxOutputTokens Optional project output-token ceiling. Cannot exceed the configured model's ceiling.
	MaxOutputTokens *int `json:"max_output_tokens,omitempty"`

	// OutputModalities Optional project subset of configured-model output types. Empty or omitted means inherit.
	OutputModalities *[]string `json:"output_modalities,omitempty"`

	// SupportedReasoningEfforts Optional project subset of configured-model reasoning efforts. If this excludes the inherited default_reasoning_effort, set default_reasoning_effort on the grant too.
	SupportedReasoningEfforts *[]string `json:"supported_reasoning_efforts,omitempty"`

	// SupportsReasoning Optional project-level reasoning gate. Can disable reasoning, but cannot enable reasoning when the configured model does not support it.
	SupportsReasoning *bool `json:"supports_reasoning,omitempty"`

	// SupportsTools Optional project-level tool-use gate. Can disable tools, but cannot enable tools when the configured model does not support them.
	SupportsTools *bool `json:"supports_tools,omitempty"`
}

CreateProjectModelGrantRequest Grant a project access to a configured model. Optional fields can narrow the model's limits for this project; omitted fields inherit from the org-level configured model.

type CreateProjectParams 

type CreateProjectParams struct {
	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

CreateProjectParams defines parameters for CreateProject.

type CreateProjectRequest 

type CreateProjectRequest struct {
	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`
}

CreateProjectRequest defines model for CreateProjectRequest.

type CreateSecretGrantJSONRequestBody 

type CreateSecretGrantJSONRequestBody = SecretGrantCreateRequest

CreateSecretGrantJSONRequestBody defines body for CreateSecretGrant for application/json ContentType.

type CreateSecretJSONRequestBody 

type CreateSecretJSONRequestBody = CreateSecretRequest

CreateSecretJSONRequestBody defines body for CreateSecret for application/json ContentType.

type CreateSecretRequest 

type CreateSecretRequest struct {
	// Material The secret's value. kind selects its shape: generic, oauth_token_set, aws_credentials, or github_app_credentials.
	Material SecretMaterial `json:"material"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata *Metadata `json:"metadata,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`

	// Owner Who owns the secret: {"kind":"org"}, {"kind":"project","project_id":"proj_..."}, or {"kind":"user"}. The owner cannot change later.
	Owner SecretOwnerInput `json:"owner"`
}

CreateSecretRequest defines model for CreateSecretRequest.

type CreateSecretVersionJSONRequestBody 

type CreateSecretVersionJSONRequestBody = SecretVersionRequest

CreateSecretVersionJSONRequestBody defines body for CreateSecretVersion for application/json ContentType.

type CreateSkillGrantJSONRequestBody 

type CreateSkillGrantJSONRequestBody = SkillGrantCreateRequest

CreateSkillGrantJSONRequestBody defines body for CreateSkillGrant for application/json ContentType.

type CreateSkillMultipartRequestBody 

type CreateSkillMultipartRequestBody = CreateSkillRequest

CreateSkillMultipartRequestBody defines body for CreateSkill for multipart/form-data ContentType.

type CreateSkillRequest 

type CreateSkillRequest struct {
	Archive openapi_types.File `json:"archive"`
	Owner   SkillOwnerInput    `json:"owner"`
}

CreateSkillRequest defines model for CreateSkillRequest.

type CreateSlackSetupRequest 

type CreateSlackSetupRequest struct {
	AppConfigurationToken string          `json:"app_configuration_token"`
	AppName               string          `json:"app_name"`
	Icon                  *SlackSetupIcon `json:"icon,omitempty"`
	ReturnTo              *string         `json:"return_to,omitempty"`
}

CreateSlackSetupRequest defines model for CreateSlackSetupRequest.

type CreateTerminalConnectionTicketJSONRequestBody 

type CreateTerminalConnectionTicketJSONRequestBody = CreateConnectionTicketRequest

CreateTerminalConnectionTicketJSONRequestBody defines body for CreateTerminalConnectionTicket for application/json ContentType.

type CreateTerminalSessionJSONRequestBody 

type CreateTerminalSessionJSONRequestBody = CreateTerminalSessionRequest

CreateTerminalSessionJSONRequestBody defines body for CreateTerminalSession for application/json ContentType.

type CreateTerminalSessionRequest 

type CreateTerminalSessionRequest struct {
	Cols  *int32  `json:"cols,omitempty"`
	Cwd   *string `json:"cwd,omitempty"`
	Rows  *int32  `json:"rows,omitempty"`
	Shell *string `json:"shell,omitempty"`
}

CreateTerminalSessionRequest defines model for CreateTerminalSessionRequest.

type CreatedResourceListSort 

type CreatedResourceListSort string

CreatedResourceListSort Sort order for named resources that expose a created timestamp. 

const (
	CreatedResourceListSortCreatedAt      CreatedResourceListSort = "created_at"
	CreatedResourceListSortMinusCreatedAt CreatedResourceListSort = "-created_at"
	CreatedResourceListSortMinusName      CreatedResourceListSort = "-name"
	CreatedResourceListSortName           CreatedResourceListSort = "name"
)

Defines values for CreatedResourceListSort.

func (CreatedResourceListSort) Valid 

func (e CreatedResourceListSort) Valid() bool

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

type CronExpression 

type CronExpression = string

CronExpression Standard five-field cron expression (minute, hour, day of month, month, day of week). `TZ=`/`CRON_TZ=` prefixes are rejected; set the `timezone` field instead.

type CronMessageTemplate 

type CronMessageTemplate = string

CronMessageTemplate Go text/template rendered on each firing to produce the message sent to the target. The template receives a `trigger` value with `name`, `fired_at`, `last_fired_at`, and `local_date` fields. Timestamps remain UTC; local_date is the scheduled occurrence's ISO date in the schedule timezone. Required for agent and profile targets; omitted for integration targets, which use their own settings. Rendering is capped at 64 KiB of output and one second of wall-clock time, and `printf` width and precision specifiers are capped at 1024; a firing whose template fails to render is recorded in `failure_report` without sending a message.

type CronTimezone 

type CronTimezone = string

CronTimezone IANA time zone the schedule is evaluated in.

type CronTrigger 

type CronTrigger struct {
	CreatedAt Timestamp `json:"created_at"`

	// Cron Standard five-field cron expression (minute, hour, day of month, month, day of week). `TZ=`/`CRON_TZ=` prefixes are rejected; set the `timezone` field instead.
	Cron    CronExpression `json:"cron"`
	Enabled bool           `json:"enabled"`

	// FailureReport Most recent failed firing, or null if no firing has failed since the last successful firing.
	FailureReport *CronTriggerFailureReport `json:"failure_report"`
	ID            CronTriggerID             `json:"id"`

	// LastFiredAt When the trigger last fired, or null if it has never fired. For integration targets this means durable inbox handoff.
	LastFiredAt *Timestamp `json:"last_fired_at"`

	// LastRun Status of the latest accepted scheduled integration launch, scoped to this project and integration. Null for ordinary cron, before any launch is accepted, or when retained details have expired. Never falls back to an older launch. Schedule firing failures remain separate in failure_report. Deleting or disabling a schedule does not cancel launch work already accepted by the integration.
	LastRun *CronTriggerLastRun `json:"last_run"`

	// MessageTemplate Go text/template rendered on each firing to produce the message sent to the target. The template receives a `trigger` value with `name`, `fired_at`, `last_fired_at`, and `local_date` fields. Timestamps remain UTC; local_date is the scheduled occurrence's ISO date in the schedule timezone. Required for agent and profile targets; omitted for integration targets, which use their own settings. Rendering is capped at 64 KiB of output and one second of wall-clock time, and `printf` width and precision specifiers are capped at 1024; a firing whose template fails to render is recorded in `failure_report` without sending a message.
	MessageTemplate *CronMessageTemplate `json:"message_template,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`

	// NextFireAt Next scheduled firing, or null while the trigger is disabled.
	NextFireAt *Timestamp     `json:"next_fire_at"`
	OrgID      OrganizationID `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// Target What each firing does: type agent sends the message to an existing agent, type profile launches a new agent from a profile, and type integration hands the firing to an integration, such as a new Slack or Discord thread.
	Target CronTriggerTarget `json:"target"`

	// Timezone IANA time zone the schedule is evaluated in.
	Timezone  CronTimezone `json:"timezone"`
	UpdatedAt Timestamp    `json:"updated_at"`
}

CronTrigger defines model for CronTrigger.

type CronTriggerDeliveryMode 

type CronTriggerDeliveryMode string

CronTriggerDeliveryMode Each firing sends a queued or steering message to the agent. Defaults to `queued` on creation; omitted updates preserve the current mode. 

const (
	Queued   CronTriggerDeliveryMode = "queued"
	Steering CronTriggerDeliveryMode = "steering"
)

Defines values for CronTriggerDeliveryMode.

func (CronTriggerDeliveryMode) Valid 

func (e CronTriggerDeliveryMode) Valid() bool

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

type CronTriggerFailureReport 

type CronTriggerFailureReport struct {
	FailedAt Timestamp `json:"failed_at"`

	// Message Why the most recent failed firing did not deliver a message.
	Message string `json:"message"`

	// WillRetry Whether the firing will be retried after the claim lease expires.
	WillRetry bool `json:"will_retry"`
}

CronTriggerFailureReport defines model for CronTriggerFailureReport.

type CronTriggerID 

type CronTriggerID = string

CronTriggerID defines model for CronTriggerID.

type CronTriggerLastRun 

type CronTriggerLastRun struct {
	CreatedAt Timestamp `json:"created_at"`

	// FailureMessage Coarse scheduled action failure description; no raw provider errors.
	FailureMessage *string `json:"failure_message"`

	// State State of the latest accepted scheduled integration action. Completed means the integration handled the occurrence; it does not indicate completion of any agent task that action started.
	State     CronTriggerLastRunState `json:"state"`
	UpdatedAt Timestamp               `json:"updated_at"`
}

CronTriggerLastRun defines model for CronTriggerLastRun.

type CronTriggerLastRunState 

type CronTriggerLastRunState string

CronTriggerLastRunState State of the latest accepted scheduled integration action. Completed means the integration handled the occurrence; it does not indicate completion of any agent task that action started. 

const (
	CronTriggerLastRunStateCompleted  CronTriggerLastRunState = "completed"
	CronTriggerLastRunStateFailed     CronTriggerLastRunState = "failed"
	CronTriggerLastRunStateProcessing CronTriggerLastRunState = "processing"
	CronTriggerLastRunStateQueued     CronTriggerLastRunState = "queued"
)

Defines values for CronTriggerLastRunState.

func (CronTriggerLastRunState) Valid 

func (e CronTriggerLastRunState) Valid() bool

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

type CronTriggerListParams 

type CronTriggerListParams struct {
	Name           *ResourceNameFilter
	AgentID        *AgentID
	AgentProfileID *AgentProfileID
	IntegrationID  *IntegrationID
	Sort           *ResourceListSort
	Limit          *PageLimit
	Cursor         *PageCursor
}

CronTriggerListParams are the query, header and body fields of listCronTriggers.

type CronTriggerNewParams 

type CronTriggerNewParams struct {
	Cron            CronExpression
	Enabled         *bool
	MessageTemplate *CronMessageTemplate
	Name            ResourceName
	Target          CronTriggerTarget
	Timezone        *CronTimezone
}

CronTriggerNewParams are the query, header and body fields of createCronTrigger.

type CronTriggerService 

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

CronTriggerService groups the cronTriggers methods.

func (*CronTriggerService) Delete 

func (s *CronTriggerService) Delete(ctx context.Context, cronTriggerID string, opts ...option.RequestOption) error

Delete calls deleteCronTrigger: DELETE /orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}.

func (*CronTriggerService) Get 

func (s *CronTriggerService) Get(ctx context.Context, cronTriggerID string, opts ...option.RequestOption) (*CronTrigger, error)

Get calls getCronTrigger: GET /orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}.

func (*CronTriggerService) List 

func (s *CronTriggerService) List(ctx context.Context, params CronTriggerListParams, opts ...option.RequestOption) (*CursorPage[CronTrigger], error)

List calls listCronTriggers: GET /orgs/{orgID}/projects/{projectID}/cron-triggers.

func (*CronTriggerService) ListAutoPaging 

func (s *CronTriggerService) ListAutoPaging(ctx context.Context, params CronTriggerListParams, opts ...option.RequestOption) *CursorPageAutoPager[CronTrigger]

ListAutoPaging iterates every item of listCronTriggers across pages.

func (*CronTriggerService) New 

func (s *CronTriggerService) New(ctx context.Context, params CronTriggerNewParams, opts ...option.RequestOption) (*CronTrigger, error)

New calls createCronTrigger: POST /orgs/{orgID}/projects/{projectID}/cron-triggers.

func (*CronTriggerService) Update 

func (s *CronTriggerService) Update(ctx context.Context, cronTriggerID string, params CronTriggerUpdateParams, opts ...option.RequestOption) (*CronTrigger, error)

Update calls updateCronTrigger: PATCH /orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}.

type CronTriggerTarget 

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

CronTriggerTarget What each firing does: type agent sends the message to an existing agent, type profile launches a new agent from a profile, and type integration hands the firing to an integration, such as a new Slack or Discord thread.

func (CronTriggerTarget) AsAgentCronTriggerTarget 

func (t CronTriggerTarget) AsAgentCronTriggerTarget() (AgentCronTriggerTarget, error)

AsAgentCronTriggerTarget returns the union data inside the CronTriggerTarget as a AgentCronTriggerTarget

func (CronTriggerTarget) AsAgentProfileCronTriggerTarget 

func (t CronTriggerTarget) AsAgentProfileCronTriggerTarget() (AgentProfileCronTriggerTarget, error)

AsAgentProfileCronTriggerTarget returns the union data inside the CronTriggerTarget as a AgentProfileCronTriggerTarget

func (CronTriggerTarget) AsAny 

func (t CronTriggerTarget) AsAny() any

AsAny returns the member of CronTriggerTarget named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (CronTriggerTarget) AsIntegrationCronTriggerTarget 

func (t CronTriggerTarget) AsIntegrationCronTriggerTarget() (IntegrationCronTriggerTarget, error)

AsIntegrationCronTriggerTarget returns the union data inside the CronTriggerTarget as a IntegrationCronTriggerTarget

func (CronTriggerTarget) Discriminator 

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

func (*CronTriggerTarget) FromAgentCronTriggerTarget 

func (t *CronTriggerTarget) FromAgentCronTriggerTarget(v AgentCronTriggerTarget) error

FromAgentCronTriggerTarget overwrites any union data inside the CronTriggerTarget as the provided AgentCronTriggerTarget

func (*CronTriggerTarget) FromAgentProfileCronTriggerTarget 

func (t *CronTriggerTarget) FromAgentProfileCronTriggerTarget(v AgentProfileCronTriggerTarget) error

FromAgentProfileCronTriggerTarget overwrites any union data inside the CronTriggerTarget as the provided AgentProfileCronTriggerTarget

func (*CronTriggerTarget) FromIntegrationCronTriggerTarget 

func (t *CronTriggerTarget) FromIntegrationCronTriggerTarget(v IntegrationCronTriggerTarget) error

FromIntegrationCronTriggerTarget overwrites any union data inside the CronTriggerTarget as the provided IntegrationCronTriggerTarget

func (CronTriggerTarget) MarshalJSON 

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

func (*CronTriggerTarget) MergeAgentCronTriggerTarget 

func (t *CronTriggerTarget) MergeAgentCronTriggerTarget(v AgentCronTriggerTarget) error

MergeAgentCronTriggerTarget performs a merge with any union data inside the CronTriggerTarget, using the provided AgentCronTriggerTarget

func (*CronTriggerTarget) MergeAgentProfileCronTriggerTarget 

func (t *CronTriggerTarget) MergeAgentProfileCronTriggerTarget(v AgentProfileCronTriggerTarget) error

MergeAgentProfileCronTriggerTarget performs a merge with any union data inside the CronTriggerTarget, using the provided AgentProfileCronTriggerTarget

func (*CronTriggerTarget) MergeIntegrationCronTriggerTarget 

func (t *CronTriggerTarget) MergeIntegrationCronTriggerTarget(v IntegrationCronTriggerTarget) error

MergeIntegrationCronTriggerTarget performs a merge with any union data inside the CronTriggerTarget, using the provided IntegrationCronTriggerTarget

func (*CronTriggerTarget) UnmarshalJSON 

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

func (CronTriggerTarget) ValueByDiscriminator 

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

type CronTriggerUpdateParams 

type CronTriggerUpdateParams struct {
	Cron            *CronExpression
	Enabled         *bool
	MessageTemplate *CronMessageTemplate
	Name            *ResourceName
	Target          *CronTriggerTarget
	Timezone        *CronTimezone
}

CronTriggerUpdateParams are the query, header and body fields of updateCronTrigger.

type CurrentAgentResponse 

type CurrentAgentResponse struct {
	Agent Agent `json:"agent"`
}

CurrentAgentResponse defines model for CurrentAgentResponse.

type CurrentUser 

type CurrentUser struct {
	Orgs []CurrentUserOrg    `json:"orgs"`
	User CurrentUserIdentity `json:"user"`
}

CurrentUser defines model for CurrentUser.

type CurrentUserIdentity 

type CurrentUserIdentity struct {
	DisplayName string `json:"display_name"`

	// Email The user's primary verified email, or an empty string if none.
	Email string `json:"email"`
	ID    UserID `json:"id"`
}

CurrentUserIdentity defines model for CurrentUserIdentity.

type CurrentUserOrg 

type CurrentUserOrg struct {
	// CreatedAt Organization creation timestamp, not the membership join timestamp.
	CreatedAt Timestamp      `json:"created_at"`
	ID        OrganizationID `json:"id"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`

	// Role The authenticated user's role in this organization.
	Role string `json:"role"`
}

CurrentUserOrg defines model for CurrentUserOrg.

type CursorPage 

type CursorPage[T any] = apicore.CursorPage[T]

CursorPage is one page of a cursor-paginated list.

type CursorPageAutoPager 

type CursorPageAutoPager[T any] = apicore.AutoPager[T]

CursorPageAutoPager iterates every item across pages.

type DaemonMachineBackupArchive 

type DaemonMachineBackupArchive struct {
	Digest    string `json:"digest"`
	SizeBytes int64  `json:"size_bytes"`
}

DaemonMachineBackupArchive defines model for DaemonMachineBackupArchive.

type DaemonMachineBackupRestore 

type DaemonMachineBackupRestore struct {
	BackupID  string   `json:"backup_id"`
	Digest    string   `json:"digest"`
	Paths     []string `json:"paths"`
	SizeBytes int64    `json:"size_bytes"`
}

DaemonMachineBackupRestore defines model for DaemonMachineBackupRestore.

type DaemonMachineBackupRestoreResult 

type DaemonMachineBackupRestoreResult struct {
	Entries *int                                  `json:"entries,omitempty"`
	Error   *string                               `json:"error,omitempty"`
	Skipped *int                                  `json:"skipped,omitempty"`
	State   DaemonMachineBackupRestoreResultState `json:"state"`
}

DaemonMachineBackupRestoreResult defines model for DaemonMachineBackupRestoreResult.

type DaemonMachineBackupRestoreResultState 

type DaemonMachineBackupRestoreResultState string

DaemonMachineBackupRestoreResultState defines model for DaemonMachineBackupRestoreResult.State. 

const (
	DaemonMachineBackupRestoreStateFailed   DaemonMachineBackupRestoreResultState = "failed"
	DaemonMachineBackupRestoreStateRestored DaemonMachineBackupRestoreResultState = "restored"
)

Defines values for DaemonMachineBackupRestoreResultState.

func (DaemonMachineBackupRestoreResultState) Valid 

func (e DaemonMachineBackupRestoreResultState) Valid() bool

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

type DaemonSessionFile 

type DaemonSessionFile struct {
	Digest string `json:"digest"`
	FileID string `json:"file_id"`

	// MountPath Absolute path below /mnt/session/uploads.
	MountPath  string `json:"mount_path"`
	ResourceID string `json:"resource_id"`
	SizeBytes  int64  `json:"size_bytes"`
}

DaemonSessionFile defines model for DaemonSessionFile.

type DaemonSessionFiles 

type DaemonSessionFiles struct {
	Files     []DaemonSessionFile `json:"files"`
	SessionID string              `json:"session_id"`
}

DaemonSessionFiles The files mounted into an agent session.

type DaemonSessionOutput 

type DaemonSessionOutput struct {
	Digest    string `json:"digest"`
	FileID    string `json:"file_id"`
	SizeBytes int64  `json:"size_bytes"`
}

DaemonSessionOutput defines model for DaemonSessionOutput.

type DeleteMemoryFileParams 

type DeleteMemoryFileParams struct {
	// Path Literal path relative to the store root.
	Path string `form:"path" json:"path"`

	// ExpectedDigest Digest of the contents being replaced or deleted. Required to change an existing file.
	ExpectedDigest string `form:"expected_digest" json:"expected_digest"`
}

DeleteMemoryFileParams defines parameters for DeleteMemoryFile.

type DeletedFile 

type DeletedFile struct {
	// ID File ID (file_...).
	ID   FileID          `json:"id"`
	Type DeletedFileType `json:"type"`
}

DeletedFile defines model for DeletedFile.

type DeletedFileType 

type DeletedFileType string

DeletedFileType defines model for DeletedFile.Type. 

const (
	FileDeleted DeletedFileType = "file_deleted"
)

Defines values for DeletedFileType.

func (DeletedFileType) Valid 

func (e DeletedFileType) Valid() bool

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

type DeletedSessionResource 

type DeletedSessionResource struct {
	ID   string                     `json:"id"`
	Type DeletedSessionResourceType `json:"type"`
}

DeletedSessionResource defines model for DeletedSessionResource.

type DeletedSessionResourceType 

type DeletedSessionResourceType string

DeletedSessionResourceType defines model for DeletedSessionResource.Type. 

const (
	SessionResourceDeleted DeletedSessionResourceType = "session_resource_deleted"
)

Defines values for DeletedSessionResourceType.

func (DeletedSessionResourceType) Valid 

func (e DeletedSessionResourceType) Valid() bool

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

type DesktopAction 

type DesktopAction struct {
	Button  *int32            `json:"button,omitempty"`
	DeltaX  *int32            `json:"delta_x,omitempty"`
	DeltaY  *int32            `json:"delta_y,omitempty"`
	Keysym  *int64            `json:"keysym,omitempty"`
	Kind    DesktopActionKind `json:"kind"`
	Pressed *bool             `json:"pressed,omitempty"`
	Text    *string           `json:"text,omitempty"`
	X       *int32            `json:"x,omitempty"`
	Y       *int32            `json:"y,omitempty"`
}

DesktopAction defines model for DesktopAction.

type DesktopActionKind 

type DesktopActionKind string

DesktopActionKind defines model for DesktopAction.Kind. 

const (
	DesktopActionKindKey           DesktopActionKind = "key"
	DesktopActionKindPointerButton DesktopActionKind = "pointer_button"
	DesktopActionKindPointerMove   DesktopActionKind = "pointer_move"
	DesktopActionKindText          DesktopActionKind = "text"
	DesktopActionKindWheel         DesktopActionKind = "wheel"
)

Defines values for DesktopActionKind.

func (DesktopActionKind) Valid 

func (e DesktopActionKind) Valid() bool

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

type DesktopActionRequest 

type DesktopActionRequest struct {
	Action DesktopAction `json:"action"`
	Seq    int64         `json:"seq"`
}

DesktopActionRequest defines model for DesktopActionRequest.

type DesktopActionResponse 

type DesktopActionResponse struct {
	Seq int64 `json:"seq"`
}

DesktopActionResponse defines model for DesktopActionResponse.

type DesktopAgentActionRequest 

type DesktopAgentActionRequest struct {
	Action     DesktopAction `json:"action"`
	Generation int64         `json:"generation"`
}

DesktopAgentActionRequest defines model for DesktopAgentActionRequest.

type DesktopCapabilities 

type DesktopCapabilities struct {
	ControlVersion              int32 `json:"control_version"`
	Height                      int32 `json:"height"`
	Keyboard                    bool  `json:"keyboard"`
	MaxActionsPerSecond         int32 `json:"max_actions_per_second"`
	Pointer                     bool  `json:"pointer"`
	ProtocolVersion             int32 `json:"protocol_version"`
	RfbFallback                 bool  `json:"rfb_fallback"`
	Screenshot                  bool  `json:"screenshot"`
	Takeover                    bool  `json:"takeover"`
	Text                        bool  `json:"text"`
	TransportFallbackGeneration int64 `json:"transport_fallback_generation"`
	Webrtc                      bool  `json:"webrtc"`
	Width                       int32 `json:"width"`
}

DesktopCapabilities defines model for DesktopCapabilities.

type DesktopCapabilitiesRequest 

type DesktopCapabilitiesRequest struct {
	// Height Framebuffer height in pixels. Set together with width; 800 when both are omitted. Values outside 480..1080 are rejected at create time.
	Height      *int32 `json:"height,omitempty"`
	Keyboard    *bool  `json:"keyboard,omitempty"`
	Pointer     *bool  `json:"pointer,omitempty"`
	RfbFallback *bool  `json:"rfb_fallback,omitempty"`
	Screenshot  *bool  `json:"screenshot,omitempty"`
	Takeover    *bool  `json:"takeover,omitempty"`
	Text        *bool  `json:"text,omitempty"`
	Webrtc      *bool  `json:"webrtc,omitempty"`

	// Width Framebuffer width in pixels. Set together with height; 1280x800 when both are omitted. Values outside 640..1920 are rejected at create time.
	Width *int32 `json:"width,omitempty"`
}

DesktopCapabilitiesRequest defines model for DesktopCapabilitiesRequest.

type DesktopControlLeaseRequest 

type DesktopControlLeaseRequest struct {
	LeaseSeconds *int32 `json:"lease_seconds,omitempty"`
}

DesktopControlLeaseRequest defines model for DesktopControlLeaseRequest.

type DesktopControlStatus 

type DesktopControlStatus struct {
	AgentState     string                   `json:"agent_state"`
	Epoch          int64                    `json:"epoch"`
	Generation     int64                    `json:"generation"`
	Holder         string                   `json:"holder"`
	LeaseExpiresAt *time.Time               `json:"lease_expires_at,omitempty"`
	LeaseID        *string                  `json:"lease_id,omitempty"`
	Mode           DesktopControlStatusMode `json:"mode"`
}

DesktopControlStatus defines model for DesktopControlStatus.

type DesktopControlStatusMode 

type DesktopControlStatusMode string

DesktopControlStatusMode defines model for DesktopControlStatus.Mode. 

const (
	DesktopControlStatusModeAgent  DesktopControlStatusMode = "agent"
	DesktopControlStatusModeHuman  DesktopControlStatusMode = "human"
	DesktopControlStatusModePaused DesktopControlStatusMode = "paused"
)

Defines values for DesktopControlStatusMode.

func (DesktopControlStatusMode) Valid 

func (e DesktopControlStatusMode) Valid() bool

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

type DesktopGenerationRequest 

type DesktopGenerationRequest struct {
	Generation int64 `json:"generation"`
}

DesktopGenerationRequest defines model for DesktopGenerationRequest.

type DesktopObservation 

type DesktopObservation struct {
	Bytes       int32                `json:"bytes"`
	ContentType string               `json:"content_type"`
	Control     DesktopControlStatus `json:"control"`
	Height      int32                `json:"height"`
	Width       int32                `json:"width"`
}

DesktopObservation defines model for DesktopObservation.

type DesktopPending 

type DesktopPending struct {
	Generation  int64            `json:"generation"`
	ID          DesktopPendingID `json:"id"`
	Seq         int64            `json:"seq"`
	SubmittedAt time.Time        `json:"submitted_at"`
}

DesktopPending defines model for DesktopPending.

type DesktopPendingID 

type DesktopPendingID = openapi_types.UUID

DesktopPendingID defines model for DesktopPendingID.

type DesktopScreenshot 

type DesktopScreenshot struct {
	CapturedAt  time.Time `json:"captured_at"`
	ContentType string    `json:"content_type"`
	Height      int32     `json:"height"`

	// ImageBase64 Base64-encoded image bytes.
	ImageBase64 string `json:"image_base64"`
	Width       int32  `json:"width"`
}

DesktopScreenshot defines model for DesktopScreenshot.

type DesktopSession 

type DesktopSession struct {
	AgentID      *AgentID             `json:"agent_id,omitempty"`
	Capabilities DesktopCapabilities  `json:"capabilities"`
	Closed       bool                 `json:"closed"`
	Control      DesktopControlStatus `json:"control"`
	CreatedAt    time.Time            `json:"created_at"`

	// ID Desktop session ID (dsn_...).
	ID DesktopSessionID `json:"id"`

	// MachineID Machine ID (mch_...).
	MachineID MachineID      `json:"machine_id"`
	OrgID     OrganizationID `json:"org_id"`

	// OwnerID Authenticated user or organization API key that created the session.
	OwnerID openapi_types.UUID `json:"owner_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`
	ReadOnly  bool      `json:"read_only"`
}

DesktopSession defines model for DesktopSession.

type DesktopSessionID 

type DesktopSessionID = string

DesktopSessionID Desktop session ID (dsn_...).

type DirectSecretAvailability 

type DirectSecretAvailability struct {
	// ProjectID Project ID (proj_...).
	ProjectID ProjectID                      `json:"project_id"`
	Source    DirectSecretAvailabilitySource `json:"source"`
}

DirectSecretAvailability defines model for DirectSecretAvailability.

type DirectSecretAvailabilitySource 

type DirectSecretAvailabilitySource string

DirectSecretAvailabilitySource defines model for DirectSecretAvailability.Source. 

const (
	DirectSecretAvailabilitySourceDirect DirectSecretAvailabilitySource = "direct"
)

Defines values for DirectSecretAvailabilitySource.

func (DirectSecretAvailabilitySource) Valid 

func (e DirectSecretAvailabilitySource) Valid() bool

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

type DirectSkillAvailability 

type DirectSkillAvailability struct {
	Source DirectSkillAvailabilitySource `json:"source"`
}

DirectSkillAvailability defines model for DirectSkillAvailability.

type DirectSkillAvailabilitySource 

type DirectSkillAvailabilitySource string

DirectSkillAvailabilitySource defines model for DirectSkillAvailability.Source. 

const (
	DirectSkillAvailabilitySourceDirect DirectSkillAvailabilitySource = "direct"
)

Defines values for DirectSkillAvailabilitySource.

func (DirectSkillAvailabilitySource) Valid 

func (e DirectSkillAvailabilitySource) Valid() bool

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

type DiscoveredModelPricing 

type DiscoveredModelPricing struct {
	CacheReadInputUsdPerMillion  *string `json:"cache_read_input_usd_per_million,omitempty"`
	CacheWriteInputUsdPerMillion *string `json:"cache_write_input_usd_per_million,omitempty"`
	InputUsdPerMillion           string  `json:"input_usd_per_million"`
	OutputUsdPerMillion          string  `json:"output_usd_per_million"`
}

DiscoveredModelPricing Provider-advertised list prices in USD per million tokens, as exact decimal strings. Present only when the provider publishes pricing in its model catalog (OpenRouter). Cache prices are omitted when the provider does not publish them.

type DiscoveredProviderModel 

type DiscoveredProviderModel struct {
	// ContextWindowTokens Provider-advertised context window limit in tokens, when available.
	ContextWindowTokens *int    `json:"context_window_tokens,omitempty"`
	DisplayName         *string `json:"display_name,omitempty"`

	// MaxOutputTokens Provider-advertised maximum output limit in tokens, when available.
	MaxOutputTokens *int `json:"max_output_tokens,omitempty"`

	// Pricing Provider-advertised list prices in USD per million tokens, as exact decimal strings. Present only when the provider publishes pricing in its model catalog (OpenRouter). Cache prices are omitted when the provider does not publish them.
	Pricing *DiscoveredModelPricing `json:"pricing,omitempty"`

	// Slug Provider model slug usable as a configured model's provider_model_slug.
	Slug string `json:"slug"`

	// SupportedReasoningEfforts Reasoning effort values the model accepts, when reported.
	SupportedReasoningEfforts *[]string `json:"supported_reasoning_efforts,omitempty"`

	// SupportsReasoning Whether BMA can send this model a reasoning effort, when the provider or the public model catalog reports it.
	SupportsReasoning *bool `json:"supports_reasoning,omitempty"`
}

DiscoveredProviderModel defines model for DiscoveredProviderModel.

type DownloadDaemonFileParams 

type DownloadDaemonFileParams struct {
	// XBMAAcceptFileEdit The executor applies edit_file replacements itself.
	XBMAAcceptFileEdit *bool `json:"X-BMA-Accept-File-Edit,omitempty"`
}

DownloadDaemonFileParams defines parameters for DownloadDaemonFile.

type DownloadMemoryFileParams 

type DownloadMemoryFileParams struct {
	// Path Literal path relative to the store root.
	Path string `form:"path" json:"path"`
}

DownloadMemoryFileParams defines parameters for DownloadMemoryFile.

type EnvironmentVariableName 

type EnvironmentVariableName = string

EnvironmentVariableName defines model for EnvironmentVariableName.

type Error 

type Error struct {
	StatusCode int
	// Code is the contract's stable error code (ErrorCode constants); the
	// facade extensions also use their own codes such as file_already_exists.
	Code    ErrorCode
	Message string
	// Type is the Anthropic-style error.type of facade extension errors.
	Type string
	// CurrentDigest is set for file_content_conflict and expected_digest_required.
	CurrentDigest string
	// Issues are field-level problems of agent config validation errors.
	Issues []AgentConfigErrorIssue
	Header http.Header
	// Body is the raw response body (at most 1 MiB).
	Body []byte
}

Error is a non-2xx response, or an error frame of an event stream (StatusCode 0). Match it with errors.As and switch on Code.

func NewError 

func NewError(status int, body []byte, header http.Header) *Error

NewError decodes an error body of the native API ({error, code}) or of the facade extensions ({type: "error", error: {type, message, code}}).

func (*Error) Error 

func (e *Error) Error() string

func (*Error) Retryable 

func (e *Error) Retryable() bool

Retryable reports whether the same request may succeed later.

type ErrorBody 

type ErrorBody struct {
	// Code Stable error code for programmatic handling.
	Code string `json:"code"`

	// CurrentDigest Current file digest for file_content_conflict or expected_digest_required; absent if the file no longer exists. A replacement must be confirmed before retrying with this digest.
	CurrentDigest *string `json:"current_digest,omitempty"`

	// Error Human-readable error message. Do not match on it programmatically.
	Error string `json:"error"`

	// Issues Field-level problems when a submitted document (such as an agent config source) failed validation. Absent for errors that are not about a specific field.
	Issues *[]AgentConfigErrorIssue `json:"issues,omitempty"`
}

ErrorBody defines model for Error.

type ErrorCode 

type ErrorCode string

ErrorCode Known error codes. 

const (
	ErrorCodeAgentBacklogFull           ErrorCode = "agent_backlog_full"
	ErrorCodeAuthenticationUnavailable  ErrorCode = "authentication_unavailable"
	ErrorCodeConflict                   ErrorCode = "conflict"
	ErrorCodeCsrfCheckFailed            ErrorCode = "csrf_check_failed"
	ErrorCodeDaemonRuntimeUnregistered  ErrorCode = "daemon_runtime_unregistered"
	ErrorCodeExpectedDigestRequired     ErrorCode = "expected_digest_required"
	ErrorCodeFileContentConflict        ErrorCode = "file_content_conflict"
	ErrorCodeFileReadOnly               ErrorCode = "file_read_only"
	ErrorCodeForbidden                  ErrorCode = "forbidden"
	ErrorCodeGone                       ErrorCode = "gone"
	ErrorCodeIdempotencyKeyConflict     ErrorCode = "idempotency_key_conflict"
	ErrorCodeInternalError              ErrorCode = "internal_error"
	ErrorCodeInvalidRequest             ErrorCode = "invalid_request"
	ErrorCodeManagedWorkAdmissionDenied ErrorCode = "managed_work_admission_denied"
	ErrorCodeNotAFile                   ErrorCode = "not_a_file"
	ErrorCodeNotFound                   ErrorCode = "not_found"
	ErrorCodeNotWakeCapable             ErrorCode = "not_wake_capable"
	ErrorCodePendingWork                ErrorCode = "pending_work"
	ErrorCodeRateLimited                ErrorCode = "rate_limited"
	ErrorCodeRequestTooLarge            ErrorCode = "request_too_large"
	ErrorCodeServiceUnavailable         ErrorCode = "service_unavailable"
	ErrorCodeStateTransitionConflict    ErrorCode = "state_transition_conflict"
	ErrorCodeUnauthorized               ErrorCode = "unauthorized"
	ErrorCodeUnprocessable              ErrorCode = "unprocessable"
	ErrorCodeUnsupportedMediaType       ErrorCode = "unsupported_media_type"
	ErrorCodeUpstreamUnavailable        ErrorCode = "upstream_unavailable"
	ErrorCodeValidationFailed           ErrorCode = "validation_failed"
)

Defines values for ErrorCode.

func (ErrorCode) Valid 

func (e ErrorCode) Valid() bool

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

type ErrorContentBlock 

type ErrorContentBlock struct {
	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata *ContentBlockMetadata `json:"metadata,omitempty"`
	Text     string                `json:"text"`
	Type     ErrorContentBlockType `json:"type"`
}

ErrorContentBlock defines model for ErrorContentBlock.

type ErrorContentBlockType 

type ErrorContentBlockType string

ErrorContentBlockType defines model for ErrorContentBlock.Type. 

const (
	ErrorContentBlockTypeError ErrorContentBlockType = "error"
)

Defines values for ErrorContentBlockType.

func (ErrorContentBlockType) Valid 

func (e ErrorContentBlockType) Valid() bool

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

type EventWebhook 

type EventWebhook struct {
	CreatedAt  time.Time               `json:"created_at"`
	EventTypes []EventWebhookEventType `json:"event_types"`
	ID         EventWebhookID          `json:"id"`
	OrgID      OrganizationID          `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID         `json:"project_id"`
	Scope     EventWebhookScope `json:"scope"`

	// SigningSecretID Secret ID (sec_...).
	SigningSecretID *SecretID `json:"signing_secret_id,omitempty"`
	UpdatedAt       time.Time `json:"updated_at"`

	// URL Public HTTPS endpoint, at most 2048 bytes after URL encoding.
	URL string `json:"url"`
}

EventWebhook defines model for EventWebhook.

type EventWebhookAgentInputEvent 

type EventWebhookAgentInputEvent struct {
	Data  AgentInputEvent                  `json:"data"`
	Event EventWebhookAgentInputEventEvent `json:"event"`
}

EventWebhookAgentInputEvent defines model for EventWebhookAgentInputEvent.

type EventWebhookAgentInputEventEvent 

type EventWebhookAgentInputEventEvent string

EventWebhookAgentInputEventEvent defines model for EventWebhookAgentInputEvent.Event. 

const (
	EventWebhookEventAgentInput EventWebhookAgentInputEventEvent = "agent_input"
)

Defines values for EventWebhookAgentInputEventEvent.

func (EventWebhookAgentInputEventEvent) Valid 

func (e EventWebhookAgentInputEventEvent) Valid() bool

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

type EventWebhookContextCheckpointEvent 

type EventWebhookContextCheckpointEvent struct {
	Data  ContextCheckpointEvent                  `json:"data"`
	Event EventWebhookContextCheckpointEventEvent `json:"event"`
}

EventWebhookContextCheckpointEvent defines model for EventWebhookContextCheckpointEvent.

type EventWebhookContextCheckpointEventEvent 

type EventWebhookContextCheckpointEventEvent string

EventWebhookContextCheckpointEventEvent defines model for EventWebhookContextCheckpointEvent.Event. 

const (
	EventWebhookEventContextCheckpoint EventWebhookContextCheckpointEventEvent = "context_checkpoint"
)

Defines values for EventWebhookContextCheckpointEventEvent.

func (EventWebhookContextCheckpointEventEvent) Valid 

func (e EventWebhookContextCheckpointEventEvent) Valid() bool

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

type EventWebhookEventType 

type EventWebhookEventType string

EventWebhookEventType defines model for EventWebhookEventType. 

const (
	EventWebhookEventTypeAgentInput        EventWebhookEventType = "agent_input"
	EventWebhookEventTypeContextCheckpoint EventWebhookEventType = "context_checkpoint"
	EventWebhookEventTypeModelOutput       EventWebhookEventType = "model_output"
	EventWebhookEventTypeToolCallUpdate    EventWebhookEventType = "tool_call_update"
	EventWebhookEventTypeToolResult        EventWebhookEventType = "tool_result"
)

Defines values for EventWebhookEventType.

func (EventWebhookEventType) Valid 

func (e EventWebhookEventType) Valid() bool

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

type EventWebhookID 

type EventWebhookID = string

EventWebhookID defines model for EventWebhookID.

type EventWebhookListParams 

type EventWebhookListParams struct {
	ScopeType      EventWebhookScopeType
	AgentProfileID *AgentProfileID
	AgentID        *AgentID
}

EventWebhookListParams are the query, header and body fields of listEventWebhooks.

type EventWebhookModelOutputEvent 

type EventWebhookModelOutputEvent struct {
	Data  ModelOutputEvent                  `json:"data"`
	Event EventWebhookModelOutputEventEvent `json:"event"`
}

EventWebhookModelOutputEvent defines model for EventWebhookModelOutputEvent.

type EventWebhookModelOutputEventEvent 

type EventWebhookModelOutputEventEvent string

EventWebhookModelOutputEventEvent defines model for EventWebhookModelOutputEvent.Event. 

const (
	EventWebhookEventModelOutput EventWebhookModelOutputEventEvent = "model_output"
)

Defines values for EventWebhookModelOutputEventEvent.

func (EventWebhookModelOutputEventEvent) Valid 

func (e EventWebhookModelOutputEventEvent) Valid() bool

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

type EventWebhookNewParams 

type EventWebhookNewParams struct {
	EventTypes      []EventWebhookEventType
	Scope           EventWebhookScope
	SigningSecretID *SecretID
	URL             string
}

EventWebhookNewParams are the query, header and body fields of createEventWebhook.

type EventWebhookPayload 

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

EventWebhookPayload JSON body posted to an event webhook. Each event name determines its data schema.

func (EventWebhookPayload) AsAny 

func (t EventWebhookPayload) AsAny() any

AsAny returns the member of EventWebhookPayload named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (EventWebhookPayload) AsEventWebhookAgentInputEvent 

func (t EventWebhookPayload) AsEventWebhookAgentInputEvent() (EventWebhookAgentInputEvent, error)

AsEventWebhookAgentInputEvent returns the union data inside the EventWebhookPayload as a EventWebhookAgentInputEvent

func (EventWebhookPayload) AsEventWebhookContextCheckpointEvent 

func (t EventWebhookPayload) AsEventWebhookContextCheckpointEvent() (EventWebhookContextCheckpointEvent, error)

AsEventWebhookContextCheckpointEvent returns the union data inside the EventWebhookPayload as a EventWebhookContextCheckpointEvent

func (EventWebhookPayload) AsEventWebhookModelOutputEvent 

func (t EventWebhookPayload) AsEventWebhookModelOutputEvent() (EventWebhookModelOutputEvent, error)

AsEventWebhookModelOutputEvent returns the union data inside the EventWebhookPayload as a EventWebhookModelOutputEvent

func (EventWebhookPayload) AsEventWebhookToolCallUpdate 

func (t EventWebhookPayload) AsEventWebhookToolCallUpdate() (EventWebhookToolCallUpdate, error)

AsEventWebhookToolCallUpdate returns the union data inside the EventWebhookPayload as a EventWebhookToolCallUpdate

func (EventWebhookPayload) AsEventWebhookToolResultEvent 

func (t EventWebhookPayload) AsEventWebhookToolResultEvent() (EventWebhookToolResultEvent, error)

AsEventWebhookToolResultEvent returns the union data inside the EventWebhookPayload as a EventWebhookToolResultEvent

func (EventWebhookPayload) Discriminator 

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

func (*EventWebhookPayload) FromEventWebhookAgentInputEvent 

func (t *EventWebhookPayload) FromEventWebhookAgentInputEvent(v EventWebhookAgentInputEvent) error

FromEventWebhookAgentInputEvent overwrites any union data inside the EventWebhookPayload as the provided EventWebhookAgentInputEvent

func (*EventWebhookPayload) FromEventWebhookContextCheckpointEvent 

func (t *EventWebhookPayload) FromEventWebhookContextCheckpointEvent(v EventWebhookContextCheckpointEvent) error

FromEventWebhookContextCheckpointEvent overwrites any union data inside the EventWebhookPayload as the provided EventWebhookContextCheckpointEvent

func (*EventWebhookPayload) FromEventWebhookModelOutputEvent 

func (t *EventWebhookPayload) FromEventWebhookModelOutputEvent(v EventWebhookModelOutputEvent) error

FromEventWebhookModelOutputEvent overwrites any union data inside the EventWebhookPayload as the provided EventWebhookModelOutputEvent

func (*EventWebhookPayload) FromEventWebhookToolCallUpdate 

func (t *EventWebhookPayload) FromEventWebhookToolCallUpdate(v EventWebhookToolCallUpdate) error

FromEventWebhookToolCallUpdate overwrites any union data inside the EventWebhookPayload as the provided EventWebhookToolCallUpdate

func (*EventWebhookPayload) FromEventWebhookToolResultEvent 

func (t *EventWebhookPayload) FromEventWebhookToolResultEvent(v EventWebhookToolResultEvent) error

FromEventWebhookToolResultEvent overwrites any union data inside the EventWebhookPayload as the provided EventWebhookToolResultEvent

func (EventWebhookPayload) MarshalJSON 

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

func (*EventWebhookPayload) MergeEventWebhookAgentInputEvent 

func (t *EventWebhookPayload) MergeEventWebhookAgentInputEvent(v EventWebhookAgentInputEvent) error

MergeEventWebhookAgentInputEvent performs a merge with any union data inside the EventWebhookPayload, using the provided EventWebhookAgentInputEvent

func (*EventWebhookPayload) MergeEventWebhookContextCheckpointEvent 

func (t *EventWebhookPayload) MergeEventWebhookContextCheckpointEvent(v EventWebhookContextCheckpointEvent) error

MergeEventWebhookContextCheckpointEvent performs a merge with any union data inside the EventWebhookPayload, using the provided EventWebhookContextCheckpointEvent

func (*EventWebhookPayload) MergeEventWebhookModelOutputEvent 

func (t *EventWebhookPayload) MergeEventWebhookModelOutputEvent(v EventWebhookModelOutputEvent) error

MergeEventWebhookModelOutputEvent performs a merge with any union data inside the EventWebhookPayload, using the provided EventWebhookModelOutputEvent

func (*EventWebhookPayload) MergeEventWebhookToolCallUpdate 

func (t *EventWebhookPayload) MergeEventWebhookToolCallUpdate(v EventWebhookToolCallUpdate) error

MergeEventWebhookToolCallUpdate performs a merge with any union data inside the EventWebhookPayload, using the provided EventWebhookToolCallUpdate

func (*EventWebhookPayload) MergeEventWebhookToolResultEvent 

func (t *EventWebhookPayload) MergeEventWebhookToolResultEvent(v EventWebhookToolResultEvent) error

MergeEventWebhookToolResultEvent performs a merge with any union data inside the EventWebhookPayload, using the provided EventWebhookToolResultEvent

func (*EventWebhookPayload) UnmarshalJSON 

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

func (EventWebhookPayload) ValueByDiscriminator 

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

type EventWebhookScope 

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

EventWebhookScope defines model for EventWebhookScope.

func (EventWebhookScope) AsAgentEventWebhookScope 

func (t EventWebhookScope) AsAgentEventWebhookScope() (AgentEventWebhookScope, error)

AsAgentEventWebhookScope returns the union data inside the EventWebhookScope as a AgentEventWebhookScope

func (EventWebhookScope) AsAgentProfileEventWebhookScope 

func (t EventWebhookScope) AsAgentProfileEventWebhookScope() (AgentProfileEventWebhookScope, error)

AsAgentProfileEventWebhookScope returns the union data inside the EventWebhookScope as a AgentProfileEventWebhookScope

func (EventWebhookScope) AsAny 

func (t EventWebhookScope) AsAny() any

AsAny returns the member of EventWebhookScope named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (EventWebhookScope) AsProjectEventWebhookScope 

func (t EventWebhookScope) AsProjectEventWebhookScope() (ProjectEventWebhookScope, error)

AsProjectEventWebhookScope returns the union data inside the EventWebhookScope as a ProjectEventWebhookScope

func (EventWebhookScope) Discriminator 

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

func (*EventWebhookScope) FromAgentEventWebhookScope 

func (t *EventWebhookScope) FromAgentEventWebhookScope(v AgentEventWebhookScope) error

FromAgentEventWebhookScope overwrites any union data inside the EventWebhookScope as the provided AgentEventWebhookScope

func (*EventWebhookScope) FromAgentProfileEventWebhookScope 

func (t *EventWebhookScope) FromAgentProfileEventWebhookScope(v AgentProfileEventWebhookScope) error

FromAgentProfileEventWebhookScope overwrites any union data inside the EventWebhookScope as the provided AgentProfileEventWebhookScope

func (*EventWebhookScope) FromProjectEventWebhookScope 

func (t *EventWebhookScope) FromProjectEventWebhookScope(v ProjectEventWebhookScope) error

FromProjectEventWebhookScope overwrites any union data inside the EventWebhookScope as the provided ProjectEventWebhookScope

func (EventWebhookScope) MarshalJSON 

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

func (*EventWebhookScope) MergeAgentEventWebhookScope 

func (t *EventWebhookScope) MergeAgentEventWebhookScope(v AgentEventWebhookScope) error

MergeAgentEventWebhookScope performs a merge with any union data inside the EventWebhookScope, using the provided AgentEventWebhookScope

func (*EventWebhookScope) MergeAgentProfileEventWebhookScope 

func (t *EventWebhookScope) MergeAgentProfileEventWebhookScope(v AgentProfileEventWebhookScope) error

MergeAgentProfileEventWebhookScope performs a merge with any union data inside the EventWebhookScope, using the provided AgentProfileEventWebhookScope

func (*EventWebhookScope) MergeProjectEventWebhookScope 

func (t *EventWebhookScope) MergeProjectEventWebhookScope(v ProjectEventWebhookScope) error

MergeProjectEventWebhookScope performs a merge with any union data inside the EventWebhookScope, using the provided ProjectEventWebhookScope

func (*EventWebhookScope) UnmarshalJSON 

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

func (EventWebhookScope) ValueByDiscriminator 

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

type EventWebhookScopeType 

type EventWebhookScopeType string

EventWebhookScopeType defines model for EventWebhookScopeType. 

const (
	EventWebhookScopeAgent        EventWebhookScopeType = "agent"
	EventWebhookScopeAgentProfile EventWebhookScopeType = "profile"
	EventWebhookScopeProject      EventWebhookScopeType = "project"
)

Defines values for EventWebhookScopeType.

func (EventWebhookScopeType) Valid 

func (e EventWebhookScopeType) Valid() bool

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

type EventWebhookService 

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

EventWebhookService groups the eventWebhooks methods.

func (*EventWebhookService) Delete 

func (s *EventWebhookService) Delete(ctx context.Context, webhookID string, opts ...option.RequestOption) error

Delete calls deleteEventWebhook: DELETE /orgs/{orgID}/projects/{projectID}/event-webhooks/{webhookID}.

func (*EventWebhookService) List 

func (s *EventWebhookService) List(ctx context.Context, params EventWebhookListParams, opts ...option.RequestOption) (*ListEventWebhooksResponse, error)

List calls listEventWebhooks: GET /orgs/{orgID}/projects/{projectID}/event-webhooks.

func (*EventWebhookService) New 

func (s *EventWebhookService) New(ctx context.Context, params EventWebhookNewParams, opts ...option.RequestOption) (*EventWebhook, error)

New calls createEventWebhook: POST /orgs/{orgID}/projects/{projectID}/event-webhooks.

func (*EventWebhookService) Update 

func (s *EventWebhookService) Update(ctx context.Context, webhookID string, params EventWebhookUpdateParams, opts ...option.RequestOption) (*EventWebhook, error)

Update calls updateEventWebhook: PATCH /orgs/{orgID}/projects/{projectID}/event-webhooks/{webhookID}.

type EventWebhookToolCallUpdate 

type EventWebhookToolCallUpdate struct {
	// Data A notification that a tool call entered a lifecycle state. On the event stream, this is ephemeral and sent for the streamed agent and every subagent beneath it, so questions, permission requests, and custom tool calls anywhere in the tree surface here; query the list endpoints with `include_subagents` for the current rows.
	Data  ToolCallUpdate                  `json:"data"`
	Event EventWebhookToolCallUpdateEvent `json:"event"`
}

EventWebhookToolCallUpdate defines model for EventWebhookToolCallUpdate.

type EventWebhookToolCallUpdateEvent 

type EventWebhookToolCallUpdateEvent string

EventWebhookToolCallUpdateEvent defines model for EventWebhookToolCallUpdate.Event. 

const (
	EventWebhookEventToolCallUpdate EventWebhookToolCallUpdateEvent = "tool_call_update"
)

Defines values for EventWebhookToolCallUpdateEvent.

func (EventWebhookToolCallUpdateEvent) Valid 

func (e EventWebhookToolCallUpdateEvent) Valid() bool

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

type EventWebhookToolResultEvent 

type EventWebhookToolResultEvent struct {
	Data  ToolResultEvent                  `json:"data"`
	Event EventWebhookToolResultEventEvent `json:"event"`
}

EventWebhookToolResultEvent defines model for EventWebhookToolResultEvent.

type EventWebhookToolResultEventEvent 

type EventWebhookToolResultEventEvent string

EventWebhookToolResultEventEvent defines model for EventWebhookToolResultEvent.Event. 

const (
	EventWebhookEventToolResult EventWebhookToolResultEventEvent = "tool_result"
)

Defines values for EventWebhookToolResultEventEvent.

func (EventWebhookToolResultEventEvent) Valid 

func (e EventWebhookToolResultEventEvent) Valid() bool

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

type EventWebhookUpdateParams 

type EventWebhookUpdateParams struct {
	EventTypes      *[]EventWebhookEventType
	SigningSecretID *SecretID
	URL             *string
}

EventWebhookUpdateParams are the query, header and body fields of updateEventWebhook.

type ExecutorEvent 

type ExecutorEvent struct {
	AgentID   AgentID   `json:"agent_id"`
	CreatedAt Timestamp `json:"created_at"`

	// Event The event as reported, with its Anthropic type (agent.message, agent.tool_use, session.status_idle, ...).
	Event     map[string]interface{} `json:"event"`
	EventKind ExecutorEventEventKind `json:"event_kind"`

	// ExecutorEventID Executor-assigned event id; agent.tool_result.tool_use_id refers to the agent.tool_use event by this id.
	ExecutorEventID string                      `json:"executor_event_id"`
	ID              AgentEventID                `json:"id"`
	IsOpeningEvent  ExecutorEventIsOpeningEvent `json:"is_opening_event"`
	OrgID           OrganizationID              `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// Sequence Positive per-agent event, turn, or live-frame sequence.
	Sequence AgentSequence `json:"sequence"`
	TurnID   AgentTurnID   `json:"turn_id"`

	// TurnSequence Positive per-agent event, turn, or live-frame sequence.
	TurnSequence AgentSequence `json:"turn_sequence"`
}

ExecutorEvent An Anthropic-shaped session event reported by an agent executor (Executor Protocol capability agent), or a user.tool_confirmation the platform wrote when an executor interaction was answered.

type ExecutorEventEventKind 

type ExecutorEventEventKind string

ExecutorEventEventKind defines model for ExecutorEvent.EventKind. 

const (
	ExecutorEventEventKindExecutorEvent ExecutorEventEventKind = "executor_event"
)

Defines values for ExecutorEventEventKind.

func (ExecutorEventEventKind) Valid 

func (e ExecutorEventEventKind) Valid() bool

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

type ExecutorEventIsOpeningEvent 

type ExecutorEventIsOpeningEvent bool

ExecutorEventIsOpeningEvent defines model for ExecutorEvent.IsOpeningEvent. 

const (
	ExecutorEventIsOpeningEventFalse ExecutorEventIsOpeningEvent = false
)

Defines values for ExecutorEventIsOpeningEvent.

func (ExecutorEventIsOpeningEvent) Valid 

func (e ExecutorEventIsOpeningEvent) Valid() bool

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

type ExecutorInteractionUpdate 

type ExecutorInteractionUpdate struct {
	InteractionUpdate struct {
		InteractionID   AgentInteractionID    `json:"interaction_id"`
		InteractionKind AgentInteractionKind  `json:"interaction_kind"`
		State           AgentInteractionState `json:"state"`
	} `json:"interaction_update"`
	SessionID  string                        `json:"session_id"`
	State      AgentInteractionState         `json:"state"`
	ToolCallID string                        `json:"tool_call_id"`
	Type       ExecutorInteractionUpdateType `json:"type"`
}

ExecutorInteractionUpdate Best-effort stream frame of an agent executor session: an executor interaction (permission or question) opened or closed. tool_call_id is the agent.tool_use event ID for permissions and the interaction ID otherwise.

type ExecutorInteractionUpdateType 

type ExecutorInteractionUpdateType string

ExecutorInteractionUpdateType defines model for ExecutorInteractionUpdate.Type. 

const (
	ExecutorInteractionUpdateTypeExecutorInteractionUpdate ExecutorInteractionUpdateType = "executor_interaction_update"
)

Defines values for ExecutorInteractionUpdateType.

func (ExecutorInteractionUpdateType) Valid 

func (e ExecutorInteractionUpdateType) Valid() bool

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

type ExternalActorParams 

type ExternalActorParams struct {
	DisplayName *string `json:"display_name,omitempty"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata         *Metadata `json:"metadata,omitempty"`
	ProviderTenantID *string   `json:"provider_tenant_id,omitempty"`
	ProviderUserID   string    `json:"provider_user_id"`
}

ExternalActorParams Identity and attributes of an external actor. Actors are upserted by (provider_tenant_id, provider_user_id) with the external provider. Omitted attributes keep their stored values; provided attributes are overwritten, including empty values. bma actors are implicit and hosted integrations own their own actor identities.

type FailedDependency 

type FailedDependency = ErrorBody

FailedDependency defines model for FailedDependency.

type File 

type File struct {
	CreatedAt Timestamp `json:"created_at"`

	// Digest SHA-256 digest of the content, sha256:<hex>.
	Digest   string `json:"digest"`
	Filename string `json:"filename"`

	// ID File ID (file_...).
	ID FileID `json:"id"`

	// Metadata Caller-defined string labels.
	Metadata map[string]string `json:"metadata"`
	MimeType string            `json:"mime_type"`
	OrgID    OrganizationID    `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// Scope The session this file is scoped to; null for a project-wide file.
	Scope     *FileScope `json:"scope"`
	SizeBytes int64      `json:"size_bytes"`

	// SourceArtifactID The artifact this file was promoted from.
	SourceArtifactID *string  `json:"source_artifact_id,omitempty"`
	Type             FileType `json:"type"`
}

File A project file. Field names follow the Anthropic Files API (filename, mime_type, size_bytes, scope); digest and metadata are BMA extensions.

type FileID 

type FileID = string

FileID File ID (file_...).

type FileList 

type FileList struct {
	Data []File `json:"data"`

	// NextPage Cursor for the next page; null when there are no more files.
	NextPage *string `json:"next_page"`
}

FileList defines model for FileList.

type FileListParams 

type FileListParams struct {
	Limit             *int32
	Page              *string
	ScopeID           *string
	IncludeSuperseded *bool
	Metadata          *[]string
}

FileListParams are the query, header and body fields of listFiles.

type FileResourceParams 

type FileResourceParams struct {
	// FileID File ID (file_...).
	FileID FileID `json:"file_id"`

	// MountPath Absolute path below /mnt/session/uploads; a path outside it is placed under it (/data.csv mounts at /mnt/session/uploads/data.csv). Defaults to /mnt/session/uploads/<file_id>.
	MountPath *string                `json:"mount_path,omitempty"`
	Type      FileResourceParamsType `json:"type"`
}

FileResourceParams defines model for FileResourceParams.

type FileResourceParamsType 

type FileResourceParamsType string

FileResourceParamsType defines model for FileResourceParams.Type. 

const (
	FileResourceParamsTypeFile FileResourceParamsType = "file"
)

Defines values for FileResourceParamsType.

func (FileResourceParamsType) Valid 

func (e FileResourceParamsType) Valid() bool

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

type FileScope 

type FileScope struct {
	ID   string        `json:"id"`
	Type FileScopeType `json:"type"`
}

FileScope The session a session-scoped file belongs to.

type FileScopeType 

type FileScopeType string

FileScopeType defines model for FileScope.Type. 

const (
	FileScopeTypeSession FileScopeType = "session"
)

Defines values for FileScopeType.

func (FileScopeType) Valid 

func (e FileScopeType) Valid() bool

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

type FileService 

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

FileService groups the files methods.

func (*FileService) Delete 

func (s *FileService) Delete(ctx context.Context, fileID string, opts ...option.RequestOption) (*DeletedFile, error)

Delete calls deleteFile: DELETE /orgs/{orgID}/projects/{projectID}/files/{fileID}.

func (*FileService) Download 

func (s *FileService) Download(ctx context.Context, fileID string, opts ...option.RequestOption) (*http.Response, error)

Download calls getFileContent: GET /orgs/{orgID}/projects/{projectID}/files/{fileID}/content. The caller closes the response body.

func (*FileService) Get 

func (s *FileService) Get(ctx context.Context, fileID string, opts ...option.RequestOption) (*File, error)

Get calls getFile: GET /orgs/{orgID}/projects/{projectID}/files/{fileID}.

func (*FileService) List 

func (s *FileService) List(ctx context.Context, params FileListParams, opts ...option.RequestOption) (*CursorPage[File], error)

List calls listFiles: GET /orgs/{orgID}/projects/{projectID}/files.

func (*FileService) ListAutoPaging 

func (s *FileService) ListAutoPaging(ctx context.Context, params FileListParams, opts ...option.RequestOption) *CursorPageAutoPager[File]

ListAutoPaging iterates every item of listFiles across pages.

func (*FileService) Upload 

func (s *FileService) Upload(ctx context.Context, params FileUploadParams, opts ...option.RequestOption) (*File, error)

Upload calls uploadFile: POST /orgs/{orgID}/projects/{projectID}/files.

type FileType 

type FileType string

FileType defines model for File.Type. 

const (
	FileTypeFile FileType = "file"
)

Defines values for FileType.

func (FileType) Valid 

func (e FileType) Valid() bool

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

type FileUploadParams 

type FileUploadParams struct {
	Filename         string
	XBMAFileMetadata *string
	Body             io.Reader
}

FileUploadParams are the query, header and body fields of uploadFile.

type Forbidden 

type Forbidden = ErrorBody

Forbidden defines model for Forbidden.

type GenericSecretMaterial 

type GenericSecretMaterial struct {
	Kind  GenericSecretMaterialKind `json:"kind"`
	Value string                    `json:"value"`
}

GenericSecretMaterial defines model for GenericSecretMaterial.

type GenericSecretMaterialKind 

type GenericSecretMaterialKind string

GenericSecretMaterialKind defines model for GenericSecretMaterial.Kind. 

const (
	Generic GenericSecretMaterialKind = "generic"
)

Defines values for GenericSecretMaterialKind.

func (GenericSecretMaterialKind) Valid 

func (e GenericSecretMaterialKind) Valid() bool

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

type GetAgentConfigGeneratedSourceParams 

type GetAgentConfigGeneratedSourceParams struct {
	// SourceFormat Format of the returned source.
	SourceFormat *GetAgentConfigGeneratedSourceParamsSourceFormat `form:"source_format,omitempty" json:"source_format,omitempty"`
}

GetAgentConfigGeneratedSourceParams defines parameters for GetAgentConfigGeneratedSource.

type GetAgentConfigGeneratedSourceParamsSourceFormat 

type GetAgentConfigGeneratedSourceParamsSourceFormat string

GetAgentConfigGeneratedSourceParamsSourceFormat defines parameters for GetAgentConfigGeneratedSource. 

const (
	GetAgentConfigGeneratedSourceParamsSourceFormatJSON GetAgentConfigGeneratedSourceParamsSourceFormat = "json"
	GetAgentConfigGeneratedSourceParamsSourceFormatYaml GetAgentConfigGeneratedSourceParamsSourceFormat = "yaml"
)

Defines values for GetAgentConfigGeneratedSourceParamsSourceFormat.

func (GetAgentConfigGeneratedSourceParamsSourceFormat) Valid 

func (e GetAgentConfigGeneratedSourceParamsSourceFormat) Valid() bool

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

type GetAgentProfileUsageParams 

type GetAgentProfileUsageParams struct {
	// Since Only tally model calls started at or after this instant. Omit to start from the earliest recorded call.
	Since *UsageSince `form:"since,omitempty" json:"since,omitempty"`

	// Until Only tally model calls started before this instant. Must be later than `since` when both are given. Omit to include calls up to now.
	Until *UsageUntil `form:"until,omitempty" json:"until,omitempty"`

	// IncludeSubagents Also include usage from subagents spawned, at every depth, by agents launched from this profile. Defaults to false.
	IncludeSubagents *bool `form:"include_subagents,omitempty" json:"include_subagents,omitempty"`
}

GetAgentProfileUsageParams defines parameters for GetAgentProfileUsage.

type GetAgentResponse 

type GetAgentResponse struct {
	Agent Agent `json:"agent"`

	// MachineIDs Machines currently attached to the agent, in binding creation order.
	MachineIDs []MachineID `json:"machine_ids"`

	// McpConnections The agent's MCP server connections, ordered by server key.
	McpConnections []AgentMCPConnection `json:"mcp_connections"`
}

GetAgentResponse defines model for GetAgentResponse.

type GetAgentUsageParams 

type GetAgentUsageParams struct {
	// Since Only tally model calls started at or after this instant. Omit to start from the earliest recorded call.
	Since *UsageSince `form:"since,omitempty" json:"since,omitempty"`

	// Until Only tally model calls started before this instant. Must be later than `since` when both are given. Omit to include calls up to now.
	Until *UsageUntil `form:"until,omitempty" json:"until,omitempty"`

	// IncludeSubagents Also include usage from this agent's subagents at every depth. Defaults to false.
	IncludeSubagents *bool `form:"include_subagents,omitempty" json:"include_subagents,omitempty"`
}

GetAgentUsageParams defines parameters for GetAgentUsage.

type GetDaemonSkillArchiveParams 

type GetDaemonSkillArchiveParams struct {
	RevisionID    string `form:"revision_id" json:"revision_id"`
	ExpiresAt     int64  `form:"expires_at" json:"expires_at"`
	DownloadToken string `form:"download_token" json:"download_token"`
}

GetDaemonSkillArchiveParams defines parameters for GetDaemonSkillArchive.

type GetOrgUsageParams 

type GetOrgUsageParams struct {
	// Since Only tally model calls started at or after this instant. Omit to start from the earliest recorded call.
	Since *UsageSince `form:"since,omitempty" json:"since,omitempty"`

	// Until Only tally model calls started before this instant. Must be later than `since` when both are given. Omit to include calls up to now.
	Until *UsageUntil `form:"until,omitempty" json:"until,omitempty"`

	// IncludeProjectIDs Only tally model calls from these projects. Cannot be combined with `exclude_project_ids`.
	IncludeProjectIDs *UsageIncludeProjectIDs `form:"include_project_ids,omitempty" json:"include_project_ids,omitempty"`

	// ExcludeProjectIDs Tally model calls from every readable project except these. Cannot be combined with `include_project_ids`.
	ExcludeProjectIDs *UsageExcludeProjectIDs `form:"exclude_project_ids,omitempty" json:"exclude_project_ids,omitempty"`
}

GetOrgUsageParams defines parameters for GetOrgUsage.

type GetOrgUsageTimeseriesParams 

type GetOrgUsageTimeseriesParams struct {
	// Since Only tally model calls started at or after this instant. Omit to start from the earliest recorded call.
	Since *UsageSince `form:"since,omitempty" json:"since,omitempty"`

	// Until Only tally model calls started before this instant. Must be later than `since` when both are given. Omit to include calls up to now.
	Until *UsageUntil `form:"until,omitempty" json:"until,omitempty"`

	// Timezone IANA time zone that decides where each bucket starts.
	Timezone *string `form:"timezone,omitempty" json:"timezone,omitempty"`

	// Interval Bucket width. Omit to pick one from the window length: days up to 92 days, weeks up to 730 days, months beyond. Hourly buckets are used only when requested. The window may span at most 400 buckets.
	Interval *UsageTimeseriesInterval `form:"interval,omitempty" json:"interval,omitempty"`

	// Metric Value plotted in each bucket. Defaults to `sum_tokens`.
	Metric *UsageTimeseriesMetric `form:"metric,omitempty" json:"metric,omitempty"`

	// GroupBy Break the metric down into one series per group. Omit for a single series.
	GroupBy *UsageTimeseriesGroupBy `form:"group_by,omitempty" json:"group_by,omitempty"`

	// GroupLimit With `group_by`, how many groups get their own series, ranked by the metric. The rest are folded into one `other` series.
	GroupLimit *int `form:"group_limit,omitempty" json:"group_limit,omitempty"`

	// ProjectIDs Only count usage from these projects.
	ProjectIDs *[]ProjectID `form:"project_ids,omitempty" json:"project_ids,omitempty"`

	// AgentProfileIDs Only count usage from top-level agents launched from these agent profiles.
	AgentProfileIDs *[]AgentProfileID `form:"agent_profile_ids,omitempty" json:"agent_profile_ids,omitempty"`

	// IncludeSubagents With `agent_profile_ids`, also count usage from subagents spawned by those agents.
	IncludeSubagents *bool `form:"include_subagents,omitempty" json:"include_subagents,omitempty"`
}

GetOrgUsageTimeseriesParams defines parameters for GetOrgUsageTimeseries.

type GetProjectUsageParams 

type GetProjectUsageParams struct {
	// Since Only tally model calls started at or after this instant. Omit to start from the earliest recorded call.
	Since *UsageSince `form:"since,omitempty" json:"since,omitempty"`

	// Until Only tally model calls started before this instant. Must be later than `since` when both are given. Omit to include calls up to now.
	Until *UsageUntil `form:"until,omitempty" json:"until,omitempty"`
}

GetProjectUsageParams defines parameters for GetProjectUsage.

type GitHubAppCredentialsSecretMaterial 

type GitHubAppCredentialsSecretMaterial struct {
	AppID string                                 `json:"app_id"`
	Kind  GitHubAppCredentialsSecretMaterialKind `json:"kind"`

	// PrivateKey Unencrypted RSA private key in PEM format. Stored encrypted.
	PrivateKey    string `json:"private_key"`
	WebhookSecret string `json:"webhook_secret"`
}

GitHubAppCredentialsSecretMaterial defines model for GitHubAppCredentialsSecretMaterial.

type GitHubAppCredentialsSecretMaterialKind 

type GitHubAppCredentialsSecretMaterialKind string

GitHubAppCredentialsSecretMaterialKind defines model for GitHubAppCredentialsSecretMaterial.Kind. 

const (
	GithubAppCredentials GitHubAppCredentialsSecretMaterialKind = "github_app_credentials"
)

Defines values for GitHubAppCredentialsSecretMaterialKind.

func (GitHubAppCredentialsSecretMaterialKind) Valid 

func (e GitHubAppCredentialsSecretMaterialKind) Valid() bool

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

type GitHubInstallations 

type GitHubInstallations struct {
	// InstallURL Verified GitHub App installation URL. Its state may carry the public credential secret ID as a recovery hint, never credentials or authorization.
	InstallURL    string                    `json:"install_url"`
	Installations []GitHubSetupInstallation `json:"installations"`
	Name          string                    `json:"name"`
	NextPage      *int                      `json:"next_page,omitempty"`
	ProviderAppID string                    `json:"provider_app_id"`
	Slug          string                    `json:"slug"`
}

GitHubInstallations defines model for GitHubInstallations.

type GitHubIntegrationLauncher 

type GitHubIntegrationLauncher struct {
	Profile AgentProfileID `json:"profile"`

	// RepositoryID Optional: restrict launches to this repository.
	RepositoryID *string                          `json:"repository_id,omitempty"`
	Trigger      GitHubIntegrationLauncherTrigger `json:"trigger"`
}

GitHubIntegrationLauncher defines model for GitHubIntegrationLauncher.

type GitHubIntegrationLauncherTrigger 

type GitHubIntegrationLauncherTrigger string

GitHubIntegrationLauncherTrigger defines model for GitHubIntegrationLauncher.Trigger. 

const (
	Both              GitHubIntegrationLauncherTrigger = "both"
	Mention           GitHubIntegrationLauncherTrigger = "mention"
	PullRequestOpened GitHubIntegrationLauncherTrigger = "pull_request_opened"
)

Defines values for GitHubIntegrationLauncherTrigger.

func (GitHubIntegrationLauncherTrigger) Valid 

func (e GitHubIntegrationLauncherTrigger) Valid() bool

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

type GitHubIntegrationSettings 

type GitHubIntegrationSettings struct {
	// CodeWrite Git credentials can push. Off by default: read-only.
	CodeWrite *bool                      `json:"code_write,omitempty"`
	Launcher  *GitHubIntegrationLauncher `json:"launcher,omitempty"`
}

GitHubIntegrationSettings defines model for GitHubIntegrationSettings.

type GitHubRepository 

type GitHubRepository struct {
	ID   int64  `json:"id"`
	Name string `json:"name"`
}

GitHubRepository defines model for GitHubRepository.

type GitHubSetup 

type GitHubSetup struct {
	ExpiresAt     Timestamp     `json:"expires_at"`
	IntegrationID IntegrationID `json:"integration_id"`

	// Manifest Server-authored GitHub App manifest. Serialize this object to the manifest form field when posting to registration_url.
	Manifest        map[string]interface{} `json:"manifest"`
	RegistrationURL string                 `json:"registration_url"`
	SetupRevision   int                    `json:"setup_revision"`
}

GitHubSetup defines model for GitHubSetup.

type GitHubSetupInstallation 

type GitHubSetupInstallation struct {
	// Account Provider-verified installation account login.
	Account     string  `json:"account"`
	AccountType *string `json:"account_type,omitempty"`
	ID          string  `json:"id"`
	SettingsURL string  `json:"settings_url"`
}

GitHubSetupInstallation defines model for GitHubSetupInstallation.

type Gone 

type Gone = ErrorBody

Gone defines model for Gone.

type GrantedSecretAvailability 

type GrantedSecretAvailability struct {
	GrantID SecretGrantID `json:"grant_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID                       `json:"project_id"`
	Source    GrantedSecretAvailabilitySource `json:"source"`
}

GrantedSecretAvailability defines model for GrantedSecretAvailability.

type GrantedSecretAvailabilitySource 

type GrantedSecretAvailabilitySource string

GrantedSecretAvailabilitySource defines model for GrantedSecretAvailability.Source. 

const (
	GrantedSecretAvailabilitySourceGrant GrantedSecretAvailabilitySource = "grant"
)

Defines values for GrantedSecretAvailabilitySource.

func (GrantedSecretAvailabilitySource) Valid 

func (e GrantedSecretAvailabilitySource) Valid() bool

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

type GrantedSkillAvailability 

type GrantedSkillAvailability struct {
	GrantID SkillGrantID                   `json:"grant_id"`
	Source  GrantedSkillAvailabilitySource `json:"source"`
}

GrantedSkillAvailability defines model for GrantedSkillAvailability.

type GrantedSkillAvailabilitySource 

type GrantedSkillAvailabilitySource string

GrantedSkillAvailabilitySource defines model for GrantedSkillAvailability.Source. 

const (
	GrantedSkillAvailabilitySourceGrant GrantedSkillAvailabilitySource = "grant"
)

Defines values for GrantedSkillAvailabilitySource.

func (GrantedSkillAvailabilitySource) Valid 

func (e GrantedSkillAvailabilitySource) Valid() bool

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

type IdempotencyKey 

type IdempotencyKey = string

IdempotencyKey defines model for IdempotencyKey.

type InlineMediaContentBlock 

type InlineMediaContentBlock struct {
	// Data Base64-encoded file bytes. For text media types, the decoded bytes must be valid UTF-8.
	Data      []byte                           `json:"data"`
	Filename  *string                          `json:"filename,omitempty"`
	MediaType InlineMediaContentBlockMediaType `json:"media_type"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata *ContentBlockMetadata       `json:"metadata,omitempty"`
	Type     InlineMediaContentBlockType `json:"type"`
}

InlineMediaContentBlock Files that pass validation are stored as artifacts. Model input always includes the artifact ID, whether or not the file contents can be sent directly. Text media must contain valid UTF-8 and is sent as text. Images and PDFs are sent directly when supported by the configured provider and model; unsupported combinations are rejected. Other binary documents are sent directly only to OpenAI Responses models with file input support. Chat Completions and Anthropic Messages receive the artifact ID and the filename, if provided, instead of the contents of those documents.

func NewInlineMediaContentBlock 

func NewInlineMediaContentBlock(mediaType, filename string, data []byte) InlineMediaContentBlock

NewInlineMediaContentBlock builds an inline media block; data is the raw file content (base64 on the wire).

type InlineMediaContentBlockMediaType 

type InlineMediaContentBlockMediaType string

InlineMediaContentBlockMediaType defines model for InlineMediaContentBlock.MediaType. 

const (
	ApplicationMsword                                                    InlineMediaContentBlockMediaType = "application/msword"
	ApplicationPdf                                                       InlineMediaContentBlockMediaType = "application/pdf"
	ApplicationRtf                                                       InlineMediaContentBlockMediaType = "application/rtf"
	ApplicationVndAppleIwork                                             InlineMediaContentBlockMediaType = "application/vnd.apple.iwork"
	ApplicationVndAppleKeynote                                           InlineMediaContentBlockMediaType = "application/vnd.apple.keynote"
	ApplicationVndApplePages                                             InlineMediaContentBlockMediaType = "application/vnd.apple.pages"
	ApplicationVndMsExcel                                                InlineMediaContentBlockMediaType = "application/vnd.ms-excel"
	ApplicationVndMsPowerpoint                                           InlineMediaContentBlockMediaType = "application/vnd.ms-powerpoint"
	ApplicationVndOasisOpendocumentText                                  InlineMediaContentBlockMediaType = "application/vnd.oasis.opendocument.text"
	ApplicationVndOpenxmlformatsOfficedocumentPresentationmlPresentation InlineMediaContentBlockMediaType = "application/vnd.openxmlformats-officedocument.presentationml.presentation"
	ApplicationVndOpenxmlformatsOfficedocumentSpreadsheetmlSheet         InlineMediaContentBlockMediaType = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
	ApplicationVndOpenxmlformatsOfficedocumentWordprocessingmlDocument   InlineMediaContentBlockMediaType = "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
	ImageGif                                                             InlineMediaContentBlockMediaType = "image/gif"
	ImageJpeg                                                            InlineMediaContentBlockMediaType = "image/jpeg"
	ImagePng                                                             InlineMediaContentBlockMediaType = "image/png"
	ImageWebp                                                            InlineMediaContentBlockMediaType = "image/webp"
	TextCsv                                                              InlineMediaContentBlockMediaType = "text/csv"
	TextMarkdown                                                         InlineMediaContentBlockMediaType = "text/markdown"
	TextPlain                                                            InlineMediaContentBlockMediaType = "text/plain"
	TextTabSeparatedValues                                               InlineMediaContentBlockMediaType = "text/tab-separated-values"
	TextXIif                                                             InlineMediaContentBlockMediaType = "text/x-iif"
)

Defines values for InlineMediaContentBlockMediaType.

func (InlineMediaContentBlockMediaType) Valid 

func (e InlineMediaContentBlockMediaType) Valid() bool

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

type InlineMediaContentBlockType 

type InlineMediaContentBlockType string

InlineMediaContentBlockType defines model for InlineMediaContentBlock.Type. 

const (
	Media InlineMediaContentBlockType = "media"
)

Defines values for InlineMediaContentBlockType.

func (InlineMediaContentBlockType) Valid 

func (e InlineMediaContentBlockType) Valid() bool

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

type InspectGitHubInstallationsRequest 

type InspectGitHubInstallationsRequest struct {
	// CredentialSecretID Secret ID (sec_...).
	CredentialSecretID SecretID `json:"credential_secret_id"`
	Page               *int     `json:"page,omitempty"`
}

InspectGitHubInstallationsRequest defines model for InspectGitHubInstallationsRequest.

type InspectIntegrationGitHubInstallationsJSONRequestBody 

type InspectIntegrationGitHubInstallationsJSONRequestBody = InspectGitHubInstallationsRequest

InspectIntegrationGitHubInstallationsJSONRequestBody defines body for InspectIntegrationGitHubInstallations for application/json ContentType.

type InstallationID 

type InstallationID = string

InstallationID defines model for InstallationID.

type Integration 

type Integration struct {
	// BotMention GitHub App mention including the leading @, derived from the verified App slug. Omitted when the verified slug is unavailable or the integration is not GitHub. Retained after disconnect.
	BotMention   *string                 `json:"bot_mention,omitempty"`
	Capabilities IntegrationCapabilities `json:"capabilities"`
	CreatedAt    Timestamp               `json:"created_at"`

	// CredentialSecretID Secret ID (sec_...).
	CredentialSecretID *SecretID     `json:"credential_secret_id,omitempty"`
	ID                 IntegrationID `json:"id"`

	// IntegrationKind Registered integration implementation; independent of the saved integration's name and immutable ID.
	IntegrationKind IntegrationKind         `json:"integration_kind"`
	LastOauthFlowID *IntegrationOAuthFlowID `json:"last_oauth_flow_id,omitempty"`

	// Name Immutable, project-unique integration name used in config keys and qualified tool names.
	Name IntegrationName `json:"name"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// ProviderAccountRef Verified provider account, omitted until first connection. Retained after disconnect.
	ProviderAccountRef *string `json:"provider_account_ref,omitempty"`

	// ProviderAgentDisplayName Provider account display label, at most 512 UTF-8 bytes. Leading and trailing whitespace is trimmed on save. Empty means no label; an omitted or empty value clears the label on account-management updates.
	ProviderAgentDisplayName IntegrationProviderDisplayName `json:"provider_agent_display_name"`

	// ProviderConfig Non-secret provider configuration, validated for the selected provider. Slack and GitHub integrations require an empty object. Discord accepts only public_key (optional, a 32-byte hex-encoded Ed25519 verification key for interaction callbacks). BMA manages one Gateway connection per Discord integration. Credentials and integration behavior are not accepted here.
	ProviderConfig IntegrationProviderConfig `json:"provider_config"`

	// ProviderTenantID Verified provider identity, omitted until first connection. Retained after disconnect.
	ProviderTenantID *string `json:"provider_tenant_id,omitempty"`

	// RuntimeFailure Most recent connection failure for the active integration's current setup and credential version. Returned only by Get integration, not list or mutation responses. Omission does not establish provider connectivity; a runtime lease is not a connection check.
	RuntimeFailure *IntegrationRuntimeFailure `json:"runtime_failure,omitempty"`

	// Settings Integration-owned settings JSON. Validate against capabilities.settings.input_schema from the integration catalog. Public profile references use aprf_ IDs and resolve at runtime. GitHub integrations use GitHubIntegrationSettings; Slack and Discord integrations use ChatIntegrationSettings.
	Settings IntegrationSettings `json:"settings"`

	// SetupRevision Credential and transport revision. Launcher edits leave this value unchanged.
	SetupRevision int              `json:"setup_revision"`
	State         IntegrationState `json:"state"`
	UpdatedAt     Timestamp        `json:"updated_at"`
}

Integration defines model for Integration.

type IntegrationCapabilities 

type IntegrationCapabilities struct {
	InteractionHandler *IntegrationCapabilityDefinition           `json:"interaction_handler,omitempty"`
	Schedule           *IntegrationCapabilityDefinition           `json:"schedule,omitempty"`
	Settings           *IntegrationCapabilityDefinition           `json:"settings,omitempty"`
	Subscription       *IntegrationSubscriptionDefinition         `json:"subscription,omitempty"`
	Tools              map[string]IntegrationCapabilityDefinition `json:"tools"`
}

IntegrationCapabilities defines model for IntegrationCapabilities.

type IntegrationCapabilityDefinition 

type IntegrationCapabilityDefinition struct {
	Description *string `json:"description,omitempty"`

	// InputSchema Static argument schema for this operation or interaction handler. Shipped integration tools accept action arguments and use the conversation assigned at launch; execution fails if no conversation is assigned. Shipped interaction handlers use the assigned conversation and accept empty arguments.
	InputSchema map[string]interface{} `json:"input_schema"`
}

IntegrationCapabilityDefinition defines model for IntegrationCapabilityDefinition.

type IntegrationConfigureParams 

type IntegrationConfigureParams struct {
	CredentialSecretID       SecretID
	ExpectedSetupRevision    int
	ProviderAccountRef       *string
	ProviderAgentDisplayName *IntegrationProviderDisplayName
	ProviderConfig           *IntegrationProviderConfig
	ProviderTenantID         string
}

IntegrationConfigureParams are the query, header and body fields of configureIntegration.

type IntegrationConversation 

type IntegrationConversation map[string]interface{}

IntegrationConversation One concrete provider address, validated by the integration's capabilities.subscription.conversation_schema. Slack uses channel_id and optional thread_ts; Discord uses channel_id for a channel or thread_id for a thread; GitHub uses repository_id and pull_request. Discord accepts optional parent channel_id and guild_id alongside thread_id and validates their ID format, but subscription creation does not verify them against Discord or retain them as routing restrictions. Only thread_id is retained in a canonical thread address and returned by create/list responses. No credentials or runtime state.

type IntegrationCreateGitHubSetupParams 

type IntegrationCreateGitHubSetupParams struct {
	AppName               *string
	ExpectedSetupRevision int
	Organization          *string
}

IntegrationCreateGitHubSetupParams are the query, header and body fields of createIntegrationGitHubSetup.

type IntegrationCreateOAuthSetupParams 

type IntegrationCreateOAuthSetupParams struct {
	ClientID      string
	ClientSecret  string
	ReturnTo      *string
	SigningSecret string
}

IntegrationCreateOAuthSetupParams are the query, header and body fields of createIntegrationOAuthSetup.

type IntegrationCreateSlackSetupParams 

type IntegrationCreateSlackSetupParams struct {
	AppConfigurationToken string
	AppName               string
	Icon                  *SlackSetupIcon
	ReturnTo              *string
}

IntegrationCreateSlackSetupParams are the query, header and body fields of createIntegrationSlackSetup.

type IntegrationCronTriggerTarget 

type IntegrationCronTriggerTarget struct {
	IntegrationID IntegrationID `json:"integration_id"`

	// Settings Settings validated by the target integration's published schedule input schema. Each accepted occurrence retains its own copy. Integration resource references are resolved when the integration handles the occurrence.
	Settings map[string]interface{}           `json:"settings"`
	Type     IntegrationCronTriggerTargetType `json:"type"`
}

IntegrationCronTriggerTarget defines model for IntegrationCronTriggerTarget.

type IntegrationCronTriggerTargetType 

type IntegrationCronTriggerTargetType string

IntegrationCronTriggerTargetType defines model for IntegrationCronTriggerTarget.Type. 

const (
	IntegrationCronTriggerTargetTypeIntegration IntegrationCronTriggerTargetType = "integration"
)

Defines values for IntegrationCronTriggerTargetType.

func (IntegrationCronTriggerTargetType) Valid 

func (e IntegrationCronTriggerTargetType) Valid() bool

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

type IntegrationDefinition 

type IntegrationDefinition struct {
	Capabilities IntegrationCapabilities `json:"capabilities"`

	// IntegrationKind Registered integration implementation; independent of the saved integration's name and immutable ID.
	IntegrationKind IntegrationKind `json:"integration_kind"`
}

IntegrationDefinition defines model for IntegrationDefinition.

type IntegrationDefinitionService 

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

IntegrationDefinitionService groups the integrationDefinitions methods.

func (*IntegrationDefinitionService) List 

func (s *IntegrationDefinitionService) List(ctx context.Context, opts ...option.RequestOption) (*ListIntegrationDefinitionsResponse, error)

List calls listIntegrationDefinitions: GET /orgs/{orgID}/projects/{projectID}/integration-definitions.

type IntegrationID 

type IntegrationID = string

IntegrationID defines model for IntegrationID.

type IntegrationInspectGitHubInstallationsParams 

type IntegrationInspectGitHubInstallationsParams struct {
	CredentialSecretID SecretID
	Page               *int
}

IntegrationInspectGitHubInstallationsParams are the query, header and body fields of inspectIntegrationGitHubInstallations.

type IntegrationKind 

type IntegrationKind string

IntegrationKind Registered integration implementation; independent of the saved integration's name and immutable ID. 

const (
	IntegrationKindDiscordThread IntegrationKind = "discord_thread"
	IntegrationKindGitHubPR      IntegrationKind = "github_pr"
	IntegrationKindSlackThread   IntegrationKind = "slack_thread"
)

Defines values for IntegrationKind.

func (IntegrationKind) Valid 

func (e IntegrationKind) Valid() bool

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

type IntegrationListGitHubRepositoriesParams 

type IntegrationListGitHubRepositoriesParams struct {
	Cursor *PageCursor
}

IntegrationListGitHubRepositoriesParams are the query, header and body fields of listIntegrationGitHubRepositories.

type IntegrationListParams 

type IntegrationListParams struct {
	Name   *ResourceNameFilter
	Limit  *PageLimit
	Cursor *PageCursor
}

IntegrationListParams are the query, header and body fields of listIntegrations.

type IntegrationName 

type IntegrationName = string

IntegrationName Immutable, project-unique integration name used in config keys and qualified tool names.

type IntegrationNewParams 

type IntegrationNewParams struct {
	IntegrationKind IntegrationKind
	Name            IntegrationName
	Settings        IntegrationSettings
}

IntegrationNewParams are the query, header and body fields of createIntegration.

type IntegrationOAuthFlowID 

type IntegrationOAuthFlowID = string

IntegrationOAuthFlowID defines model for IntegrationOAuthFlowID.

type IntegrationOAuthSetup 

type IntegrationOAuthSetup struct {
	ActionsURL    string                 `json:"actions_url"`
	EventsURL     string                 `json:"events_url"`
	ExpiresAt     Timestamp              `json:"expires_at"`
	FlowID        IntegrationOAuthFlowID `json:"flow_id"`
	IntegrationID IntegrationID          `json:"integration_id"`
	OauthURL      string                 `json:"oauth_url"`
	Provider      string                 `json:"provider"`
	RedirectURI   string                 `json:"redirect_uri"`

	// SetupRevision Integration setup revision captured by this authorization flow.
	SetupRevision int `json:"setup_revision"`
}

IntegrationOAuthSetup defines model for IntegrationOAuthSetup.

type IntegrationProviderConfig 

type IntegrationProviderConfig map[string]interface{}

IntegrationProviderConfig Non-secret provider configuration, validated for the selected provider. Slack and GitHub integrations require an empty object. Discord accepts only public_key (optional, a 32-byte hex-encoded Ed25519 verification key for interaction callbacks). BMA manages one Gateway connection per Discord integration. Credentials and integration behavior are not accepted here.

type IntegrationProviderDisplayName 

type IntegrationProviderDisplayName = string

IntegrationProviderDisplayName Provider account display label, at most 512 UTF-8 bytes. Leading and trailing whitespace is trimmed on save. Empty means no label; an omitted or empty value clears the label on account-management updates.

type IntegrationRuntimeFailure 

type IntegrationRuntimeFailure struct {
	// Message Connection failure recorded by the integration runtime.
	Message string `json:"message"`

	// RetryAt Earliest time the runtime may retry. A retry can start later.
	RetryAt Timestamp `json:"retry_at"`
}

IntegrationRuntimeFailure Most recent connection failure for the active integration's current setup and credential version. Returned only by Get integration, not list or mutation responses. Omission does not establish provider connectivity; a runtime lease is not a connection check.

type IntegrationService 

type IntegrationService struct {
	Subscriptions *IntegrationSubscriptionService
	// contains filtered or unexported fields
}

IntegrationService groups the integrations methods.

func (*IntegrationService) Configure 

func (s *IntegrationService) Configure(ctx context.Context, integrationID string, params IntegrationConfigureParams, opts ...option.RequestOption) (*Integration, error)

Configure calls configureIntegration: POST /orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/setup.

func (*IntegrationService) CreateGitHubSetup 

func (s *IntegrationService) CreateGitHubSetup(ctx context.Context, integrationID string, params IntegrationCreateGitHubSetupParams, opts ...option.RequestOption) (*GitHubSetup, error)

CreateGitHubSetup calls createIntegrationGitHubSetup: POST /orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/github-setup.

func (*IntegrationService) CreateOAuthSetup 

func (s *IntegrationService) CreateOAuthSetup(ctx context.Context, integrationID string, params IntegrationCreateOAuthSetupParams, opts ...option.RequestOption) (*IntegrationOAuthSetup, error)

CreateOAuthSetup calls createIntegrationOAuthSetup: POST /orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/oauth/setup.

func (*IntegrationService) CreateSlackSetup 

func (s *IntegrationService) CreateSlackSetup(ctx context.Context, integrationID string, params IntegrationCreateSlackSetupParams, opts ...option.RequestOption) (*SlackSetup, error)

CreateSlackSetup calls createIntegrationSlackSetup: POST /orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/slack-setup.

func (*IntegrationService) Delete 

func (s *IntegrationService) Delete(ctx context.Context, integrationID string, opts ...option.RequestOption) error

Delete calls deleteIntegration: DELETE /orgs/{orgID}/projects/{projectID}/integrations/{integrationID}.

func (*IntegrationService) Disconnect 

func (s *IntegrationService) Disconnect(ctx context.Context, integrationID string, opts ...option.RequestOption) (*Integration, error)

Disconnect calls disconnectIntegration: POST /orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/disconnect.

func (*IntegrationService) Get 

func (s *IntegrationService) Get(ctx context.Context, integrationID string, opts ...option.RequestOption) (*Integration, error)

Get calls getIntegration: GET /orgs/{orgID}/projects/{projectID}/integrations/{integrationID}.

func (*IntegrationService) InspectGitHubInstallations 

func (s *IntegrationService) InspectGitHubInstallations(ctx context.Context, integrationID string, params IntegrationInspectGitHubInstallationsParams, opts ...option.RequestOption) (*GitHubInstallations, error)

InspectGitHubInstallations calls inspectIntegrationGitHubInstallations: POST /orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/github-setup/installations.

func (*IntegrationService) List 

func (s *IntegrationService) List(ctx context.Context, params IntegrationListParams, opts ...option.RequestOption) (*CursorPage[Integration], error)

List calls listIntegrations: GET /orgs/{orgID}/projects/{projectID}/integrations.

func (*IntegrationService) ListAutoPaging 

func (s *IntegrationService) ListAutoPaging(ctx context.Context, params IntegrationListParams, opts ...option.RequestOption) *CursorPageAutoPager[Integration]

ListAutoPaging iterates every item of listIntegrations across pages.

func (*IntegrationService) ListGitHubRepositories 

func (s *IntegrationService) ListGitHubRepositories(ctx context.Context, integrationID string, params IntegrationListGitHubRepositoriesParams, opts ...option.RequestOption) (*CursorPage[GitHubRepository], error)

ListGitHubRepositories calls listIntegrationGitHubRepositories: GET /orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/github-repositories.

func (*IntegrationService) ListGitHubRepositoriesAutoPaging 

func (s *IntegrationService) ListGitHubRepositoriesAutoPaging(ctx context.Context, integrationID string, params IntegrationListGitHubRepositoriesParams, opts ...option.RequestOption) *CursorPageAutoPager[GitHubRepository]

ListGitHubRepositoriesAutoPaging iterates every item of listIntegrationGitHubRepositories across pages.

func (*IntegrationService) New 

func (s *IntegrationService) New(ctx context.Context, params IntegrationNewParams, opts ...option.RequestOption) (*Integration, error)

New calls createIntegration: POST /orgs/{orgID}/projects/{projectID}/integrations.

func (*IntegrationService) Update 

func (s *IntegrationService) Update(ctx context.Context, integrationID string, params IntegrationUpdateParams, opts ...option.RequestOption) (*Integration, error)

Update calls updateIntegration: PUT /orgs/{orgID}/projects/{projectID}/integrations/{integrationID}.

type IntegrationSettings 

type IntegrationSettings map[string]interface{}

IntegrationSettings Integration-owned settings JSON. Validate against capabilities.settings.input_schema from the integration catalog. Public profile references use aprf_ IDs and resolve at runtime. GitHub integrations use GitHubIntegrationSettings; Slack and Discord integrations use ChatIntegrationSettings.

type IntegrationState 

type IntegrationState string

IntegrationState defines model for IntegrationState. 

const (
	IntegrationStateActive       IntegrationState = "active"
	IntegrationStateDisconnected IntegrationState = "disconnected"
)

Defines values for IntegrationState.

func (IntegrationState) Valid 

func (e IntegrationState) Valid() bool

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

type IntegrationSubscription 

type IntegrationSubscription struct {
	AgentID AgentID `json:"agent_id"`

	// AgentName Agent name. Empty means the agent is unnamed; non-empty values use the ResourceName policy.
	AgentName AgentName `json:"agent_name"`

	// Conversation One concrete provider address, validated by the integration's capabilities.subscription.conversation_schema. Slack uses channel_id and optional thread_ts; Discord uses channel_id for a channel or thread_id for a thread; GitHub uses repository_id and pull_request. Discord accepts optional parent channel_id and guild_id alongside thread_id and validates their ID format, but subscription creation does not verify them against Discord or retain them as routing restrictions. Only thread_id is retained in a canonical thread address and returned by create/list responses. No credentials or runtime state.
	Conversation IntegrationConversation `json:"conversation"`

	// ConversationName Saved display name for the conversation, when available.
	ConversationName *string                   `json:"conversation_name,omitempty"`
	CreatedAt        Timestamp                 `json:"created_at"`
	ID               IntegrationSubscriptionID `json:"id"`
	IntegrationID    IntegrationID             `json:"integration_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`
}

IntegrationSubscription defines model for IntegrationSubscription.

type IntegrationSubscriptionAttachment 

type IntegrationSubscriptionAttachment struct {
	// Conversation One concrete provider address, validated by the integration's capabilities.subscription.conversation_schema. Slack uses channel_id and optional thread_ts; Discord uses channel_id for a channel or thread_id for a thread; GitHub uses repository_id and pull_request. Discord accepts optional parent channel_id and guild_id alongside thread_id and validates their ID format, but subscription creation does not verify them against Discord or retain them as routing restrictions. Only thread_id is retained in a canonical thread address and returned by create/list responses. No credentials or runtime state.
	Conversation  IntegrationConversation `json:"conversation"`
	IntegrationID IntegrationID           `json:"integration_id"`
}

IntegrationSubscriptionAttachment defines model for IntegrationSubscriptionAttachment.

type IntegrationSubscriptionDefinition 

type IntegrationSubscriptionDefinition struct {
	// ConversationSchema Schema for one concrete provider conversation address.
	ConversationSchema map[string]interface{} `json:"conversation_schema"`
}

IntegrationSubscriptionDefinition defines model for IntegrationSubscriptionDefinition.

type IntegrationSubscriptionID 

type IntegrationSubscriptionID = string

IntegrationSubscriptionID defines model for IntegrationSubscriptionID.

type IntegrationSubscriptionListParams 

type IntegrationSubscriptionListParams struct {
	Limit  *PageLimit
	Cursor *PageCursor
}

IntegrationSubscriptionListParams are the query, header and body fields of listIntegrationSubscriptions.

type IntegrationSubscriptionNewParams 

type IntegrationSubscriptionNewParams struct {
	AgentID      AgentID
	Conversation IntegrationConversation
}

IntegrationSubscriptionNewParams are the query, header and body fields of createIntegrationSubscription.

type IntegrationSubscriptionService 

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

IntegrationSubscriptionService groups the integrations.subscriptions methods.

func (*IntegrationSubscriptionService) Delete 

func (s *IntegrationSubscriptionService) Delete(ctx context.Context, integrationID string, subscriptionID string, opts ...option.RequestOption) error

Delete calls deleteIntegrationSubscription: DELETE /orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/subscriptions/{subscriptionID}.

func (*IntegrationSubscriptionService) List 

func (s *IntegrationSubscriptionService) List(ctx context.Context, integrationID string, params IntegrationSubscriptionListParams, opts ...option.RequestOption) (*CursorPage[IntegrationSubscription], error)

List calls listIntegrationSubscriptions: GET /orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/subscriptions.

func (*IntegrationSubscriptionService) ListAutoPaging 

func (s *IntegrationSubscriptionService) ListAutoPaging(ctx context.Context, integrationID string, params IntegrationSubscriptionListParams, opts ...option.RequestOption) *CursorPageAutoPager[IntegrationSubscription]

ListAutoPaging iterates every item of listIntegrationSubscriptions across pages.

func (*IntegrationSubscriptionService) New 

func (s *IntegrationSubscriptionService) New(ctx context.Context, integrationID string, params IntegrationSubscriptionNewParams, opts ...option.RequestOption) (*IntegrationSubscription, error)

New calls createIntegrationSubscription: POST /orgs/{orgID}/projects/{projectID}/integrations/{integrationID}/subscriptions.

type IntegrationTarget 

type IntegrationTarget struct {
	// Conversation One concrete provider address, validated by the integration's capabilities.subscription.conversation_schema. Slack uses channel_id and optional thread_ts; Discord uses channel_id for a channel or thread_id for a thread; GitHub uses repository_id and pull_request. Discord accepts optional parent channel_id and guild_id alongside thread_id and validates their ID format, but subscription creation does not verify them against Discord or retain them as routing restrictions. Only thread_id is retained in a canonical thread address and returned by create/list responses. No credentials or runtime state.
	Conversation IntegrationConversation `json:"conversation"`
	DisplayName  string                  `json:"display_name"`
	Provider     string                  `json:"provider"`
	ProviderURI  *string                 `json:"provider_uri,omitempty"`
}

IntegrationTarget defines model for IntegrationTarget.

type IntegrationTargetID 

type IntegrationTargetID = string

IntegrationTargetID defines model for IntegrationTargetID.

type IntegrationUpdateParams 

type IntegrationUpdateParams struct {
	Settings IntegrationSettings
}

IntegrationUpdateParams are the query, header and body fields of updateIntegration.

type InteractionAnswer 

type InteractionAnswer struct {
	OptionIndices []int `json:"option_indices"`

	// Text Optional companion text when the selected option allows it.
	Text *string `json:"text,omitempty"`
}

InteractionAnswer defines model for InteractionAnswer.

type InteractionForm 

type InteractionForm struct {
	Context   *[]InteractionFormContextItem `json:"context,omitempty"`
	Questions []InteractionFormQuestion     `json:"questions"`
	Title     string                        `json:"title"`
}

InteractionForm defines model for InteractionForm.

type InteractionFormContextItem 

type InteractionFormContextItem struct {
	Label string `json:"label"`
	Value string `json:"value"`
}

InteractionFormContextItem defines model for InteractionFormContextItem.

type InteractionFormOption 

type InteractionFormOption struct {
	// AllowsText Whether the answer may include optional companion text for this option.
	AllowsText *bool  `json:"allows_text,omitempty"`
	Label      string `json:"label"`
}

InteractionFormOption defines model for InteractionFormOption.

type InteractionFormQuestion 

type InteractionFormQuestion struct {
	// Multiple Whether the answer may select more than one option.
	Multiple *bool                   `json:"multiple,omitempty"`
	Options  []InteractionFormOption `json:"options"`
	Prompt   string                  `json:"prompt"`
}

InteractionFormQuestion defines model for InteractionFormQuestion.

type InteractionPresentationReceipt 

type InteractionPresentationReceipt map[string]interface{}

InteractionPresentationReceipt Confirmed provider presentation metadata, when recorded. This is not an execution grant or a delivery guarantee. Absence does not prove a remote send failed. Customer-hosted presenters maintain their own delivery records.

type InteractionResolution 

type InteractionResolution struct {
	// Answers Answers in the same order as the interaction form's questions.
	Answers []InteractionAnswer `json:"answers"`
}

InteractionResolution defines model for InteractionResolution.

type InternalServerError 

type InternalServerError = ErrorBody

InternalServerError defines model for InternalServerError.

type InvitationListParams 

type InvitationListParams struct {
	Limit  *PageLimit
	Cursor *PageCursor
}

InvitationListParams are the query, header and body fields of listPendingInvitations.

type InvitationService 

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

InvitationService groups the invitations methods.

func (*InvitationService) Accept 

func (s *InvitationService) Accept(ctx context.Context, invitationID string, opts ...option.RequestOption) (*OrgInvitation, error)

Accept calls acceptInvitation: POST /invitations/{invitationID}/accept.

func (*InvitationService) Decline 

func (s *InvitationService) Decline(ctx context.Context, invitationID string, opts ...option.RequestOption) (*OrgInvitation, error)

Decline calls declineInvitation: POST /invitations/{invitationID}/decline.

func (*InvitationService) List 

func (s *InvitationService) List(ctx context.Context, params InvitationListParams, opts ...option.RequestOption) (*CursorPage[OrgInvitation], error)

List calls listPendingInvitations: GET /invitations.

func (*InvitationService) ListAutoPaging 

func (s *InvitationService) ListAutoPaging(ctx context.Context, params InvitationListParams, opts ...option.RequestOption) *CursorPageAutoPager[OrgInvitation]

ListAutoPaging iterates every item of listPendingInvitations across pages.

type JSONBlob 

type JSONBlob = interface{}

JSONBlob Public JSON payload whose shape is determined by the event or interaction kind.

type LaunchAgentResponse 

type LaunchAgentResponse struct {
	Agent           Agent                 `json:"agent"`
	AgentConfig     AgentConfig           `json:"agent_config"`
	AgentInput      *AgentInput           `json:"agent_input,omitempty"`
	MachineBindings []AgentMachineBinding `json:"machine_bindings"`
}

LaunchAgentResponse defines model for LaunchAgentResponse.

type ListActorsParams 

type ListActorsParams struct {
	Provider         *ActorProvider `form:"provider,omitempty" json:"provider,omitempty"`
	ProviderTenantID *string        `form:"provider_tenant_id,omitempty" json:"provider_tenant_id,omitempty"`
	ProviderUserID   *string        `form:"provider_user_id,omitempty" json:"provider_user_id,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListActorsParams defines parameters for ListActors.

type ListActorsResponse 

type ListActorsResponse struct {
	Data       []Actor `json:"data"`
	NextCursor *string `json:"next_cursor"`
}

ListActorsResponse defines model for ListActorsResponse.

type ListAgentEventsResponse 

type ListAgentEventsResponse struct {
	Data []AgentEvent `json:"data"`

	// HasMore True when another immediate request in the requested pagination direction can return more currently available events.
	HasMore bool `json:"has_more"`

	// NextAfterSequence Non-negative agent timeline cursor.
	NextAfterSequence AgentSequenceCursor `json:"next_after_sequence"`

	// NextBeforeSequence Sequence to pass as before_sequence for the next older page. Null when no older events remain or when paginating forward.
	NextBeforeSequence *AgentSequenceCursor `json:"next_before_sequence,omitempty"`
}

ListAgentEventsResponse defines model for ListAgentEventsResponse.

type ListAgentInputsResponse 

type ListAgentInputsResponse struct {
	Data       []AgentInput `json:"data"`
	NextCursor *string      `json:"next_cursor"`
}

ListAgentInputsResponse defines model for ListAgentInputsResponse.

type ListAgentInteractionsParams 

type ListAgentInteractionsParams struct {
	State *AgentInteractionState `form:"state,omitempty" json:"state,omitempty"`

	// IncludeSubagents Also return interactions from every subagent beneath this agent. Resolve those against the subagent's own agent_id.
	IncludeSubagents *bool `form:"include_subagents,omitempty" json:"include_subagents,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListAgentInteractionsParams defines parameters for ListAgentInteractions.

type ListAgentInteractionsResponse 

type ListAgentInteractionsResponse struct {
	Data       []AgentInteraction `json:"data"`
	NextCursor *string            `json:"next_cursor"`
}

ListAgentInteractionsResponse defines model for ListAgentInteractionsResponse.

type ListAgentMachinesResponse 

type ListAgentMachinesResponse struct {
	Data []AgentMachine `json:"data"`
}

ListAgentMachinesResponse defines model for ListAgentMachinesResponse.

type ListAgentProfilesParams 

type ListAgentProfilesParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// IncludeStats Include each profile's `stats`, so a list can show instance counts and usage without a request per profile.
	IncludeStats *AgentProfileIncludeStats `form:"include_stats,omitempty" json:"include_stats,omitempty"`

	// StatsSince Start of the window `stats.usage` tallies, with `include_stats`. Omit to tally from the earliest recorded call.
	StatsSince *AgentProfileStatsSince `form:"stats_since,omitempty" json:"stats_since,omitempty"`
	Sort       *ResourceListSort       `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListAgentProfilesParams defines parameters for ListAgentProfiles.

type ListAgentProfilesResponse 

type ListAgentProfilesResponse struct {
	Data []AgentProfileSummary `json:"data"`

	// NextCursor Opaque cursor for the next page, or null when this is the last page.
	NextCursor *string `json:"next_cursor"`
}

ListAgentProfilesResponse defines model for ListAgentProfilesResponse.

type ListAgentSessionsParams 

type ListAgentSessionsParams struct {
	IncludeArchived *bool   `form:"include_archived,omitempty" json:"include_archived,omitempty"`
	BeforeID        *string `form:"before_id,omitempty" json:"before_id,omitempty"`
	Limit           *int32  `form:"limit,omitempty" json:"limit,omitempty"`
}

ListAgentSessionsParams defines parameters for ListAgentSessions.

type ListAgentSessionsResponse 

type ListAgentSessionsResponse struct {
	Data         []AgentSession `json:"data"`
	NextBeforeID *string        `json:"next_before_id,omitempty"`
}

ListAgentSessionsResponse defines model for ListAgentSessionsResponse.

type ListAgentTurnsResponse 

type ListAgentTurnsResponse struct {
	Data []AgentTurn `json:"data"`

	// NextBeforeTurnSequence Pass this value as before_turn_sequence to fetch older turns, or null when this page reached the beginning of the agent's turns.
	NextBeforeTurnSequence *AgentSequenceCursor `json:"next_before_turn_sequence"`
}

ListAgentTurnsResponse defines model for ListAgentTurnsResponse.

type ListAgentsParams 

type ListAgentsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// AgentProfileID Return only agents launched from this agent profile.
	AgentProfileID *AgentProfileID `form:"agent_profile_id,omitempty" json:"agent_profile_id,omitempty"`

	// ParentAgentID Return only subagents spawned by this agent.
	ParentAgentID *AgentID `form:"parent_agent_id,omitempty" json:"parent_agent_id,omitempty"`

	// IncludeSubagents Include subagents alongside top-level agents. Defaults to false, so only agents without a parent are returned unless parent_agent_id is set.
	IncludeSubagents *bool `form:"include_subagents,omitempty" json:"include_subagents,omitempty"`

	// IncludeArchived Include archived agents. Defaults to false.
	IncludeArchived *bool `form:"include_archived,omitempty" json:"include_archived,omitempty"`

	// IncludeUsage Include each agent's `usage`, so a list can show costs without a request per agent.
	IncludeUsage *AgentIncludeUsage `form:"include_usage,omitempty" json:"include_usage,omitempty"`
	Sort         *ResourceListSort  `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListAgentsParams defines parameters for ListAgents.

type ListAgentsResponse 

type ListAgentsResponse struct {
	Data []Agent `json:"data"`

	// NextCursor Opaque cursor for the next page, or null when this is the last page.
	NextCursor *string `json:"next_cursor"`
}

ListAgentsResponse defines model for ListAgentsResponse.

type ListBYOMachineDaemonTokensParams 

type ListBYOMachineDaemonTokensParams struct {
	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListBYOMachineDaemonTokensParams defines parameters for ListBYOMachineDaemonTokens.

type ListConfiguredModelsParams 

type ListConfiguredModelsParams struct {
	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListConfiguredModelsParams defines parameters for ListConfiguredModels.

type ListCronTriggersParams 

type ListCronTriggersParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// AgentID Only return triggers targeting this agent.
	AgentID *AgentID `form:"agent_id,omitempty" json:"agent_id,omitempty"`

	// AgentProfileID Only return triggers targeting this agent profile.
	AgentProfileID *AgentProfileID `form:"agent_profile_id,omitempty" json:"agent_profile_id,omitempty"`

	// IntegrationID Only return scheduled launches for this integration.
	IntegrationID *IntegrationID    `form:"integration_id,omitempty" json:"integration_id,omitempty"`
	Sort          *ResourceListSort `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListCronTriggersParams defines parameters for ListCronTriggers.

type ListCronTriggersResponse 

type ListCronTriggersResponse struct {
	Data []CronTrigger `json:"data"`

	// NextCursor Opaque cursor for the next page, or null when this is the last page.
	NextCursor *string `json:"next_cursor"`
}

ListCronTriggersResponse defines model for ListCronTriggersResponse.

type ListEventWebhooksParams 

type ListEventWebhooksParams struct {
	ScopeType      EventWebhookScopeType `form:"scope_type" json:"scope_type"`
	AgentProfileID *AgentProfileID       `form:"agent_profile_id,omitempty" json:"agent_profile_id,omitempty"`
	AgentID        *AgentID              `form:"agent_id,omitempty" json:"agent_id,omitempty"`
}

ListEventWebhooksParams defines parameters for ListEventWebhooks.

type ListEventWebhooksResponse 

type ListEventWebhooksResponse struct {
	Data []EventWebhook `json:"data"`
}

ListEventWebhooksResponse defines model for ListEventWebhooksResponse.

type ListEventsParams 

type ListEventsParams struct {
	// SessionID Agent session ID (ses_...). Omit to use the agent's default session.
	SessionID *string `form:"session_id,omitempty" json:"session_id,omitempty"`

	// BeforeSequence Exclusive event sequence boundary for backward pagination. Pass 0 for the latest events.
	BeforeSequence *int64 `form:"before_sequence,omitempty" json:"before_sequence,omitempty"`

	// AfterSequence Exclusive event sequence boundary. Omit or pass 0 for the beginning of the agent event log.
	AfterSequence *int64 `form:"after_sequence,omitempty" json:"after_sequence,omitempty"`

	// Limit Maximum number of events to return.
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}

ListEventsParams defines parameters for ListEvents.

type ListFilesParams 

type ListFilesParams struct {
	// Limit Page size (1-1000, default 20).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Page next_page from the previous response. Omit for the first page.
	Page *string `form:"page,omitempty" json:"page,omitempty"`

	// ScopeID Only files scoped to this session (ses_...).
	ScopeID *string `form:"scope_id,omitempty" json:"scope_id,omitempty"`

	// IncludeSuperseded Also list the older versions of session outputs. Defaults to false, so each session output path lists only its newest version.
	IncludeSuperseded *bool `form:"include_superseded,omitempty" json:"include_superseded,omitempty"`

	// Metadata Label filter as key:value, for example beework_space_id:sp_123. Repeat to require several labels.
	Metadata *[]string `form:"metadata,omitempty" json:"metadata,omitempty"`
}

ListFilesParams defines parameters for ListFiles.

type ListGitHubRepositoriesResponse 

type ListGitHubRepositoriesResponse struct {
	Data       []GitHubRepository `json:"data"`
	NextCursor *string            `json:"next_cursor"`
}

ListGitHubRepositoriesResponse defines model for ListGitHubRepositoriesResponse.

type ListIntegrationDefinitionsResponse 

type ListIntegrationDefinitionsResponse struct {
	Data []IntegrationDefinition `json:"data"`
}

ListIntegrationDefinitionsResponse defines model for ListIntegrationDefinitionsResponse.

type ListIntegrationGitHubRepositoriesParams 

type ListIntegrationGitHubRepositoriesParams struct {
	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListIntegrationGitHubRepositoriesParams defines parameters for ListIntegrationGitHubRepositories.

type ListIntegrationSubscriptionsParams 

type ListIntegrationSubscriptionsParams struct {
	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListIntegrationSubscriptionsParams defines parameters for ListIntegrationSubscriptions.

type ListIntegrationSubscriptionsResponse 

type ListIntegrationSubscriptionsResponse struct {
	Data []IntegrationSubscription `json:"data"`

	// NextCursor Opaque cursor for the next page, or null when this is the last page.
	NextCursor *string `json:"next_cursor"`
}

ListIntegrationSubscriptionsResponse defines model for ListIntegrationSubscriptionsResponse.

type ListIntegrationsParams 

type ListIntegrationsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListIntegrationsParams defines parameters for ListIntegrations.

type ListIntegrationsResponse 

type ListIntegrationsResponse struct {
	Data       []Integration `json:"data"`
	NextCursor *string       `json:"next_cursor"`
}

ListIntegrationsResponse defines model for ListIntegrationsResponse.

type ListMCPServerToolsJSONRequestBody 

type ListMCPServerToolsJSONRequestBody = MCPServerToolsRequest

ListMCPServerToolsJSONRequestBody defines body for ListMCPServerTools for application/json ContentType.

type ListMCPServersParams 

type ListMCPServersParams struct {
	// Q Free-text query matched against server name, title, description, and remote URLs. Each term matches as a prefix.
	Q *string `form:"q,omitempty" json:"q,omitempty"`

	// RemoteURL Only return servers with a remote at exactly this URL. Matching is case-insensitive and ignores the scheme and trailing slashes, so `MCP.linear.app/mcp/` matches `https://mcp.linear.app/mcp`.
	RemoteURL *string `form:"remote_url,omitempty" json:"remote_url,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListMCPServersParams defines parameters for ListMCPServers.

type ListMCPServersResponse 

type ListMCPServersResponse struct {
	Data []MCPRegistryServer `json:"data"`

	// NextCursor Opaque cursor for the next page, or null when this is the last page.
	NextCursor *string `json:"next_cursor"`
}

ListMCPServersResponse defines model for ListMCPServersResponse.

type ListMachineBackupsResponse 

type ListMachineBackupsResponse struct {
	Data []MachineBackup `json:"data"`
}

ListMachineBackupsResponse defines model for ListMachineBackupsResponse.

type ListMachineDaemonTokensResponse 

type ListMachineDaemonTokensResponse struct {
	Data       []MachineDaemonToken `json:"data"`
	NextCursor *string              `json:"next_cursor"`
}

ListMachineDaemonTokensResponse defines model for ListMachineDaemonTokensResponse.

type ListMachinePoolsParams 

type ListMachinePoolsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`
	Sort *ResourceListSort   `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListMachinePoolsParams defines parameters for ListMachinePools.

type ListMachinePoolsResponse 

type ListMachinePoolsResponse struct {
	Data       []MachinePool `json:"data"`
	NextCursor *string       `json:"next_cursor"`
}

ListMachinePoolsResponse defines model for ListMachinePoolsResponse.

type ListMemoryFilesParams 

type ListMemoryFilesParams struct {
	// Path Literal path relative to the store root.
	Path *string `form:"path,omitempty" json:"path,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListMemoryFilesParams defines parameters for ListMemoryFiles.

type ListMemoryStoresParams 

type ListMemoryStoresParams struct {
	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListMemoryStoresParams defines parameters for ListMemoryStores.

type ListModelProviderConfigsParams 

type ListModelProviderConfigsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`
	Sort *ResourceListSort   `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListModelProviderConfigsParams defines parameters for ListModelProviderConfigs.

type ListOrgAPIKeysParams 

type ListOrgAPIKeysParams struct {
	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListOrgAPIKeysParams defines parameters for ListOrgAPIKeys.

type ListOrgAPIKeysResponse 

type ListOrgAPIKeysResponse struct {
	Data []OrgAPIKey `json:"data"`

	// NextCursor Opaque cursor for the next page, or null when this is the last page.
	NextCursor *string `json:"next_cursor"`
}

ListOrgAPIKeysResponse defines model for ListOrgAPIKeysResponse.

type ListOrgAgentProfilesParams 

type ListOrgAgentProfilesParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// IncludeStats Include each profile's `stats`, so a list can show instance counts and usage without a request per profile.
	IncludeStats *AgentProfileIncludeStats `form:"include_stats,omitempty" json:"include_stats,omitempty"`

	// StatsSince Start of the window `stats.usage` tallies, with `include_stats`. Omit to tally from the earliest recorded call.
	StatsSince *AgentProfileStatsSince `form:"stats_since,omitempty" json:"stats_since,omitempty"`
	Sort       *ResourceListSort       `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListOrgAgentProfilesParams defines parameters for ListOrgAgentProfiles.

type ListOrgAgentsParams 

type ListOrgAgentsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// AgentProfileID Return only agents launched from this agent profile.
	AgentProfileID *AgentProfileID `form:"agent_profile_id,omitempty" json:"agent_profile_id,omitempty"`

	// ParentAgentID Return only subagents spawned by this agent.
	ParentAgentID *AgentID `form:"parent_agent_id,omitempty" json:"parent_agent_id,omitempty"`

	// IncludeSubagents Include subagents alongside top-level agents. Defaults to false, so only agents without a parent are returned unless parent_agent_id is set.
	IncludeSubagents *bool `form:"include_subagents,omitempty" json:"include_subagents,omitempty"`

	// IncludeArchived Include archived agents. Defaults to false.
	IncludeArchived *bool `form:"include_archived,omitempty" json:"include_archived,omitempty"`

	// IncludeUsage Include each agent's `usage`, so a list can show costs without a request per agent.
	IncludeUsage *AgentIncludeUsage `form:"include_usage,omitempty" json:"include_usage,omitempty"`
	Sort         *ResourceListSort  `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListOrgAgentsParams defines parameters for ListOrgAgents.

type ListOrgIntegrationsParams 

type ListOrgIntegrationsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListOrgIntegrationsParams defines parameters for ListOrgIntegrations.

type ListOrgInvitationsParams 

type ListOrgInvitationsParams struct {
	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListOrgInvitationsParams defines parameters for ListOrgInvitations.

type ListOrgInvitationsResponse 

type ListOrgInvitationsResponse struct {
	Data []OrgInvitation `json:"data"`

	// NextCursor Opaque cursor for the next page, or null when this is the last page.
	NextCursor *string `json:"next_cursor"`
}

ListOrgInvitationsResponse defines model for ListOrgInvitationsResponse.

type ListOrgMembersParams 

type ListOrgMembersParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter      `form:"name,omitempty" json:"name,omitempty"`
	Sort *CreatedResourceListSort `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListOrgMembersParams defines parameters for ListOrgMembers.

type ListOrgMembersResponse 

type ListOrgMembersResponse struct {
	Data []OrgMember `json:"data"`

	// NextCursor Opaque cursor for the next page, or null when this is the last page.
	NextCursor *string `json:"next_cursor"`
}

ListOrgMembersResponse defines model for ListOrgMembersResponse.

type ListOrgMemoryStoresParams 

type ListOrgMemoryStoresParams struct {
	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListOrgMemoryStoresParams defines parameters for ListOrgMemoryStores.

type ListOrganizationsResponse 

type ListOrganizationsResponse struct {
	Data []CurrentUserOrg `json:"data"`
}

ListOrganizationsResponse defines model for ListOrganizationsResponse.

type ListPendingInvitationsParams 

type ListPendingInvitationsParams struct {
	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListPendingInvitationsParams defines parameters for ListPendingInvitations.

type ListPersonalAccessTokensParams 

type ListPersonalAccessTokensParams struct {
	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListPersonalAccessTokensParams defines parameters for ListPersonalAccessTokens.

type ListPersonalAccessTokensResponse 

type ListPersonalAccessTokensResponse struct {
	Data []PersonalAccessToken `json:"data"`

	// NextCursor Opaque cursor for the next page, or null when this is the last page.
	NextCursor *string `json:"next_cursor"`
}

ListPersonalAccessTokensResponse defines model for ListPersonalAccessTokensResponse.

type ListProjectAgentSessionsParams 

type ListProjectAgentSessionsParams struct {
	// AgentProfileID Only sessions of agents launched from this profile.
	AgentProfileID  *AgentProfileID `form:"agent_profile_id,omitempty" json:"agent_profile_id,omitempty"`
	IncludeArchived *bool           `form:"include_archived,omitempty" json:"include_archived,omitempty"`

	// IncludeDefault Also list each agent's default session.
	IncludeDefault *bool `form:"include_default,omitempty" json:"include_default,omitempty"`

	// IncludeSubagents Also list the sessions of subagents.
	IncludeSubagents *bool `form:"include_subagents,omitempty" json:"include_subagents,omitempty"`

	// Order Sort direction by creation time.
	Order *ListProjectAgentSessionsParamsOrder `form:"order,omitempty" json:"order,omitempty"`

	// AfterID Exclusive anchor: return the sessions that follow this session of the project in `order`. The anchor itself may be archived.
	AfterID *string `form:"after_id,omitempty" json:"after_id,omitempty"`
	Limit   *int32  `form:"limit,omitempty" json:"limit,omitempty"`
}

ListProjectAgentSessionsParams defines parameters for ListProjectAgentSessions.

type ListProjectAgentSessionsParamsOrder 

type ListProjectAgentSessionsParamsOrder string

ListProjectAgentSessionsParamsOrder defines parameters for ListProjectAgentSessions. 

const (
	ListProjectAgentSessionsParamsOrderAsc  ListProjectAgentSessionsParamsOrder = "asc"
	ListProjectAgentSessionsParamsOrderDesc ListProjectAgentSessionsParamsOrder = "desc"
)

Defines values for ListProjectAgentSessionsParamsOrder.

func (ListProjectAgentSessionsParamsOrder) Valid 

func (e ListProjectAgentSessionsParamsOrder) Valid() bool

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

type ListProjectAgentSessionsResponse 

type ListProjectAgentSessionsResponse struct {
	Data []AgentSession `json:"data"`

	// NextAfterID The `after_id` of the next page, or null on the last page.
	NextAfterID *string `json:"next_after_id"`
}

ListProjectAgentSessionsResponse defines model for ListProjectAgentSessionsResponse.

type ListProjectAvailableSecretsParams 

type ListProjectAvailableSecretsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// Kind Filter secrets by material kind.
	Kind *SecretKindFilter `form:"kind,omitempty" json:"kind,omitempty"`

	// OwnerKind Filter by the immutable owner kind.
	OwnerKind *ListProjectAvailableSecretsParamsOwnerKind `form:"owner_kind,omitempty" json:"owner_kind,omitempty"`

	// AvailabilitySource Filter a project inventory by how the secret became available.
	AvailabilitySource *ListProjectAvailableSecretsParamsAvailabilitySource `form:"availability_source,omitempty" json:"availability_source,omitempty"`

	// Metadata Metadata key/value filters, encoded as metadata[key]=value.
	Metadata *SecretMetadataFilter `json:"metadata,omitempty"`
	Sort     *ResourceListSort     `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListProjectAvailableSecretsParams defines parameters for ListProjectAvailableSecrets.

type ListProjectAvailableSecretsParamsAvailabilitySource 

type ListProjectAvailableSecretsParamsAvailabilitySource string

ListProjectAvailableSecretsParamsAvailabilitySource defines parameters for ListProjectAvailableSecrets. 

const (
	ListProjectAvailableSecretsParamsAvailabilitySourceDirect ListProjectAvailableSecretsParamsAvailabilitySource = "direct"
	ListProjectAvailableSecretsParamsAvailabilitySourceGrant  ListProjectAvailableSecretsParamsAvailabilitySource = "grant"
)

Defines values for ListProjectAvailableSecretsParamsAvailabilitySource.

func (ListProjectAvailableSecretsParamsAvailabilitySource) Valid 

func (e ListProjectAvailableSecretsParamsAvailabilitySource) Valid() bool

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

type ListProjectAvailableSecretsParamsOwnerKind 

type ListProjectAvailableSecretsParamsOwnerKind string

ListProjectAvailableSecretsParamsOwnerKind defines parameters for ListProjectAvailableSecrets. 

const (
	ListProjectAvailableSecretsParamsOwnerKindOrg     ListProjectAvailableSecretsParamsOwnerKind = "org"
	ListProjectAvailableSecretsParamsOwnerKindProject ListProjectAvailableSecretsParamsOwnerKind = "project"
	ListProjectAvailableSecretsParamsOwnerKindUser    ListProjectAvailableSecretsParamsOwnerKind = "user"
)

Defines values for ListProjectAvailableSecretsParamsOwnerKind.

func (ListProjectAvailableSecretsParamsOwnerKind) Valid 

func (e ListProjectAvailableSecretsParamsOwnerKind) Valid() bool

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

type ListProjectAvailableSkillsParams 

type ListProjectAvailableSkillsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// OwnerKind Filter by the immutable skill owner kind.
	OwnerKind *ListProjectAvailableSkillsParamsOwnerKind `form:"owner_kind,omitempty" json:"owner_kind,omitempty"`

	// AvailabilitySource Filter a project inventory by how the skill became available.
	AvailabilitySource *ListProjectAvailableSkillsParamsAvailabilitySource `form:"availability_source,omitempty" json:"availability_source,omitempty"`
	Sort               *ResourceListSort                                   `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListProjectAvailableSkillsParams defines parameters for ListProjectAvailableSkills.

type ListProjectAvailableSkillsParamsAvailabilitySource 

type ListProjectAvailableSkillsParamsAvailabilitySource string

ListProjectAvailableSkillsParamsAvailabilitySource defines parameters for ListProjectAvailableSkills. 

const (
	ListProjectAvailableSkillsParamsAvailabilitySourceDirect ListProjectAvailableSkillsParamsAvailabilitySource = "direct"
	ListProjectAvailableSkillsParamsAvailabilitySourceGrant  ListProjectAvailableSkillsParamsAvailabilitySource = "grant"
)

Defines values for ListProjectAvailableSkillsParamsAvailabilitySource.

func (ListProjectAvailableSkillsParamsAvailabilitySource) Valid 

func (e ListProjectAvailableSkillsParamsAvailabilitySource) Valid() bool

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

type ListProjectAvailableSkillsParamsOwnerKind 

type ListProjectAvailableSkillsParamsOwnerKind string

ListProjectAvailableSkillsParamsOwnerKind defines parameters for ListProjectAvailableSkills. 

const (
	ListProjectAvailableSkillsParamsOwnerKindOrg     ListProjectAvailableSkillsParamsOwnerKind = "org"
	ListProjectAvailableSkillsParamsOwnerKindProject ListProjectAvailableSkillsParamsOwnerKind = "project"
	ListProjectAvailableSkillsParamsOwnerKindUser    ListProjectAvailableSkillsParamsOwnerKind = "user"
)

Defines values for ListProjectAvailableSkillsParamsOwnerKind.

func (ListProjectAvailableSkillsParamsOwnerKind) Valid 

func (e ListProjectAvailableSkillsParamsOwnerKind) Valid() bool

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

type ListProjectMachineGrantsParams 

type ListProjectMachineGrantsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`
	Sort *ResourceListSort   `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListProjectMachineGrantsParams defines parameters for ListProjectMachineGrants.

type ListProjectMachineGrantsResponse 

type ListProjectMachineGrantsResponse struct {
	Data       []ProjectMachineGrantListItem `json:"data"`
	NextCursor *string                       `json:"next_cursor"`
}

ListProjectMachineGrantsResponse defines model for ListProjectMachineGrantsResponse.

type ListProjectMachinePoolGrantsParams 

type ListProjectMachinePoolGrantsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// MachinePoolID Return only the grant for this machine pool.
	MachinePoolID *MachinePoolID    `form:"machine_pool_id,omitempty" json:"machine_pool_id,omitempty"`
	Sort          *ResourceListSort `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListProjectMachinePoolGrantsParams defines parameters for ListProjectMachinePoolGrants.

type ListProjectMachinePoolGrantsResponse 

type ListProjectMachinePoolGrantsResponse struct {
	Data       []ProjectMachinePoolGrantListItem `json:"data"`
	NextCursor *string                           `json:"next_cursor"`
}

ListProjectMachinePoolGrantsResponse defines model for ListProjectMachinePoolGrantsResponse.

type ListProjectMembershipGrantsResponse 

type ListProjectMembershipGrantsResponse struct {
	Data []ProjectMembershipGrant `json:"data"`
}

ListProjectMembershipGrantsResponse defines model for ListProjectMembershipGrantsResponse.

type ListProjectModelGrantsParams 

type ListProjectModelGrantsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`
	Sort *ResourceListSort   `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListProjectModelGrantsParams defines parameters for ListProjectModelGrants.

type ListProjectModelGrantsResponse 

type ListProjectModelGrantsResponse struct {
	Data       []ProjectModelGrantListItem `json:"data"`
	NextCursor *string                     `json:"next_cursor"`
}

ListProjectModelGrantsResponse defines model for ListProjectModelGrantsResponse.

type ListProjectSecretAccessesResponse 

type ListProjectSecretAccessesResponse struct {
	Data       []ProjectSecretAccess `json:"data"`
	NextCursor *string               `json:"next_cursor"`
}

ListProjectSecretAccessesResponse defines model for ListProjectSecretAccessesResponse.

type ListProjectSkillAccessesResponse 

type ListProjectSkillAccessesResponse struct {
	Data       []ProjectSkillAccess `json:"data"`
	NextCursor *string              `json:"next_cursor"`
}

ListProjectSkillAccessesResponse defines model for ListProjectSkillAccessesResponse.

type ListProjectsResponse 

type ListProjectsResponse struct {
	Data []VisibleProject `json:"data"`

	// NextCursor Opaque cursor for the next page, or null when this is the last page.
	NextCursor *string `json:"next_cursor"`
}

ListProjectsResponse defines model for ListProjectsResponse.

type ListQueuedBacklogInputsParams 

type ListQueuedBacklogInputsParams struct {
	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListQueuedBacklogInputsParams defines parameters for ListQueuedBacklogInputs.

type ListSecretGrantsParams 

type ListSecretGrantsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter      `form:"name,omitempty" json:"name,omitempty"`
	Sort *CreatedResourceListSort `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListSecretGrantsParams defines parameters for ListSecretGrants.

type ListSecretGrantsResponse 

type ListSecretGrantsResponse struct {
	Data       []SecretGrantListItem `json:"data"`
	NextCursor *string               `json:"next_cursor"`
}

ListSecretGrantsResponse defines model for ListSecretGrantsResponse.

type ListSecretsParams 

type ListSecretsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// Kind Filter secrets by material kind.
	Kind *SecretKindFilter `form:"kind,omitempty" json:"kind,omitempty"`

	// OwnerKind Filter by the immutable owner kind.
	OwnerKind *ListSecretsParamsOwnerKind `form:"owner_kind,omitempty" json:"owner_kind,omitempty"`

	// OwnerProjectID Required with owner_kind=project and invalid with other owner kinds.
	OwnerProjectID *SecretOwnerProjectIDFilter `form:"owner_project_id,omitempty" json:"owner_project_id,omitempty"`

	// McpOauthFlowID Filter to secrets that have a version created by this MCP OAuth flow.
	McpOauthFlowID *SecretMCPOAuthFlowIDFilter `form:"mcp_oauth_flow_id,omitempty" json:"mcp_oauth_flow_id,omitempty"`

	// Metadata Metadata key/value filters, encoded as metadata[key]=value.
	Metadata *SecretMetadataFilter `json:"metadata,omitempty"`
	Sort     *ResourceListSort     `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListSecretsParams defines parameters for ListSecrets.

type ListSecretsParamsOwnerKind 

type ListSecretsParamsOwnerKind string

ListSecretsParamsOwnerKind defines parameters for ListSecrets. 

const (
	ListSecretsParamsOwnerKindOrg     ListSecretsParamsOwnerKind = "org"
	ListSecretsParamsOwnerKindProject ListSecretsParamsOwnerKind = "project"
	ListSecretsParamsOwnerKindUser    ListSecretsParamsOwnerKind = "user"
)

Defines values for ListSecretsParamsOwnerKind.

func (ListSecretsParamsOwnerKind) Valid 

func (e ListSecretsParamsOwnerKind) Valid() bool

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

type ListSecretsResponse 

type ListSecretsResponse struct {
	Data       []Secret `json:"data"`
	NextCursor *string  `json:"next_cursor"`
}

ListSecretsResponse defines model for ListSecretsResponse.

type ListSessionArtifactsParams 

type ListSessionArtifactsParams struct {
	// Limit Page size (1-100, default 20).
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor next_cursor from the previous page. Omit for the first page.
	Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListSessionArtifactsParams defines parameters for ListSessionArtifacts.

type ListSkillGrantsParams 

type ListSkillGrantsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter      `form:"name,omitempty" json:"name,omitempty"`
	Sort *CreatedResourceListSort `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListSkillGrantsParams defines parameters for ListSkillGrants.

type ListSkillGrantsResponse 

type ListSkillGrantsResponse struct {
	Data       []SkillGrantListItem `json:"data"`
	NextCursor *string              `json:"next_cursor"`
}

ListSkillGrantsResponse defines model for ListSkillGrantsResponse.

type ListSkillsParams 

type ListSkillsParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// OwnerKind Filter by the immutable skill owner kind.
	OwnerKind *ListSkillsParamsOwnerKind `form:"owner_kind,omitempty" json:"owner_kind,omitempty"`

	// OwnerProjectID Required with owner_kind=project and invalid with other owner kinds.
	OwnerProjectID *SkillOwnerProjectIDFilter `form:"owner_project_id,omitempty" json:"owner_project_id,omitempty"`
	Sort           *ResourceListSort          `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListSkillsParams defines parameters for ListSkills.

type ListSkillsParamsOwnerKind 

type ListSkillsParamsOwnerKind string

ListSkillsParamsOwnerKind defines parameters for ListSkills. 

const (
	ListSkillsParamsOwnerKindOrg     ListSkillsParamsOwnerKind = "org"
	ListSkillsParamsOwnerKindProject ListSkillsParamsOwnerKind = "project"
	ListSkillsParamsOwnerKindUser    ListSkillsParamsOwnerKind = "user"
)

Defines values for ListSkillsParamsOwnerKind.

func (ListSkillsParamsOwnerKind) Valid 

func (e ListSkillsParamsOwnerKind) Valid() bool

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

type ListSkillsResponse 

type ListSkillsResponse struct {
	Data       []Skill `json:"data"`
	NextCursor *string `json:"next_cursor"`
}

ListSkillsResponse defines model for ListSkillsResponse.

type ListTerminalSessionsResponse 

type ListTerminalSessionsResponse struct {
	Data []TerminalSession `json:"data"`
}

ListTerminalSessionsResponse defines model for ListTerminalSessionsResponse.

type ListToolCallsParams 

type ListToolCallsParams struct {
	State *ToolCallState `form:"state,omitempty" json:"state,omitempty"`
	Type  *ToolCallType  `form:"type,omitempty" json:"type,omitempty"`

	// IncludeSubagents Also return tool calls from this agent's subagents at every depth. Each row's agent_id says which agent made the call.
	IncludeSubagents *bool `form:"include_subagents,omitempty" json:"include_subagents,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListToolCallsParams defines parameters for ListToolCalls.

type ListToolCallsResponse 

type ListToolCallsResponse struct {
	Data       []ToolCall `json:"data"`
	NextCursor *string    `json:"next_cursor"`
}

ListToolCallsResponse defines model for ListToolCallsResponse.

type ListTurnEventsParams 

type ListTurnEventsParams struct {
	// SessionID Agent session ID (ses_...). Omit to use the agent's default session.
	SessionID *string `form:"session_id,omitempty" json:"session_id,omitempty"`

	// BeforeSequence Exclusive event sequence boundary. Omit or pass 0 for the latest events in the turn.
	BeforeSequence *int64 `form:"before_sequence,omitempty" json:"before_sequence,omitempty"`

	// Limit Maximum number of events to return.
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}

ListTurnEventsParams defines parameters for ListTurnEvents.

type ListTurnEventsResponse 

type ListTurnEventsResponse struct {
	Data []AgentEvent `json:"data"`

	// NextBeforeSequence Pass this value as before_sequence to fetch older events, or null when this page reached the beginning of the turn.
	NextBeforeSequence *AgentSequenceCursor `json:"next_before_sequence"`
}

ListTurnEventsResponse defines model for ListTurnEventsResponse.

type ListTurnsParams 

type ListTurnsParams struct {
	// SessionID Agent session ID (ses_...). Omit to use the agent's default session.
	SessionID *string `form:"session_id,omitempty" json:"session_id,omitempty"`

	// BeforeTurnSequence Exclusive turn sequence boundary. Omit or pass 0 for the newest turns.
	BeforeTurnSequence *int64 `form:"before_turn_sequence,omitempty" json:"before_turn_sequence,omitempty"`

	// Limit Maximum number of turns to return.
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}

ListTurnsParams defines parameters for ListTurns.

type ListVisibleMachinesParams 

type ListVisibleMachinesParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// SourceKind Filter machines by source kind. Omit to include both BYO and pooled machines.
	SourceKind *MachineSourceKindFilter `form:"source_kind,omitempty" json:"source_kind,omitempty"`

	// MachinePoolID Return only machines provisioned by this machine pool.
	MachinePoolID *MachinePoolID    `form:"machine_pool_id,omitempty" json:"machine_pool_id,omitempty"`
	Sort          *ResourceListSort `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListVisibleMachinesParams defines parameters for ListVisibleMachines.

type ListVisibleMachinesResponse 

type ListVisibleMachinesResponse struct {
	Data       []VisibleMachine `json:"data"`
	NextCursor *string          `json:"next_cursor"`
}

ListVisibleMachinesResponse defines model for ListVisibleMachinesResponse.

type ListVisibleProjectMachinesParams 

type ListVisibleProjectMachinesParams struct {
	// Name Case-insensitive glob over the list's logical name. `*` matches zero or more characters, `?` matches one character, and `\` escapes a wildcard.
	Name *ResourceNameFilter `form:"name,omitempty" json:"name,omitempty"`

	// SourceKind Filter machines by source kind. Omit to include both BYO and pooled machines.
	SourceKind *MachineSourceKindFilter `form:"source_kind,omitempty" json:"source_kind,omitempty"`

	// MachinePoolID Return only machines provisioned by this machine pool.
	MachinePoolID *MachinePoolID    `form:"machine_pool_id,omitempty" json:"machine_pool_id,omitempty"`
	Sort          *ResourceListSort `form:"sort,omitempty" json:"sort,omitempty"`

	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListVisibleProjectMachinesParams defines parameters for ListVisibleProjectMachines.

type ListVisibleProjectsParams 

type ListVisibleProjectsParams struct {
	// Limit Maximum number of items to return in one page.
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty"`

	// Cursor Opaque pagination cursor from a previous response's next_cursor. Omit for the first page.
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty"`
}

ListVisibleProjectsParams defines parameters for ListVisibleProjects.

type MCPConnectionOrigin 

type MCPConnectionOrigin string

MCPConnectionOrigin Who connects an MCP server. `environment` means the executor starts or connects it in its own credential scope; `service` means the harness connects it and keeps its credentials. 

const (
	Environment MCPConnectionOrigin = "environment"
	Service     MCPConnectionOrigin = "service"
)

Defines values for MCPConnectionOrigin.

func (MCPConnectionOrigin) Valid 

func (e MCPConnectionOrigin) Valid() bool

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

type MCPOAuthFlowID 

type MCPOAuthFlowID = string

MCPOAuthFlowID defines model for MCPOAuthFlowID.

type MCPOAuthStartMetadata 

type MCPOAuthStartMetadata map[string]string

MCPOAuthStartMetadata User-supplied metadata for the stored secret. A restriction of Metadata that leaves room for one reserved pair - BMA sets mcp_url on the secret to the flow's MCP endpoint URL, so the key is reserved and at most 15 user pairs are accepted.

type MCPOAuthStartRequest 

type MCPOAuthStartRequest struct {
	ClientID     *string `json:"client_id,omitempty"`
	ClientSecret *string `json:"client_secret,omitempty"`
	McpURL       string  `json:"mcp_url"`

	// Metadata User-supplied metadata for the stored secret. A restriction of Metadata that leaves room for one reserved pair - BMA sets mcp_url on the secret to the flow's MCP endpoint URL, so the key is reserved and at most 15 user pairs are accepted.
	Metadata *MCPOAuthStartMetadata `json:"metadata,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`

	// Owner Who owns the secret: {"kind":"org"}, {"kind":"project","project_id":"proj_..."}, or {"kind":"user"}. The owner cannot change later.
	Owner    SecretOwnerInput `json:"owner"`
	ReturnTo *string          `json:"return_to,omitempty"`
	Scopes   *[]string        `json:"scopes,omitempty"`
}

MCPOAuthStartRequest defines model for MCPOAuthStartRequest.

type MCPOAuthStartResponse 

type MCPOAuthStartResponse struct {
	AuthorizationURL string         `json:"authorization_url"`
	ExpiresAt        Timestamp      `json:"expires_at"`
	FlowID           MCPOAuthFlowID `json:"flow_id"`
}

MCPOAuthStartResponse defines model for MCPOAuthStartResponse.

type MCPRegistryHeader 

type MCPRegistryHeader struct {
	Description *string `json:"description,omitempty"`
	IsRequired  bool    `json:"is_required"`
	IsSecret    bool    `json:"is_secret"`
	Name        string  `json:"name"`
}

MCPRegistryHeader defines model for MCPRegistryHeader.

type MCPRegistryIcon 

type MCPRegistryIcon struct {
	MimeType *string `json:"mime_type,omitempty"`

	// Sizes Icon sizes as `WxH` strings, or `any` for scalable images.
	Sizes *[]string `json:"sizes,omitempty"`

	// Src Absolute https URL of the icon image.
	Src string `json:"src"`

	// Theme Theme the icon is intended for, `light` or `dark`, when the publisher specifies one.
	Theme *string `json:"theme,omitempty"`
}

MCPRegistryIcon defines model for MCPRegistryIcon.

type MCPRegistryRemote 

type MCPRegistryRemote struct {
	Headers *[]MCPRegistryHeader `json:"headers,omitempty"`

	// Type Transport type as published in the registry. Always `streamable-http`; other transports are dropped when the snapshot is built.
	Type string `json:"type"`
	URL  string `json:"url"`
}

MCPRegistryRemote defines model for MCPRegistryRemote.

type MCPRegistryServer 

type MCPRegistryServer struct {
	Description string            `json:"description"`
	Icons       []MCPRegistryIcon `json:"icons"`

	// Name Reverse-DNS registry name, for example `io.github.owner/server`.
	Name       string              `json:"name"`
	Remotes    []MCPRegistryRemote `json:"remotes"`
	Status     string              `json:"status"`
	Title      *string             `json:"title,omitempty"`
	UpdatedAt  time.Time           `json:"updated_at"`
	Version    string              `json:"version"`
	WebsiteURL *string             `json:"website_url,omitempty"`
}

MCPRegistryServer defines model for MCPRegistryServer.

type MCPServerAuth 

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

MCPServerAuth How BMA authenticates to the MCP server. Secret references must be available to the project, either owned by it or granted to it.

func (MCPServerAuth) AsAny 

func (t MCPServerAuth) AsAny() any

AsAny returns the member of MCPServerAuth named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (MCPServerAuth) AsMCPServerAuthBearer 

func (t MCPServerAuth) AsMCPServerAuthBearer() (MCPServerAuthBearer, error)

AsMCPServerAuthBearer returns the union data inside the MCPServerAuth as a MCPServerAuthBearer

func (MCPServerAuth) AsMCPServerAuthNone 

func (t MCPServerAuth) AsMCPServerAuthNone() (MCPServerAuthNone, error)

AsMCPServerAuthNone returns the union data inside the MCPServerAuth as a MCPServerAuthNone

func (MCPServerAuth) AsMCPServerAuthOAuth 

func (t MCPServerAuth) AsMCPServerAuthOAuth() (MCPServerAuthOAuth, error)

AsMCPServerAuthOAuth returns the union data inside the MCPServerAuth as a MCPServerAuthOAuth

func (MCPServerAuth) AsMCPServerAuthSigV4 

func (t MCPServerAuth) AsMCPServerAuthSigV4() (MCPServerAuthSigV4, error)

AsMCPServerAuthSigV4 returns the union data inside the MCPServerAuth as a MCPServerAuthSigV4

func (MCPServerAuth) Discriminator 

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

func (*MCPServerAuth) FromMCPServerAuthBearer 

func (t *MCPServerAuth) FromMCPServerAuthBearer(v MCPServerAuthBearer) error

FromMCPServerAuthBearer overwrites any union data inside the MCPServerAuth as the provided MCPServerAuthBearer

func (*MCPServerAuth) FromMCPServerAuthNone 

func (t *MCPServerAuth) FromMCPServerAuthNone(v MCPServerAuthNone) error

FromMCPServerAuthNone overwrites any union data inside the MCPServerAuth as the provided MCPServerAuthNone

func (*MCPServerAuth) FromMCPServerAuthOAuth 

func (t *MCPServerAuth) FromMCPServerAuthOAuth(v MCPServerAuthOAuth) error

FromMCPServerAuthOAuth overwrites any union data inside the MCPServerAuth as the provided MCPServerAuthOAuth

func (*MCPServerAuth) FromMCPServerAuthSigV4 

func (t *MCPServerAuth) FromMCPServerAuthSigV4(v MCPServerAuthSigV4) error

FromMCPServerAuthSigV4 overwrites any union data inside the MCPServerAuth as the provided MCPServerAuthSigV4

func (MCPServerAuth) MarshalJSON 

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

func (*MCPServerAuth) MergeMCPServerAuthBearer 

func (t *MCPServerAuth) MergeMCPServerAuthBearer(v MCPServerAuthBearer) error

MergeMCPServerAuthBearer performs a merge with any union data inside the MCPServerAuth, using the provided MCPServerAuthBearer

func (*MCPServerAuth) MergeMCPServerAuthNone 

func (t *MCPServerAuth) MergeMCPServerAuthNone(v MCPServerAuthNone) error

MergeMCPServerAuthNone performs a merge with any union data inside the MCPServerAuth, using the provided MCPServerAuthNone

func (*MCPServerAuth) MergeMCPServerAuthOAuth 

func (t *MCPServerAuth) MergeMCPServerAuthOAuth(v MCPServerAuthOAuth) error

MergeMCPServerAuthOAuth performs a merge with any union data inside the MCPServerAuth, using the provided MCPServerAuthOAuth

func (*MCPServerAuth) MergeMCPServerAuthSigV4 

func (t *MCPServerAuth) MergeMCPServerAuthSigV4(v MCPServerAuthSigV4) error

MergeMCPServerAuthSigV4 performs a merge with any union data inside the MCPServerAuth, using the provided MCPServerAuthSigV4

func (*MCPServerAuth) UnmarshalJSON 

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

func (MCPServerAuth) ValueByDiscriminator 

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

type MCPServerAuthBearer 

type MCPServerAuthBearer struct {
	// SecretID Secret ID (sec_...).
	SecretID SecretID                `json:"secret_id"`
	Type     MCPServerAuthBearerType `json:"type"`
}

MCPServerAuthBearer defines model for MCPServerAuthBearer.

type MCPServerAuthBearerType 

type MCPServerAuthBearerType string

MCPServerAuthBearerType defines model for MCPServerAuthBearer.Type. 

const (
	MCPServerAuthBearerTypeBearer MCPServerAuthBearerType = "bearer"
)

Defines values for MCPServerAuthBearerType.

func (MCPServerAuthBearerType) Valid 

func (e MCPServerAuthBearerType) Valid() bool

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

type MCPServerAuthHint 

type MCPServerAuthHint struct {
	// AuthorizationServer Issuer URL of the OAuth authorization server, when advertised.
	AuthorizationServer *string `json:"authorization_server,omitempty"`

	// Scopes Scopes the server requested or supports, when advertised.
	Scopes *[]string `json:"scopes,omitempty"`

	// Type `oauth` when the server advertises an OAuth authorization server per the MCP authorization spec; `bearer` when it rejects unauthenticated requests without OAuth metadata, which usually means a static API token.
	Type MCPServerAuthHintType `json:"type"`
}

MCPServerAuthHint defines model for MCPServerAuthHint.

type MCPServerAuthHintType 

type MCPServerAuthHintType string

MCPServerAuthHintType `oauth` when the server advertises an OAuth authorization server per the MCP authorization spec; `bearer` when it rejects unauthenticated requests without OAuth metadata, which usually means a static API token. 

const (
	MCPServerAuthHintTypeBearer MCPServerAuthHintType = "bearer"
	MCPServerAuthHintTypeOauth  MCPServerAuthHintType = "oauth"
)

Defines values for MCPServerAuthHintType.

func (MCPServerAuthHintType) Valid 

func (e MCPServerAuthHintType) Valid() bool

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

type MCPServerAuthNone 

type MCPServerAuthNone struct {
	Type MCPServerAuthNoneType `json:"type"`
}

MCPServerAuthNone defines model for MCPServerAuthNone.

type MCPServerAuthNoneType 

type MCPServerAuthNoneType string

MCPServerAuthNoneType defines model for MCPServerAuthNone.Type. 

const (
	MCPServerAuthNoneTypeNone MCPServerAuthNoneType = "none"
)

Defines values for MCPServerAuthNoneType.

func (MCPServerAuthNoneType) Valid 

func (e MCPServerAuthNoneType) Valid() bool

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

type MCPServerAuthOAuth 

type MCPServerAuthOAuth struct {
	// SecretID Secret ID (sec_...).
	SecretID SecretID               `json:"secret_id"`
	Type     MCPServerAuthOAuthType `json:"type"`
}

MCPServerAuthOAuth defines model for MCPServerAuthOAuth.

type MCPServerAuthOAuthType 

type MCPServerAuthOAuthType string

MCPServerAuthOAuthType defines model for MCPServerAuthOAuth.Type. 

const (
	Oauth MCPServerAuthOAuthType = "oauth"
)

Defines values for MCPServerAuthOAuthType.

func (MCPServerAuthOAuthType) Valid 

func (e MCPServerAuthOAuthType) Valid() bool

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

type MCPServerAuthRequiredError 

type MCPServerAuthRequiredError struct {
	Auth *MCPServerAuthHint             `json:"auth,omitempty"`
	Code MCPServerAuthRequiredErrorCode `json:"code"`

	// Error Human-readable error message. Do not match on it programmatically.
	Error string `json:"error"`
}

MCPServerAuthRequiredError defines model for MCPServerAuthRequiredError.

type MCPServerAuthRequiredErrorCode 

type MCPServerAuthRequiredErrorCode string

MCPServerAuthRequiredErrorCode defines model for MCPServerAuthRequiredError.Code. 

const (
	MCPServerAuthRequiredErrorCodeUnprocessable MCPServerAuthRequiredErrorCode = "unprocessable"
)

Defines values for MCPServerAuthRequiredErrorCode.

func (MCPServerAuthRequiredErrorCode) Valid 

func (e MCPServerAuthRequiredErrorCode) Valid() bool

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

type MCPServerAuthSigV4 

type MCPServerAuthSigV4 struct {
	// Region AWS signing region, for example `us-east-1`.
	Region string `json:"region"`

	// SecretID Secret ID (sec_...).
	SecretID SecretID `json:"secret_id"`

	// Service AWS signing service name, for example `bedrock-agentcore`.
	Service string                 `json:"service"`
	Type    MCPServerAuthSigV4Type `json:"type"`
}

MCPServerAuthSigV4 defines model for MCPServerAuthSigV4.

type MCPServerAuthSigV4Type 

type MCPServerAuthSigV4Type string

MCPServerAuthSigV4Type defines model for MCPServerAuthSigV4.Type. 

const (
	Sigv4 MCPServerAuthSigV4Type = "sigv4"
)

Defines values for MCPServerAuthSigV4Type.

func (MCPServerAuthSigV4Type) Valid 

func (e MCPServerAuthSigV4Type) Valid() bool

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

type MCPServerInfo 

type MCPServerInfo struct {
	Description *string `json:"description,omitempty"`
	Name        string  `json:"name"`
	Title       *string `json:"title,omitempty"`
	Version     string  `json:"version"`
	WebsiteURL  *string `json:"website_url,omitempty"`
}

MCPServerInfo defines model for MCPServerInfo.

type MCPServerListParams 

type MCPServerListParams struct {
	Q         *string
	RemoteURL *string
	Limit     *PageLimit
	Cursor    *PageCursor
}

MCPServerListParams are the query, header and body fields of listMCPServers.

type MCPServerService 

type MCPServerService struct {
	Tools *MCPServerToolService
	// contains filtered or unexported fields
}

MCPServerService groups the mcpServers methods.

func (*MCPServerService) List 

func (s *MCPServerService) List(ctx context.Context, params MCPServerListParams, opts ...option.RequestOption) (*CursorPage[MCPRegistryServer], error)

List calls listMCPServers: GET /mcp-servers.

func (*MCPServerService) ListAutoPaging 

func (s *MCPServerService) ListAutoPaging(ctx context.Context, params MCPServerListParams, opts ...option.RequestOption) *CursorPageAutoPager[MCPRegistryServer]

ListAutoPaging iterates every item of listMCPServers across pages.

type MCPServerTool 

type MCPServerTool struct {
	Annotations *MCPServerToolAnnotations `json:"annotations,omitempty"`
	Description *string                   `json:"description,omitempty"`

	// InputSchema JSON Schema for the tool's arguments.
	InputSchema map[string]interface{} `json:"input_schema"`

	// Name Tool name as advertised by the server. Referenced from agent config `mcp_servers.<key>.tools.<name>`.
	Name string `json:"name"`

	// OutputSchema JSON Schema for the tool's structured result, when the server advertises one.
	OutputSchema *map[string]interface{} `json:"output_schema,omitempty"`
	Title        *string                 `json:"title,omitempty"`
}

MCPServerTool defines model for MCPServerTool.

type MCPServerToolAnnotations 

type MCPServerToolAnnotations struct {
	DestructiveHint *bool   `json:"destructive_hint,omitempty"`
	IdempotentHint  *bool   `json:"idempotent_hint,omitempty"`
	OpenWorldHint   *bool   `json:"open_world_hint,omitempty"`
	ReadOnlyHint    *bool   `json:"read_only_hint,omitempty"`
	Title           *string `json:"title,omitempty"`
}

MCPServerToolAnnotations defines model for MCPServerToolAnnotations.

type MCPServerToolListParams 

type MCPServerToolListParams struct {
	Auth MCPServerAuth
	URL  string
}

MCPServerToolListParams are the query, header and body fields of listMCPServerTools.

type MCPServerToolService 

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

MCPServerToolService groups the mcpServers.tools methods.

func (*MCPServerToolService) List 

func (s *MCPServerToolService) List(ctx context.Context, params MCPServerToolListParams, opts ...option.RequestOption) (*MCPServerToolsResponse, error)

List calls listMCPServerTools: POST /orgs/{orgID}/projects/{projectID}/mcp-servers/tools.

type MCPServerToolsRequest 

type MCPServerToolsRequest struct {
	// Auth How BMA authenticates to the MCP server. Secret references must be available to the project, either owned by it or granted to it.
	Auth MCPServerAuth `json:"auth"`

	// URL Streamable HTTP MCP endpoint. Must use HTTPS, except that HTTP is allowed for loopback hosts during local development.
	URL string `json:"url"`
}

MCPServerToolsRequest defines model for MCPServerToolsRequest.

type MCPServerToolsResponse 

type MCPServerToolsResponse struct {
	// ProtocolVersion MCP protocol version negotiated with the server.
	ProtocolVersion string          `json:"protocol_version"`
	ServerInfo      MCPServerInfo   `json:"server_info"`
	Tools           []MCPServerTool `json:"tools"`
}

MCPServerToolsResponse defines model for MCPServerToolsResponse.

type MCPTransportType 

type MCPTransportType string

MCPTransportType Transport of an MCP server. 

const (
	HTTP  MCPTransportType = "http"
	Stdio MCPTransportType = "stdio"
)

Defines values for MCPTransportType.

func (MCPTransportType) Valid 

func (e MCPTransportType) Valid() bool

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

type Machine 

type Machine struct {
	ConnectionState       MachineConnectionState `json:"connection_state"`
	ConnectionStateReason *string                `json:"connection_state_reason,omitempty"`
	CreatedAt             Timestamp              `json:"created_at"`
	Cwd                   string                 `json:"cwd"`
	DeleteAttempts        int32                  `json:"delete_attempts"`
	DeletedAt             *Timestamp             `json:"deleted_at"`
	Description           string                 `json:"description"`

	// DisplayName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	DisplayName ResourceName      `json:"display_name"`
	Env         map[string]string `json:"env"`

	// FailureReport The machine's most recent daemon-reported failure. A single slot, overwritten by newer reports. Runtime crash reports remain as historical diagnostics; recovery may clear other failure stages.
	FailureReport *MachineFailureReport `json:"failure_report,omitempty"`

	// ID Machine ID (mch_...).
	ID                     MachineID             `json:"id"`
	LastObservedAt         *Timestamp            `json:"last_observed_at"`
	LifecycleReasonCode    string                `json:"lifecycle_reason_code"`
	LifecycleReasonMessage string                `json:"lifecycle_reason_message"`
	LifecycleState         MachineLifecycleState `json:"lifecycle_state"`
	MachinePoolID          *MachinePoolID        `json:"machine_pool_id,omitempty"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata           Metadata       `json:"metadata"`
	NextReconcileAfter *Timestamp     `json:"next_reconcile_after"`
	OrgID              OrganizationID `json:"org_id"`

	// PowerState Compute state of a pool machine. paused keeps the disk (and memory when the provider supports it) without compute; resuming means a resume or restore is in flight; archived means the machine image is stored durably and is restored on the next access.
	PowerState        *MachinePowerState  `json:"power_state,omitempty"`
	Provider          string              `json:"provider"`
	ProvisionAttempts int32               `json:"provision_attempts"`
	SecretEnv         map[string]SecretID `json:"secret_env"`
	SourceKind        MachineSourceKind   `json:"source_kind"`
	UpdatedAt         Timestamp           `json:"updated_at"`
}

Machine defines model for Machine.

type MachineAccess 

type MachineAccess struct {
	CanManage bool                  `json:"can_manage"`
	Sources   []MachineAccessSource `json:"sources"`
}

MachineAccess defines model for MachineAccess.

type MachineAccessSource 

type MachineAccessSource struct {
	GrantID         *ProjectMachineGrantID         `json:"grant_id,omitempty"`
	GrantSourceKind *ProjectMachineGrantSourceKind `json:"grant_source_kind,omitempty"`
	Kind            MachineAccessSourceKind        `json:"kind"`

	// ProjectID Project ID (proj_...).
	ProjectID *ProjectID `json:"project_id,omitempty"`
}

MachineAccessSource defines model for MachineAccessSource.

type MachineAccessSourceKind 

type MachineAccessSourceKind string

MachineAccessSourceKind defines model for MachineAccessSourceKind. 

const (
	MachineAccessSourceKindOrganizationRole    MachineAccessSourceKind = "org_role"
	MachineAccessSourceKindProjectMachineGrant MachineAccessSourceKind = "project_machine_grant"
)

Defines values for MachineAccessSourceKind.

func (MachineAccessSourceKind) Valid 

func (e MachineAccessSourceKind) Valid() bool

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

type MachineBackup 

type MachineBackup struct {
	CompletedAt *Timestamp `json:"completed_at"`
	CreatedAt   Timestamp  `json:"created_at"`

	// Digest SHA-256 digest of the tar+zstd archive; set once ready.
	Digest *string `json:"digest"`

	// Error Why a failed backup failed; empty otherwise.
	Error   string   `json:"error"`
	Exclude []string `json:"exclude"`
	ID      string   `json:"id"`

	// MachineID Machine ID (mch_...).
	MachineID MachineID `json:"machine_id"`
	Paths     []string  `json:"paths"`

	// Reason What took the backup.
	Reason MachineBackupReason `json:"reason"`

	// SizeBytes Archive size; set once ready.
	SizeBytes *int64             `json:"size_bytes"`
	State     MachineBackupState `json:"state"`
}

MachineBackup defines model for MachineBackup.

type MachineBackupReason 

type MachineBackupReason string

MachineBackupReason What took the backup. 

const (
	MachineBackupReasonManual   MachineBackupReason = "manual"
	MachineBackupReasonPause    MachineBackupReason = "pause"
	MachineBackupReasonPeriodic MachineBackupReason = "periodic"
)

Defines values for MachineBackupReason.

func (MachineBackupReason) Valid 

func (e MachineBackupReason) Valid() bool

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

type MachineBackupService 

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

MachineBackupService groups the machines.backups methods.

func (*MachineBackupService) List 

func (s *MachineBackupService) List(ctx context.Context, machineID string, opts ...option.RequestOption) (*ListMachineBackupsResponse, error)

List calls listMachineBackups: GET /orgs/{orgID}/projects/{projectID}/machines/{machineID}/backups.

func (*MachineBackupService) New 

func (s *MachineBackupService) New(ctx context.Context, machineID string, opts ...option.RequestOption) (*MachineBackup, error)

New calls createMachineBackup: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/backups.

type MachineBackupState 

type MachineBackupState string

MachineBackupState defines model for MachineBackup.State. 

const (
	MachineBackupStateFailed    MachineBackupState = "failed"
	MachineBackupStateReady     MachineBackupState = "ready"
	MachineBackupStateUploading MachineBackupState = "uploading"
)

Defines values for MachineBackupState.

func (MachineBackupState) Valid 

func (e MachineBackupState) Valid() bool

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

type MachineCapabilities 

type MachineCapabilities struct {
	Desktop MachineDesktopCapability `json:"desktop"`

	// MachineID Machine ID (mch_...).
	MachineID        MachineID                     `json:"machine_id"`
	Permissions      MachineInteractionPermissions `json:"permissions"`
	ProtocolVersions MachineProtocolVersions       `json:"protocol_versions"`
	Terminal         MachineTerminalCapability     `json:"terminal"`
}

MachineCapabilities defines model for MachineCapabilities.

type MachineConnectionState 

type MachineConnectionState string

MachineConnectionState defines model for MachineConnectionState. 

const (
	MachineConnectionStateAsleep  MachineConnectionState = "asleep"
	MachineConnectionStateOffline MachineConnectionState = "offline"
	MachineConnectionStateOnline  MachineConnectionState = "online"
)

Defines values for MachineConnectionState.

func (MachineConnectionState) Valid 

func (e MachineConnectionState) Valid() bool

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

type MachineDaemonToken 

type MachineDaemonToken struct {
	CreatedAt  Timestamp            `json:"created_at"`
	ID         MachineDaemonTokenID `json:"id"`
	LastUsedAt *Timestamp           `json:"last_used_at"`

	// MachineID Machine ID (mch_...).
	MachineID MachineID `json:"machine_id"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata Metadata `json:"metadata"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name         ResourceName   `json:"name"`
	OrgID        OrganizationID `json:"org_id"`
	RevokeReason string         `json:"revoke_reason"`
	RevokedAt    *Timestamp     `json:"revoked_at"`
}

MachineDaemonToken defines model for MachineDaemonToken.

type MachineDaemonTokenID 

type MachineDaemonTokenID = string

MachineDaemonTokenID defines model for MachineDaemonTokenID.

type MachineDesktopCapability 

type MachineDesktopCapability struct {
	// Reason Why desktop access is unavailable, when supported is false.
	Reason    *string `json:"reason,omitempty"`
	Rfb       bool    `json:"rfb"`
	Supported bool    `json:"supported"`
	Webrtc    bool    `json:"webrtc"`
}

MachineDesktopCapability defines model for MachineDesktopCapability.

type MachineDesktopSessionAgentConfirmActionParams 

type MachineDesktopSessionAgentConfirmActionParams struct {
	Generation int64
}

MachineDesktopSessionAgentConfirmActionParams are the query, header and body fields of confirmDesktopAction.

type MachineDesktopSessionAgentResumeParams 

type MachineDesktopSessionAgentResumeParams struct {
	Generation int64
}

MachineDesktopSessionAgentResumeParams are the query, header and body fields of resumeDesktopAgent.

type MachineDesktopSessionAgentService 

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

MachineDesktopSessionAgentService groups the machines.desktopSessions.agent methods.

func (*MachineDesktopSessionAgentService) ConfirmAction 

func (s *MachineDesktopSessionAgentService) ConfirmAction(ctx context.Context, machineID string, desktopSessionID string, pendingID string, params MachineDesktopSessionAgentConfirmActionParams, opts ...option.RequestOption) (*DesktopActionResponse, error)

ConfirmAction calls confirmDesktopAction: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions/{desktopSessionID}/agent/actions/{pendingID}/confirm.

func (*MachineDesktopSessionAgentService) Observe 

func (s *MachineDesktopSessionAgentService) Observe(ctx context.Context, machineID string, desktopSessionID string, opts ...option.RequestOption) (*DesktopObservation, error)

Observe calls observeDesktop: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions/{desktopSessionID}/agent/observe.

func (*MachineDesktopSessionAgentService) Resume 

func (s *MachineDesktopSessionAgentService) Resume(ctx context.Context, machineID string, desktopSessionID string, params MachineDesktopSessionAgentResumeParams, opts ...option.RequestOption) (*DesktopControlStatus, error)

Resume calls resumeDesktopAgent: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions/{desktopSessionID}/agent/resume.

func (*MachineDesktopSessionAgentService) SubmitAction 

func (s *MachineDesktopSessionAgentService) SubmitAction(ctx context.Context, machineID string, desktopSessionID string, params MachineDesktopSessionAgentSubmitActionParams, opts ...option.RequestOption) (*DesktopPending, error)

SubmitAction calls submitDesktopAction: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions/{desktopSessionID}/agent/actions.

type MachineDesktopSessionAgentSubmitActionParams 

type MachineDesktopSessionAgentSubmitActionParams struct {
	Action     DesktopAction
	Generation int64
}

MachineDesktopSessionAgentSubmitActionParams are the query, header and body fields of submitDesktopAction.

type MachineDesktopSessionControlAcquireParams 

type MachineDesktopSessionControlAcquireParams struct {
	LeaseSeconds *int32
}

MachineDesktopSessionControlAcquireParams are the query, header and body fields of acquireDesktopControl.

type MachineDesktopSessionControlRenewParams 

type MachineDesktopSessionControlRenewParams struct {
	LeaseSeconds *int32
}

MachineDesktopSessionControlRenewParams are the query, header and body fields of renewDesktopControl.

type MachineDesktopSessionControlService 

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

MachineDesktopSessionControlService groups the machines.desktopSessions.control methods.

func (*MachineDesktopSessionControlService) Acquire 

func (s *MachineDesktopSessionControlService) Acquire(ctx context.Context, machineID string, desktopSessionID string, params MachineDesktopSessionControlAcquireParams, opts ...option.RequestOption) (*DesktopControlStatus, error)

Acquire calls acquireDesktopControl: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions/{desktopSessionID}/control/acquire.

func (*MachineDesktopSessionControlService) Get 

func (s *MachineDesktopSessionControlService) Get(ctx context.Context, machineID string, desktopSessionID string, opts ...option.RequestOption) (*DesktopControlStatus, error)

Get calls getDesktopControl: GET /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions/{desktopSessionID}/control.

func (*MachineDesktopSessionControlService) Handback 

func (s *MachineDesktopSessionControlService) Handback(ctx context.Context, machineID string, desktopSessionID string, opts ...option.RequestOption) (*DesktopControlStatus, error)

Handback calls handbackDesktopControl: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions/{desktopSessionID}/control/handback.

func (*MachineDesktopSessionControlService) Release 

func (s *MachineDesktopSessionControlService) Release(ctx context.Context, machineID string, desktopSessionID string, opts ...option.RequestOption) (*DesktopControlStatus, error)

Release calls releaseDesktopControl: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions/{desktopSessionID}/control/release.

func (*MachineDesktopSessionControlService) Renew 

func (s *MachineDesktopSessionControlService) Renew(ctx context.Context, machineID string, desktopSessionID string, params MachineDesktopSessionControlRenewParams, opts ...option.RequestOption) (*DesktopControlStatus, error)

Renew calls renewDesktopControl: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions/{desktopSessionID}/control/renew.

type MachineDesktopSessionNewParams 

type MachineDesktopSessionNewParams struct {
	AgentID      *AgentID
	Capabilities *DesktopCapabilitiesRequest
	LeaseSeconds *int32
	ReadOnly     *bool
}

MachineDesktopSessionNewParams are the query, header and body fields of createDesktopSession.

type MachineDesktopSessionSendActionsParams 

type MachineDesktopSessionSendActionsParams struct {
	Action DesktopAction
	Seq    int64
}

MachineDesktopSessionSendActionsParams are the query, header and body fields of sendDesktopActions.

type MachineDesktopSessionService 

type MachineDesktopSessionService struct {
	Control *MachineDesktopSessionControlService
	Agent   *MachineDesktopSessionAgentService
	// contains filtered or unexported fields
}

MachineDesktopSessionService groups the machines.desktopSessions methods.

func (*MachineDesktopSessionService) Close 

func (s *MachineDesktopSessionService) Close(ctx context.Context, machineID string, desktopSessionID string, opts ...option.RequestOption) error

Close calls closeDesktopSession: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions/{desktopSessionID}/close.

func (*MachineDesktopSessionService) Get 

func (s *MachineDesktopSessionService) Get(ctx context.Context, machineID string, desktopSessionID string, opts ...option.RequestOption) (*DesktopSession, error)

Get calls getDesktopSession: GET /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions/{desktopSessionID}.

func (*MachineDesktopSessionService) New 

func (s *MachineDesktopSessionService) New(ctx context.Context, machineID string, params MachineDesktopSessionNewParams, opts ...option.RequestOption) (*DesktopSession, error)

New calls createDesktopSession: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions.

func (*MachineDesktopSessionService) Screenshot 

func (s *MachineDesktopSessionService) Screenshot(ctx context.Context, machineID string, desktopSessionID string, opts ...option.RequestOption) (*DesktopScreenshot, error)

Screenshot calls captureDesktopScreenshot: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions/{desktopSessionID}/screenshot.

func (*MachineDesktopSessionService) SendActions 

func (s *MachineDesktopSessionService) SendActions(ctx context.Context, machineID string, desktopSessionID string, params MachineDesktopSessionSendActionsParams, opts ...option.RequestOption) (*DesktopActionResponse, error)

SendActions calls sendDesktopActions: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/desktop-sessions/{desktopSessionID}/actions.

type MachineFailureReport 

type MachineFailureReport struct {
	DaemonVersion   *string                   `json:"daemon_version,omitempty"`
	ExitStatus      *int                      `json:"exit_status,omitempty"`
	OutputTail      string                    `json:"output_tail"`
	OutputTruncated bool                      `json:"output_truncated"`
	ReportedAt      Timestamp                 `json:"reported_at"`
	Stage           MachineFailureReportStage `json:"stage"`
	TargetVersion   *string                   `json:"target_version,omitempty"`
}

MachineFailureReport The machine's most recent daemon-reported failure. A single slot, overwritten by newer reports. Runtime crash reports remain as historical diagnostics; recovery may clear other failure stages.

type MachineFailureReportStage 

type MachineFailureReportStage string

MachineFailureReportStage defines model for MachineFailureReport.Stage. 

const (
	MachineFailureReportStageDaemonInstall     MachineFailureReportStage = "daemon_install"
	MachineFailureReportStageDaemonRuntime     MachineFailureReportStage = "daemon_runtime"
	MachineFailureReportStageDaemonUninstall   MachineFailureReportStage = "daemon_uninstall"
	MachineFailureReportStageDaemonUninstalled MachineFailureReportStage = "daemon_uninstalled"
	MachineFailureReportStageDaemonUpdate      MachineFailureReportStage = "daemon_update"
	MachineFailureReportStageStartupScript     MachineFailureReportStage = "startup_script"
)

Defines values for MachineFailureReportStage.

func (MachineFailureReportStage) Valid 

func (e MachineFailureReportStage) Valid() bool

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

type MachineGrantListParams 

type MachineGrantListParams struct {
	Name   *ResourceNameFilter
	Sort   *ResourceListSort
	Limit  *PageLimit
	Cursor *PageCursor
}

MachineGrantListParams are the query, header and body fields of listProjectMachineGrants.

type MachineGrantNewParams 

type MachineGrantNewParams struct {
	Description *string
	MachineID   MachineID
	Metadata    *Metadata
}

MachineGrantNewParams are the query, header and body fields of createProjectMachineGrant.

type MachineGrantService 

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

MachineGrantService groups the machineGrants methods.

func (*MachineGrantService) Delete 

func (s *MachineGrantService) Delete(ctx context.Context, grantID string, opts ...option.RequestOption) error

Delete calls deleteProjectMachineGrant: DELETE /orgs/{orgID}/projects/{projectID}/machine-grants/{grantID}.

func (*MachineGrantService) List 

func (s *MachineGrantService) List(ctx context.Context, params MachineGrantListParams, opts ...option.RequestOption) (*CursorPage[ProjectMachineGrantListItem], error)

List calls listProjectMachineGrants: GET /orgs/{orgID}/projects/{projectID}/machine-grants.

func (*MachineGrantService) ListAutoPaging 

func (s *MachineGrantService) ListAutoPaging(ctx context.Context, params MachineGrantListParams, opts ...option.RequestOption) *CursorPageAutoPager[ProjectMachineGrantListItem]

ListAutoPaging iterates every item of listProjectMachineGrants across pages.

func (*MachineGrantService) New 

func (s *MachineGrantService) New(ctx context.Context, params MachineGrantNewParams, opts ...option.RequestOption) (*CreateProjectMachineGrantResponse, error)

New calls createProjectMachineGrant: POST /orgs/{orgID}/projects/{projectID}/machine-grants.

type MachineID 

type MachineID = string

MachineID Machine ID (mch_...).

type MachineInteractionPermissions 

type MachineInteractionPermissions struct {
	DesktopControl bool `json:"desktop_control"`
	DesktopWatch   bool `json:"desktop_watch"`
	Terminal       bool `json:"terminal"`
}

MachineInteractionPermissions defines model for MachineInteractionPermissions.

type MachineLifecycleState 

type MachineLifecycleState string

MachineLifecycleState defines model for MachineLifecycleState. 

const (
	MachineLifecycleStateActive          MachineLifecycleState = "active"
	MachineLifecycleStateDeleteFailed    MachineLifecycleState = "delete_failed"
	MachineLifecycleStateDeleted         MachineLifecycleState = "deleted"
	MachineLifecycleStateDeleting        MachineLifecycleState = "deleting"
	MachineLifecycleStateProvisionFailed MachineLifecycleState = "provision_failed"
	MachineLifecycleStateProvisioning    MachineLifecycleState = "provisioning"
)

Defines values for MachineLifecycleState.

func (MachineLifecycleState) Valid 

func (e MachineLifecycleState) Valid() bool

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

type MachineListParams 

type MachineListParams struct {
	Name          *ResourceNameFilter
	SourceKind    *MachineSourceKindFilter
	MachinePoolID *MachinePoolID
	Sort          *ResourceListSort
	Limit         *PageLimit
	Cursor        *PageCursor
}

MachineListParams are the query, header and body fields of listVisibleProjectMachines.

type MachineMetadata 

type MachineMetadata map[string]string

MachineMetadata User-supplied metadata stored on a machine, provided directly or copied from the machine pool that provisions it. A restriction of Metadata that leaves room for one reserved pair - BMA sets observed_platform on the machine to the platform reported by its daemon, so the key is reserved and at most 15 user pairs are accepted.

type MachinePool 

type MachinePool struct {
	// ArchiveAfterPausedDays Days a machine stays paused before it is archived, or null when the pool does not archive.
	ArchiveAfterPausedDays *int32    `json:"archive_after_paused_days"`
	CreatedAt              Timestamp `json:"created_at"`
	DefaultCwd             string    `json:"default_cwd"`
	DefaultMachineCPU      *int32    `json:"default_machine_cpu"`

	// DefaultMachineEnv Default environment for pool machines. A machine's environment, including resolved secret_env values, is applied to the provider machine at provisioning, so the provider_options startup_script and the daemon run with it, and is resolved again for each process at launch.
	DefaultMachineEnv             map[string]string      `json:"default_machine_env"`
	DefaultMachineMemoryMb        *int32                 `json:"default_machine_memory_mb"`
	DefaultMachineProviderOptions map[string]interface{} `json:"default_machine_provider_options"`

	// DefaultMachineSecretEnv Default secret environment for pool machines, mapping env names to generic secret references. References are resolved to secret values wherever the machine environment is applied.
	DefaultMachineSecretEnv map[string]SecretID `json:"default_machine_secret_env"`

	// DeleteAfterIdleMinutes Idle minutes before deleting a machine from this pool, or null when the pool default is unset.
	DeleteAfterIdleMinutes *int32 `json:"delete_after_idle_minutes"`

	// DeleteAfterPausedDays Days a machine stays paused before it is deleted, counted from when it paused, or null when the pool keeps paused machines.
	DeleteAfterPausedDays *int32 `json:"delete_after_paused_days"`
	Description           string `json:"description"`

	// ID Machine pool ID (mpo_...).
	ID MachinePoolID `json:"id"`

	// ManagementKind Lifecycle owner. Tenant-managed resources can be changed through tenant APIs. Cluster-managed resources are installed and lifecycle-managed by the control plane; individual APIs may explicitly expose tenant-editable settings.
	ManagementKind     ManagementKind `json:"management_kind"`
	MaxMachineCPU      *int32         `json:"max_machine_cpu"`
	MaxMachineMemoryMb *int32         `json:"max_machine_memory_mb"`

	// MaxTotalCPU Deprecated, not enforced: organization and project in-use machine CPU quotas govern capacity.
	MaxTotalCPU *int32 `json:"max_total_cpu"`

	// MaxTotalMachines Deprecated, not enforced: how many machines a pool has no longer blocks new machines. Organization and project quotas over in-use machines (org resource limits max_in_use_pool_machines_per_project and max_in_use_pool_machines_per_org) govern capacity.
	MaxTotalMachines int32 `json:"max_total_machines"`

	// MaxTotalMemoryMb Deprecated, not enforced: organization and project in-use machine memory quotas govern capacity.
	MaxTotalMemoryMb *int32 `json:"max_total_memory_mb"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata           Metadata `json:"metadata"`
	MinMachineCPU      *int32   `json:"min_machine_cpu"`
	MinMachineMemoryMb *int32   `json:"min_machine_memory_mb"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name  ResourceName   `json:"name"`
	OrgID OrganizationID `json:"org_id"`

	// PauseAfterIdleMinutes Idle minutes before pausing a machine from this pool, or null when the pool does not pause idle machines.
	PauseAfterIdleMinutes *int32 `json:"pause_after_idle_minutes"`
	Provider              string `json:"provider"`

	// ProviderAuthSecretID Secret ID (sec_...).
	ProviderAuthSecretID *SecretID              `json:"provider_auth_secret_id,omitempty"`
	ProviderConfig       map[string]interface{} `json:"provider_config"`

	// RuntimeProtectionEnabled Whether BMA deletes this pool's machines when the provider remains running after the daemon becomes inactive.
	RuntimeProtectionEnabled bool              `json:"runtime_protection_enabled"`
	UpdatedAt                Timestamp         `json:"updated_at"`
	Usage                    *MachinePoolUsage `json:"usage,omitempty"`
}

MachinePool defines model for MachinePool.

type MachinePoolConnectionCheckError 

type MachinePoolConnectionCheckError struct {
	Code MachinePoolConnectionCheckErrorCode `json:"code"`

	// Details The provider's original error, for troubleshooting. Present when the provider call failed.
	Details *string `json:"details,omitempty"`

	// Error Why the check failed, in plain language. Do not match on it programmatically.
	Error string `json:"error"`
}

MachinePoolConnectionCheckError defines model for MachinePoolConnectionCheckError.

type MachinePoolConnectionCheckErrorCode 

type MachinePoolConnectionCheckErrorCode string

MachinePoolConnectionCheckErrorCode defines model for MachinePoolConnectionCheckError.Code. 

const (
	Unprocessable       MachinePoolConnectionCheckErrorCode = "unprocessable"
	UpstreamUnavailable MachinePoolConnectionCheckErrorCode = "upstream_unavailable"
)

Defines values for MachinePoolConnectionCheckErrorCode.

func (MachinePoolConnectionCheckErrorCode) Valid 

func (e MachinePoolConnectionCheckErrorCode) Valid() bool

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

type MachinePoolGrantListParams 

type MachinePoolGrantListParams struct {
	Name          *ResourceNameFilter
	MachinePoolID *MachinePoolID
	Sort          *ResourceListSort
	Limit         *PageLimit
	Cursor        *PageCursor
}

MachinePoolGrantListParams are the query, header and body fields of listProjectMachinePoolGrants.

type MachinePoolGrantNewParams 

type MachinePoolGrantNewParams struct {
	DefaultCwd                           *string
	DefaultMachineCPU                    *int32
	DefaultMachineEnvOverlay             *map[string]*string
	DefaultMachineMemoryMb               *int32
	DefaultMachineProviderOptionsOverlay *map[string]interface{}
	DefaultMachineSecretEnvOverlay       *map[string]*string
	DeleteAfterIdleMinutes               *int32
	Description                          *string
	MachinePoolID                        MachinePoolID
	MaxMachineCPU                        *int32
	MaxMachineMemoryMb                   *int32
	MaxTotalCPU                          *int32
	MaxTotalMachines                     *int32
	MaxTotalMemoryMb                     *int32
	Metadata                             *Metadata
	MinMachineCPU                        *int32
	MinMachineMemoryMb                   *int32
}

MachinePoolGrantNewParams are the query, header and body fields of createProjectMachinePoolGrant.

type MachinePoolGrantService 

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

MachinePoolGrantService groups the machinePoolGrants methods.

func (*MachinePoolGrantService) Delete 

func (s *MachinePoolGrantService) Delete(ctx context.Context, poolGrantID string, opts ...option.RequestOption) error

Delete calls deleteProjectMachinePoolGrant: DELETE /orgs/{orgID}/projects/{projectID}/machine-pool-grants/{poolGrantID}.

func (*MachinePoolGrantService) Get 

func (s *MachinePoolGrantService) Get(ctx context.Context, poolGrantID string, opts ...option.RequestOption) (*ProjectMachinePoolGrant, error)

Get calls getProjectMachinePoolGrant: GET /orgs/{orgID}/projects/{projectID}/machine-pool-grants/{poolGrantID}.

func (*MachinePoolGrantService) List 

func (s *MachinePoolGrantService) List(ctx context.Context, params MachinePoolGrantListParams, opts ...option.RequestOption) (*CursorPage[ProjectMachinePoolGrantListItem], error)

List calls listProjectMachinePoolGrants: GET /orgs/{orgID}/projects/{projectID}/machine-pool-grants.

func (*MachinePoolGrantService) ListAutoPaging 

func (s *MachinePoolGrantService) ListAutoPaging(ctx context.Context, params MachinePoolGrantListParams, opts ...option.RequestOption) *CursorPageAutoPager[ProjectMachinePoolGrantListItem]

ListAutoPaging iterates every item of listProjectMachinePoolGrants across pages.

func (*MachinePoolGrantService) New 

func (s *MachinePoolGrantService) New(ctx context.Context, params MachinePoolGrantNewParams, opts ...option.RequestOption) (*ProjectMachinePoolGrant, error)

New calls createProjectMachinePoolGrant: POST /orgs/{orgID}/projects/{projectID}/machine-pool-grants.

func (*MachinePoolGrantService) Update 

func (s *MachinePoolGrantService) Update(ctx context.Context, poolGrantID string, params MachinePoolGrantUpdateParams, opts ...option.RequestOption) (*ProjectMachinePoolGrant, error)

Update calls updateProjectMachinePoolGrant: PATCH /orgs/{orgID}/projects/{projectID}/machine-pool-grants/{poolGrantID}.

type MachinePoolGrantUpdateParams 

type MachinePoolGrantUpdateParams struct {
	DefaultCwd                           *string
	DefaultMachineCPU                    *int32
	DefaultMachineEnvOverlay             *map[string]*string
	DefaultMachineMemoryMb               *int32
	DefaultMachineProviderOptionsOverlay *map[string]interface{}
	DefaultMachineSecretEnvOverlay       *map[string]*string
	DeleteAfterIdleMinutes               *int32
	Description                          *string
	MaxMachineCPU                        *int32
	MaxMachineMemoryMb                   *int32
	MaxTotalCPU                          *int32
	MaxTotalMachines                     *int32
	MaxTotalMemoryMb                     *int32
	Metadata                             *Metadata
	MinMachineCPU                        *int32
	MinMachineMemoryMb                   *int32
}

MachinePoolGrantUpdateParams are the query, header and body fields of updateProjectMachinePoolGrant.

type MachinePoolID 

type MachinePoolID = string

MachinePoolID Machine pool ID (mpo_...).

type MachinePoolSummary 

type MachinePoolSummary struct {
	CreatedAt   Timestamp `json:"created_at"`
	Description string    `json:"description"`

	// ID Machine pool ID (mpo_...).
	ID MachinePoolID `json:"id"`

	// ManagementKind Lifecycle owner. Tenant-managed resources can be changed through tenant APIs. Cluster-managed resources are installed and lifecycle-managed by the control plane; individual APIs may explicitly expose tenant-editable settings.
	ManagementKind ManagementKind `json:"management_kind"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name      ResourceName   `json:"name"`
	OrgID     OrganizationID `json:"org_id"`
	Provider  string         `json:"provider"`
	UpdatedAt Timestamp      `json:"updated_at"`
}

MachinePoolSummary defines model for MachinePoolSummary.

type MachinePoolUsage 

type MachinePoolUsage struct {
	CPU      int64 `json:"cpu"`
	Machines int32 `json:"machines"`
	MemoryMb int64 `json:"memory_mb"`
}

MachinePoolUsage defines model for MachinePoolUsage.

type MachinePowerState 

type MachinePowerState string

MachinePowerState Compute state of a pool machine. paused keeps the disk (and memory when the provider supports it) without compute; resuming means a resume or restore is in flight; archived means the machine image is stored durably and is restored on the next access. 

const (
	MachinePowerStateArchived  MachinePowerState = "archived"
	MachinePowerStateArchiving MachinePowerState = "archiving"
	MachinePowerStatePaused    MachinePowerState = "paused"
	MachinePowerStatePausing   MachinePowerState = "pausing"
	MachinePowerStateResuming  MachinePowerState = "resuming"
	MachinePowerStateRunning   MachinePowerState = "running"
)

Defines values for MachinePowerState.

func (MachinePowerState) Valid 

func (e MachinePowerState) Valid() bool

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

type MachinePowerStatus 

type MachinePowerStatus struct {
	ConnectionState MachineConnectionState `json:"connection_state"`

	// MachineID Machine ID (mch_...).
	MachineID MachineID `json:"machine_id"`

	// PowerState Compute state of a pool machine. paused keeps the disk (and memory when the provider supports it) without compute; resuming means a resume or restore is in flight; archived means the machine image is stored durably and is restored on the next access.
	PowerState MachinePowerState `json:"power_state"`
}

MachinePowerStatus defines model for MachinePowerStatus.

type MachineProtocolVersions 

type MachineProtocolVersions struct {
	Desktop  int32 `json:"desktop"`
	Terminal int32 `json:"terminal"`
}

MachineProtocolVersions defines model for MachineProtocolVersions.

type MachineRestoreParams 

type MachineRestoreParams struct {
	BackupID *string
}

MachineRestoreParams are the query, header and body fields of restoreMachineFromBackup.

type MachineService 

type MachineService struct {
	Backups          *MachineBackupService
	DesktopSessions  *MachineDesktopSessionService
	TerminalSessions *MachineTerminalSessionService
	// contains filtered or unexported fields
}

MachineService groups the machines methods.

func (*MachineService) Capabilities 

func (s *MachineService) Capabilities(ctx context.Context, machineID string, opts ...option.RequestOption) (*MachineCapabilities, error)

Capabilities calls getMachineCapabilities: GET /orgs/{orgID}/projects/{projectID}/machines/{machineID}/capabilities.

func (*MachineService) List 

func (s *MachineService) List(ctx context.Context, params MachineListParams, opts ...option.RequestOption) (*CursorPage[VisibleMachine], error)

List calls listVisibleProjectMachines: GET /orgs/{orgID}/projects/{projectID}/machines.

func (*MachineService) ListAutoPaging 

func (s *MachineService) ListAutoPaging(ctx context.Context, params MachineListParams, opts ...option.RequestOption) *CursorPageAutoPager[VisibleMachine]

ListAutoPaging iterates every item of listVisibleProjectMachines across pages.

func (*MachineService) Restore 

func (s *MachineService) Restore(ctx context.Context, machineID string, params MachineRestoreParams, opts ...option.RequestOption) (*MachineBackup, error)

Restore calls restoreMachineFromBackup: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/restore.

func (*MachineService) Resume 

func (s *MachineService) Resume(ctx context.Context, machineID string, opts ...option.RequestOption) (*MachinePowerStatus, error)

Resume calls resumeMachine: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/resume.

type MachineSourceKind 

type MachineSourceKind string

MachineSourceKind defines model for MachineSourceKind. 

const (
	MachineSourceKindBYO  MachineSourceKind = "byo"
	MachineSourceKindPool MachineSourceKind = "pool"
)

Defines values for MachineSourceKind.

func (MachineSourceKind) Valid 

func (e MachineSourceKind) Valid() bool

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

type MachineSourceKindFilter 

type MachineSourceKindFilter = MachineSourceKind

MachineSourceKindFilter defines model for MachineSourceKindFilter.

type MachineSummary 

type MachineSummary = MachineSummaryFields

MachineSummary Shared machine fields composed into machine response schemas. Composing schemas close their final shape with unevaluatedProperties.

type MachineSummaryFields 

type MachineSummaryFields struct {
	ConnectionState MachineConnectionState `json:"connection_state"`
	CreatedAt       Timestamp              `json:"created_at"`
	DeletedAt       *Timestamp             `json:"deleted_at"`
	Description     string                 `json:"description"`

	// DisplayName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	DisplayName ResourceName `json:"display_name"`

	// ID Machine ID (mch_...).
	ID             MachineID             `json:"id"`
	LastObservedAt *Timestamp            `json:"last_observed_at"`
	LifecycleState MachineLifecycleState `json:"lifecycle_state"`
	OrgID          OrganizationID        `json:"org_id"`
	Provider       string                `json:"provider"`
	SourceKind     MachineSourceKind     `json:"source_kind"`
	UpdatedAt      Timestamp             `json:"updated_at"`
}

MachineSummaryFields Shared machine fields composed into machine response schemas. Composing schemas close their final shape with unevaluatedProperties.

type MachineTerminalCapability 

type MachineTerminalCapability struct {
	// Reason Why terminal access is unavailable, when supported is false.
	Reason    *string `json:"reason,omitempty"`
	Supported bool    `json:"supported"`
}

MachineTerminalCapability defines model for MachineTerminalCapability.

type MachineTerminalSessionConnectionTicketParams 

type MachineTerminalSessionConnectionTicketParams struct {
	TTLSeconds *int32
}

MachineTerminalSessionConnectionTicketParams are the query, header and body fields of createTerminalConnectionTicket.

type MachineTerminalSessionNewParams 

type MachineTerminalSessionNewParams struct {
	Cols  *int32
	Cwd   *string
	Rows  *int32
	Shell *string
}

MachineTerminalSessionNewParams are the query, header and body fields of createTerminalSession.

type MachineTerminalSessionService 

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

MachineTerminalSessionService groups the machines.terminalSessions methods.

func (*MachineTerminalSessionService) Close 

func (s *MachineTerminalSessionService) Close(ctx context.Context, machineID string, terminalSessionID string, opts ...option.RequestOption) error

Close calls closeTerminalSession: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/terminal-sessions/{terminalSessionID}/close.

func (*MachineTerminalSessionService) ConnectionTicket 

func (s *MachineTerminalSessionService) ConnectionTicket(ctx context.Context, machineID string, terminalSessionID string, params MachineTerminalSessionConnectionTicketParams, opts ...option.RequestOption) (*ConnectionTicket, error)

ConnectionTicket calls createTerminalConnectionTicket: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/terminal-sessions/{terminalSessionID}/connection-ticket.

func (*MachineTerminalSessionService) Get 

func (s *MachineTerminalSessionService) Get(ctx context.Context, machineID string, terminalSessionID string, opts ...option.RequestOption) (*TerminalSession, error)

Get calls getTerminalSession: GET /orgs/{orgID}/projects/{projectID}/machines/{machineID}/terminal-sessions/{terminalSessionID}.

func (*MachineTerminalSessionService) List 

func (s *MachineTerminalSessionService) List(ctx context.Context, machineID string, opts ...option.RequestOption) (*ListTerminalSessionsResponse, error)

List calls listTerminalSessions: GET /orgs/{orgID}/projects/{projectID}/machines/{machineID}/terminal-sessions.

func (*MachineTerminalSessionService) New 

func (s *MachineTerminalSessionService) New(ctx context.Context, machineID string, params MachineTerminalSessionNewParams, opts ...option.RequestOption) (*TerminalSession, error)

New calls createTerminalSession: POST /orgs/{orgID}/projects/{projectID}/machines/{machineID}/terminal-sessions.

type ManagementKind 

type ManagementKind string

ManagementKind Lifecycle owner. Tenant-managed resources can be changed through tenant APIs. Cluster-managed resources are installed and lifecycle-managed by the control plane; individual APIs may explicitly expose tenant-editable settings. 

const (
	Cluster ManagementKind = "cluster"
	Tenant  ManagementKind = "tenant"
)

Defines values for ManagementKind.

func (ManagementKind) Valid 

func (e ManagementKind) Valid() bool

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

type MeService 

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

MeService groups the me methods.

func (*MeService) Delete 

func (s *MeService) Delete(ctx context.Context, opts ...option.RequestOption) error

Delete calls deleteCurrentUser: DELETE /me.

func (*MeService) Get 

func (s *MeService) Get(ctx context.Context, opts ...option.RequestOption) (*CurrentUser, error)

Get calls getCurrentUser: GET /me.

type MediaRefContentBlock 

type MediaRefContentBlock struct {
	ArtifactID ArtifactID `json:"artifact_id"`

	// ExcludeFromModelContext Whether the referenced artifact is excluded from later model context.
	ExcludeFromModelContext *bool `json:"exclude_from_model_context,omitempty"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata *ContentBlockMetadata    `json:"metadata,omitempty"`
	Type     MediaRefContentBlockType `json:"type"`
}

MediaRefContentBlock defines model for MediaRefContentBlock.

type MediaRefContentBlockType 

type MediaRefContentBlockType string

MediaRefContentBlockType defines model for MediaRefContentBlock.Type. 

const (
	MediaRef MediaRefContentBlockType = "media_ref"
)

Defines values for MediaRefContentBlockType.

func (MediaRefContentBlockType) Valid 

func (e MediaRefContentBlockType) Valid() bool

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

type MemoryDirectory 

type MemoryDirectory struct {
	ModifiedAt Timestamp           `json:"modified_at"`
	Path       string              `json:"path"`
	Type       MemoryDirectoryType `json:"type"`
}

MemoryDirectory defines model for MemoryDirectory.

type MemoryDirectoryType 

type MemoryDirectoryType string

MemoryDirectoryType defines model for MemoryDirectory.Type. 

const (
	MemoryDirectoryTypeDirectory MemoryDirectoryType = "directory"
)

Defines values for MemoryDirectoryType.

func (MemoryDirectoryType) Valid 

func (e MemoryDirectoryType) Valid() bool

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

type MemoryFile 

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

MemoryFile defines model for MemoryFile.

func (MemoryFile) AsAny 

func (t MemoryFile) AsAny() any

AsAny returns the member of MemoryFile named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (MemoryFile) AsMemoryDirectory 

func (t MemoryFile) AsMemoryDirectory() (MemoryDirectory, error)

AsMemoryDirectory returns the union data inside the MemoryFile as a MemoryDirectory

func (MemoryFile) AsMemoryRegularFile 

func (t MemoryFile) AsMemoryRegularFile() (MemoryRegularFile, error)

AsMemoryRegularFile returns the union data inside the MemoryFile as a MemoryRegularFile

func (MemoryFile) Discriminator 

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

func (*MemoryFile) FromMemoryDirectory 

func (t *MemoryFile) FromMemoryDirectory(v MemoryDirectory) error

FromMemoryDirectory overwrites any union data inside the MemoryFile as the provided MemoryDirectory

func (*MemoryFile) FromMemoryRegularFile 

func (t *MemoryFile) FromMemoryRegularFile(v MemoryRegularFile) error

FromMemoryRegularFile overwrites any union data inside the MemoryFile as the provided MemoryRegularFile

func (MemoryFile) MarshalJSON 

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

func (*MemoryFile) MergeMemoryDirectory 

func (t *MemoryFile) MergeMemoryDirectory(v MemoryDirectory) error

MergeMemoryDirectory performs a merge with any union data inside the MemoryFile, using the provided MemoryDirectory

func (*MemoryFile) MergeMemoryRegularFile 

func (t *MemoryFile) MergeMemoryRegularFile(v MemoryRegularFile) error

MergeMemoryRegularFile performs a merge with any union data inside the MemoryFile, using the provided MemoryRegularFile

func (*MemoryFile) UnmarshalJSON 

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

func (MemoryFile) ValueByDiscriminator 

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

type MemoryFileList 

type MemoryFileList struct {
	Data       []MemoryFile `json:"data"`
	NextCursor *string      `json:"next_cursor"`
}

MemoryFileList defines model for MemoryFileList.

type MemoryRegularFile 

type MemoryRegularFile struct {
	ModifiedAt Timestamp             `json:"modified_at"`
	Path       string                `json:"path"`
	SizeBytes  int64                 `json:"size_bytes"`
	Type       MemoryRegularFileType `json:"type"`
}

MemoryRegularFile defines model for MemoryRegularFile.

type MemoryRegularFileType 

type MemoryRegularFileType string

MemoryRegularFileType defines model for MemoryRegularFile.Type. 

const (
	MemoryRegularFileTypeFile MemoryRegularFileType = "file"
)

Defines values for MemoryRegularFileType.

func (MemoryRegularFileType) Valid 

func (e MemoryRegularFileType) Valid() bool

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

type MemoryStore 

type MemoryStore struct {
	AgentAccess MemoryStoreAccess `json:"agent_access"`
	CreatedAt   time.Time         `json:"created_at"`
	Description string            `json:"description"`
	ID          MemoryStoreID     `json:"id"`

	// Name Machine-readable memory store identifier consisting of lowercase ASCII segments separated by single hyphens.
	Name MemoryStoreName `json:"name"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`
	UpdatedAt time.Time `json:"updated_at"`
}

MemoryStore defines model for MemoryStore.

type MemoryStoreAccess 

type MemoryStoreAccess string

MemoryStoreAccess defines model for MemoryStoreAccess. 

const (
	MemoryStoreAccessRead      MemoryStoreAccess = "read"
	MemoryStoreAccessReadWrite MemoryStoreAccess = "read_write"
)

Defines values for MemoryStoreAccess.

func (MemoryStoreAccess) Valid 

func (e MemoryStoreAccess) Valid() bool

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

type MemoryStoreFileDeleteParams 

type MemoryStoreFileDeleteParams struct {
	Path           string
	ExpectedDigest string
}

MemoryStoreFileDeleteParams are the query, header and body fields of deleteMemoryFile.

type MemoryStoreFileDownloadParams 

type MemoryStoreFileDownloadParams struct {
	Path string
}

MemoryStoreFileDownloadParams are the query, header and body fields of downloadMemoryFile.

type MemoryStoreFileListParams 

type MemoryStoreFileListParams struct {
	Path   *string
	Limit  *PageLimit
	Cursor *PageCursor
}

MemoryStoreFileListParams are the query, header and body fields of listMemoryFiles.

type MemoryStoreFileService 

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

MemoryStoreFileService groups the memoryStores.files methods.

func (*MemoryStoreFileService) Delete 

func (s *MemoryStoreFileService) Delete(ctx context.Context, memoryStoreID string, params MemoryStoreFileDeleteParams, opts ...option.RequestOption) error

Delete calls deleteMemoryFile: DELETE /orgs/{orgID}/projects/{projectID}/memory-stores/{memoryStoreID}/file.

func (*MemoryStoreFileService) Download 

func (s *MemoryStoreFileService) Download(ctx context.Context, memoryStoreID string, params MemoryStoreFileDownloadParams, opts ...option.RequestOption) (*http.Response, error)

Download calls downloadMemoryFile: GET /orgs/{orgID}/projects/{projectID}/memory-stores/{memoryStoreID}/file. The caller closes the response body.

func (*MemoryStoreFileService) List 

func (s *MemoryStoreFileService) List(ctx context.Context, memoryStoreID string, params MemoryStoreFileListParams, opts ...option.RequestOption) (*CursorPage[MemoryFile], error)

List calls listMemoryFiles: GET /orgs/{orgID}/projects/{projectID}/memory-stores/{memoryStoreID}/files.

func (*MemoryStoreFileService) ListAutoPaging 

func (s *MemoryStoreFileService) ListAutoPaging(ctx context.Context, memoryStoreID string, params MemoryStoreFileListParams, opts ...option.RequestOption) *CursorPageAutoPager[MemoryFile]

ListAutoPaging iterates every item of listMemoryFiles across pages.

func (*MemoryStoreFileService) Write 

func (s *MemoryStoreFileService) Write(ctx context.Context, memoryStoreID string, params MemoryStoreFileWriteParams, opts ...option.RequestOption) (*UploadFileResponse, error)

Write calls writeMemoryFile: PUT /orgs/{orgID}/projects/{projectID}/memory-stores/{memoryStoreID}/file.

type MemoryStoreFileWriteParams 

type MemoryStoreFileWriteParams struct {
	Path           string
	ExpectedDigest *string
	Body           io.Reader
}

MemoryStoreFileWriteParams are the query, header and body fields of writeMemoryFile.

type MemoryStoreID 

type MemoryStoreID = string

MemoryStoreID defines model for MemoryStoreID.

type MemoryStoreList 

type MemoryStoreList struct {
	Data       []MemoryStore `json:"data"`
	NextCursor *string       `json:"next_cursor"`
}

MemoryStoreList defines model for MemoryStoreList.

type MemoryStoreListParams 

type MemoryStoreListParams struct {
	Limit  *PageLimit
	Name   *ResourceNameFilter
	Cursor *PageCursor
}

MemoryStoreListParams are the query, header and body fields of listMemoryStores.

type MemoryStoreName 

type MemoryStoreName = string

MemoryStoreName Machine-readable memory store identifier consisting of lowercase ASCII segments separated by single hyphens.

type MemoryStoreNewParams 

type MemoryStoreNewParams struct {
	AgentAccess *MemoryStoreAccess
	Description *string
	Name        MemoryStoreName
}

MemoryStoreNewParams are the query, header and body fields of createMemoryStore.

type MemoryStoreService 

type MemoryStoreService struct {
	Files *MemoryStoreFileService
	// contains filtered or unexported fields
}

MemoryStoreService groups the memoryStores methods.

func (*MemoryStoreService) Delete 

func (s *MemoryStoreService) Delete(ctx context.Context, memoryStoreID string, opts ...option.RequestOption) error

Delete calls deleteMemoryStore: DELETE /orgs/{orgID}/projects/{projectID}/memory-stores/{memoryStoreID}.

func (*MemoryStoreService) Get 

func (s *MemoryStoreService) Get(ctx context.Context, memoryStoreID string, opts ...option.RequestOption) (*MemoryStore, error)

Get calls getMemoryStore: GET /orgs/{orgID}/projects/{projectID}/memory-stores/{memoryStoreID}.

func (*MemoryStoreService) List 

func (s *MemoryStoreService) List(ctx context.Context, params MemoryStoreListParams, opts ...option.RequestOption) (*CursorPage[MemoryStore], error)

List calls listMemoryStores: GET /orgs/{orgID}/projects/{projectID}/memory-stores.

func (*MemoryStoreService) ListAutoPaging 

func (s *MemoryStoreService) ListAutoPaging(ctx context.Context, params MemoryStoreListParams, opts ...option.RequestOption) *CursorPageAutoPager[MemoryStore]

ListAutoPaging iterates every item of listMemoryStores across pages.

func (*MemoryStoreService) New 

func (s *MemoryStoreService) New(ctx context.Context, params MemoryStoreNewParams, opts ...option.RequestOption) (*MemoryStore, error)

New calls createMemoryStore: POST /orgs/{orgID}/projects/{projectID}/memory-stores.

func (*MemoryStoreService) Update 

func (s *MemoryStoreService) Update(ctx context.Context, memoryStoreID string, params MemoryStoreUpdateParams, opts ...option.RequestOption) (*MemoryStore, error)

Update calls updateMemoryStore: PATCH /orgs/{orgID}/projects/{projectID}/memory-stores/{memoryStoreID}.

type MemoryStoreUpdateParams 

type MemoryStoreUpdateParams struct {
	AgentAccess *MemoryStoreAccess
	Description *string
}

MemoryStoreUpdateParams are the query, header and body fields of updateMemoryStore.

type Metadata 

type Metadata map[string]string

Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.

type ModelAPIFormat 

type ModelAPIFormat string

ModelAPIFormat Wire protocol the model endpoint speaks: openai-responses, openai-chat-completions, or anthropic-messages. 

const (
	ModelAPIFormatAnthropicMessages     ModelAPIFormat = "anthropic-messages"
	ModelAPIFormatOpenaiChatCompletions ModelAPIFormat = "openai-chat-completions"
	ModelAPIFormatOpenaiResponses       ModelAPIFormat = "openai-responses"
)

Defines values for ModelAPIFormat.

func (ModelAPIFormat) Valid 

func (e ModelAPIFormat) Valid() bool

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

type ModelAPIVariantOptions 

type ModelAPIVariantOptions map[string]interface{}

ModelAPIVariantOptions Extra top-level JSON fields to include in provider requests for this configured model. Use this for provider-specific settings that BMA does not expose as typed fields, such as OpenRouter `provider` routing or sampling parameters. BMA still controls the fields it needs to run the agent correctly, including the model, prompt/messages, streaming, tools, output-token limit, and selected reasoning policy. Provider passthrough values for those fields are ignored. For OpenRouter routing options, see https://openrouter.ai/docs/guides/routing/provider-selection and general request parameters at https://openrouter.ai/docs/api/reference/parameters. BMA-managed OpenRouter providers accept only sampling, reasoning, and per-model routing options here.

type ModelCacheRetention 

type ModelCacheRetention string

ModelCacheRetention Prompt-cache preference for model requests; `short` when omitted. `short` applies the route's default caching (explicit cache breakpoints where the provider requires them) and, where the route accepts one, a stable conversation key for cache-aware routing. `long` prefers the route's extended cache lifetime where one exists (currently Anthropic's one-hour cache, which on Bedrock requires Claude 4.5 or newer) and behaves like `short` elsewhere. `none` sends no BMA-managed cache controls or conversation key; providers may still cache prefixes on their own. 

const (
	ModelCacheRetentionLong  ModelCacheRetention = "long"
	ModelCacheRetentionNone  ModelCacheRetention = "none"
	ModelCacheRetentionShort ModelCacheRetention = "short"
)

Defines values for ModelCacheRetention.

func (ModelCacheRetention) Valid 

func (e ModelCacheRetention) Valid() bool

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

type ModelCallContextID 

type ModelCallContextID = string

ModelCallContextID defines model for ModelCallContextID.

type ModelCatalog 

type ModelCatalog struct {
	// Error Why the probe failed. Present when status is failed.
	Error *string `json:"error,omitempty"`

	// Models Models advertised by the provider, newest first, filtered to text-output tool-calling models where the provider exposes enough metadata to tell. Present when status is ok.
	Models *[]DiscoveredProviderModel `json:"models,omitempty"`
	Status ModelCatalogStatus         `json:"status"`
}

ModelCatalog The provider's model catalog, obtained by validating the configured credential and probing the provider's /models endpoint. A failed probe does not affect the stored config; treat it as a warning that the base URL or API key may be invalid.

type ModelCatalogStatus 

type ModelCatalogStatus string

ModelCatalogStatus defines model for ModelCatalog.Status. 

const (
	ModelCatalogStatusFailed ModelCatalogStatus = "failed"
	ModelCatalogStatusOk     ModelCatalogStatus = "ok"
)

Defines values for ModelCatalogStatus.

func (ModelCatalogStatus) Valid 

func (e ModelCatalogStatus) Valid() bool

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

type ModelGrantListParams 

type ModelGrantListParams struct {
	Name   *ResourceNameFilter
	Sort   *ResourceListSort
	Limit  *PageLimit
	Cursor *PageCursor
}

ModelGrantListParams are the query, header and body fields of listProjectModelGrants.

type ModelGrantNewParams 

type ModelGrantNewParams struct {
	ConfiguredModelID         ConfiguredModelID
	ContextWindowTokens       *int
	DefaultCacheRetention     *ModelCacheRetention
	DefaultMaxOutputTokens    *int
	DefaultReasoningEffort    *string
	InputModalities           *[]string
	MaxOutputTokens           *int
	OutputModalities          *[]string
	SupportedReasoningEfforts *[]string
	SupportsReasoning         *bool
	SupportsTools             *bool
}

ModelGrantNewParams are the query, header and body fields of createProjectModelGrant.

type ModelGrantService 

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

ModelGrantService groups the modelGrants methods.

func (*ModelGrantService) Delete 

func (s *ModelGrantService) Delete(ctx context.Context, modelGrantID string, opts ...option.RequestOption) error

Delete calls deleteProjectModelGrant: DELETE /orgs/{orgID}/projects/{projectID}/model-grants/{modelGrantID}.

func (*ModelGrantService) List 

func (s *ModelGrantService) List(ctx context.Context, params ModelGrantListParams, opts ...option.RequestOption) (*CursorPage[ProjectModelGrantListItem], error)

List calls listProjectModelGrants: GET /orgs/{orgID}/projects/{projectID}/model-grants.

func (*ModelGrantService) ListAutoPaging 

func (s *ModelGrantService) ListAutoPaging(ctx context.Context, params ModelGrantListParams, opts ...option.RequestOption) *CursorPageAutoPager[ProjectModelGrantListItem]

ListAutoPaging iterates every item of listProjectModelGrants across pages.

func (*ModelGrantService) New 

func (s *ModelGrantService) New(ctx context.Context, params ModelGrantNewParams, opts ...option.RequestOption) (*ProjectModelGrantEnvelope, error)

New calls createProjectModelGrant: POST /orgs/{orgID}/projects/{projectID}/model-grants.

func (*ModelGrantService) Update 

func (s *ModelGrantService) Update(ctx context.Context, modelGrantID string, params ModelGrantUpdateParams, opts ...option.RequestOption) (*ProjectModelGrantEnvelope, error)

Update calls updateProjectModelGrant: PATCH /orgs/{orgID}/projects/{projectID}/model-grants/{modelGrantID}.

type ModelGrantUpdateParams 

type ModelGrantUpdateParams struct {
	ContextWindowTokens       *int
	DefaultCacheRetention     *ModelCacheRetention
	DefaultMaxOutputTokens    *int
	DefaultReasoningEffort    *string
	InputModalities           *[]string
	MaxOutputTokens           *int
	OutputModalities          *[]string
	SupportedReasoningEfforts *[]string
	SupportsReasoning         *bool
	SupportsTools             *bool
}

ModelGrantUpdateParams are the query, header and body fields of updateProjectModelGrant.

type ModelOutputBlockStartDelta 

type ModelOutputBlockStartDelta struct {
	Block      ModelOutputStreamBlock         `json:"block"`
	BlockIndex int                            `json:"block_index"`
	Kind       ModelOutputBlockStartDeltaKind `json:"kind"`
}

ModelOutputBlockStartDelta defines model for ModelOutputBlockStartDelta.

type ModelOutputBlockStartDeltaKind 

type ModelOutputBlockStartDeltaKind string

ModelOutputBlockStartDeltaKind defines model for ModelOutputBlockStartDelta.Kind. 

const (
	BlockStart ModelOutputBlockStartDeltaKind = "block_start"
)

Defines values for ModelOutputBlockStartDeltaKind.

func (ModelOutputBlockStartDeltaKind) Valid 

func (e ModelOutputBlockStartDeltaKind) Valid() bool

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

type ModelOutputBlockStopDelta 

type ModelOutputBlockStopDelta struct {
	BlockIndex int                           `json:"block_index"`
	Kind       ModelOutputBlockStopDeltaKind `json:"kind"`
}

ModelOutputBlockStopDelta defines model for ModelOutputBlockStopDelta.

type ModelOutputBlockStopDeltaKind 

type ModelOutputBlockStopDeltaKind string

ModelOutputBlockStopDeltaKind defines model for ModelOutputBlockStopDelta.Kind. 

const (
	BlockStop ModelOutputBlockStopDeltaKind = "block_stop"
)

Defines values for ModelOutputBlockStopDeltaKind.

func (ModelOutputBlockStopDeltaKind) Valid 

func (e ModelOutputBlockStopDeltaKind) Valid() bool

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

type ModelOutputContentBlock 

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

ModelOutputContentBlock defines model for ModelOutputContentBlock.

func (ModelOutputContentBlock) AsAny 

func (t ModelOutputContentBlock) AsAny() any

AsAny returns the member of ModelOutputContentBlock named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (ModelOutputContentBlock) AsErrorContentBlock 

func (t ModelOutputContentBlock) AsErrorContentBlock() (ErrorContentBlock, error)

AsErrorContentBlock returns the union data inside the ModelOutputContentBlock as a ErrorContentBlock

func (ModelOutputContentBlock) AsMediaRefContentBlock 

func (t ModelOutputContentBlock) AsMediaRefContentBlock() (MediaRefContentBlock, error)

AsMediaRefContentBlock returns the union data inside the ModelOutputContentBlock as a MediaRefContentBlock

func (ModelOutputContentBlock) AsModelToolCallContentBlock 

func (t ModelOutputContentBlock) AsModelToolCallContentBlock() (ModelToolCallContentBlock, error)

AsModelToolCallContentBlock returns the union data inside the ModelOutputContentBlock as a ModelToolCallContentBlock

func (ModelOutputContentBlock) AsReasoningContentBlock 

func (t ModelOutputContentBlock) AsReasoningContentBlock() (ReasoningContentBlock, error)

AsReasoningContentBlock returns the union data inside the ModelOutputContentBlock as a ReasoningContentBlock

func (ModelOutputContentBlock) AsTextContentBlock 

func (t ModelOutputContentBlock) AsTextContentBlock() (TextContentBlock, error)

AsTextContentBlock returns the union data inside the ModelOutputContentBlock as a TextContentBlock

func (ModelOutputContentBlock) Discriminator 

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

func (*ModelOutputContentBlock) FromErrorContentBlock 

func (t *ModelOutputContentBlock) FromErrorContentBlock(v ErrorContentBlock) error

FromErrorContentBlock overwrites any union data inside the ModelOutputContentBlock as the provided ErrorContentBlock

func (*ModelOutputContentBlock) FromMediaRefContentBlock 

func (t *ModelOutputContentBlock) FromMediaRefContentBlock(v MediaRefContentBlock) error

FromMediaRefContentBlock overwrites any union data inside the ModelOutputContentBlock as the provided MediaRefContentBlock

func (*ModelOutputContentBlock) FromModelToolCallContentBlock 

func (t *ModelOutputContentBlock) FromModelToolCallContentBlock(v ModelToolCallContentBlock) error

FromModelToolCallContentBlock overwrites any union data inside the ModelOutputContentBlock as the provided ModelToolCallContentBlock

func (*ModelOutputContentBlock) FromReasoningContentBlock 

func (t *ModelOutputContentBlock) FromReasoningContentBlock(v ReasoningContentBlock) error

FromReasoningContentBlock overwrites any union data inside the ModelOutputContentBlock as the provided ReasoningContentBlock

func (*ModelOutputContentBlock) FromTextContentBlock 

func (t *ModelOutputContentBlock) FromTextContentBlock(v TextContentBlock) error

FromTextContentBlock overwrites any union data inside the ModelOutputContentBlock as the provided TextContentBlock

func (ModelOutputContentBlock) MarshalJSON 

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

func (*ModelOutputContentBlock) MergeErrorContentBlock 

func (t *ModelOutputContentBlock) MergeErrorContentBlock(v ErrorContentBlock) error

MergeErrorContentBlock performs a merge with any union data inside the ModelOutputContentBlock, using the provided ErrorContentBlock

func (*ModelOutputContentBlock) MergeMediaRefContentBlock 

func (t *ModelOutputContentBlock) MergeMediaRefContentBlock(v MediaRefContentBlock) error

MergeMediaRefContentBlock performs a merge with any union data inside the ModelOutputContentBlock, using the provided MediaRefContentBlock

func (*ModelOutputContentBlock) MergeModelToolCallContentBlock 

func (t *ModelOutputContentBlock) MergeModelToolCallContentBlock(v ModelToolCallContentBlock) error

MergeModelToolCallContentBlock performs a merge with any union data inside the ModelOutputContentBlock, using the provided ModelToolCallContentBlock

func (*ModelOutputContentBlock) MergeReasoningContentBlock 

func (t *ModelOutputContentBlock) MergeReasoningContentBlock(v ReasoningContentBlock) error

MergeReasoningContentBlock performs a merge with any union data inside the ModelOutputContentBlock, using the provided ReasoningContentBlock

func (*ModelOutputContentBlock) MergeTextContentBlock 

func (t *ModelOutputContentBlock) MergeTextContentBlock(v TextContentBlock) error

MergeTextContentBlock performs a merge with any union data inside the ModelOutputContentBlock, using the provided TextContentBlock

func (*ModelOutputContentBlock) UnmarshalJSON 

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

func (ModelOutputContentBlock) ValueByDiscriminator 

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

type ModelOutputDelta 

type ModelOutputDelta struct {
	// CoalescedCount Positive count within an agent timeline.
	CoalescedCount     AgentCount             `json:"coalesced_count"`
	Event              ModelOutputStreamDelta `json:"event"`
	ModelCallContextID ModelCallContextID     `json:"model_call_context_id"`

	// Seq Positive per-agent event, turn, or live-frame sequence.
	Seq AgentSequence `json:"seq"`

	// SourceSeqEnd Positive per-agent event, turn, or live-frame sequence.
	SourceSeqEnd AgentSequence `json:"source_seq_end"`

	// SourceSeqStart Positive per-agent event, turn, or live-frame sequence.
	SourceSeqStart AgentSequence `json:"source_seq_start"`
	TurnID         AgentTurnID   `json:"turn_id"`
}

ModelOutputDelta defines model for ModelOutputDelta.

type ModelOutputErrorDelta 

type ModelOutputErrorDelta struct {
	Error struct {
		Message string `json:"message"`
	} `json:"error"`
	Kind ModelOutputErrorDeltaKind `json:"kind"`
}

ModelOutputErrorDelta defines model for ModelOutputErrorDelta.

type ModelOutputErrorDeltaKind 

type ModelOutputErrorDeltaKind string

ModelOutputErrorDeltaKind defines model for ModelOutputErrorDelta.Kind. 

const (
	ModelOutputErrorDeltaKindError ModelOutputErrorDeltaKind = "error"
)

Defines values for ModelOutputErrorDeltaKind.

func (ModelOutputErrorDeltaKind) Valid 

func (e ModelOutputErrorDeltaKind) Valid() bool

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

type ModelOutputEvent 

type ModelOutputEvent struct {
	AgentID            AgentID                        `json:"agent_id"`
	ContentBlocks      []ModelOutputContentBlock      `json:"content_blocks"`
	CreatedAt          Timestamp                      `json:"created_at"`
	EventKind          ModelOutputEventEventKind      `json:"event_kind"`
	ID                 AgentEventID                   `json:"id"`
	IsOpeningEvent     ModelOutputEventIsOpeningEvent `json:"is_opening_event"`
	ModelCallContextID ModelCallContextID             `json:"model_call_context_id"`
	OrgID              OrganizationID                 `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// ProviderMetadata Facts the provider reported about this call, keyed by provider (for example `openrouter.provider` names the upstream that served an OpenRouter request). Present only when the provider reported something.
	ProviderMetadata *map[string]interface{} `json:"provider_metadata,omitempty"`

	// Sequence Positive per-agent event, turn, or live-frame sequence.
	Sequence AgentSequence `json:"sequence"`

	// StopReason Stop reasons admitted as durable model-output events.
	StopReason ModelOutputStopReason `json:"stop_reason"`
	TurnID     AgentTurnID           `json:"turn_id"`

	// TurnSequence Positive per-agent event, turn, or live-frame sequence.
	TurnSequence AgentSequence `json:"turn_sequence"`

	// Usage Token counts the provider reported for one model call. Cache and reasoning counts are omitted when the provider reported none.
	Usage *ModelUsage `json:"usage,omitempty"`
}

ModelOutputEvent defines model for ModelOutputEvent.

type ModelOutputEventEventKind 

type ModelOutputEventEventKind string

ModelOutputEventEventKind defines model for ModelOutputEvent.EventKind. 

const (
	ModelOutput ModelOutputEventEventKind = "model_output"
)

Defines values for ModelOutputEventEventKind.

func (ModelOutputEventEventKind) Valid 

func (e ModelOutputEventEventKind) Valid() bool

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

type ModelOutputEventIsOpeningEvent 

type ModelOutputEventIsOpeningEvent bool

ModelOutputEventIsOpeningEvent defines model for ModelOutputEvent.IsOpeningEvent. 

const (
	ModelOutputEventIsOpeningEventFalse ModelOutputEventIsOpeningEvent = false
)

Defines values for ModelOutputEventIsOpeningEvent.

func (ModelOutputEventIsOpeningEvent) Valid 

func (e ModelOutputEventIsOpeningEvent) Valid() bool

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

type ModelOutputMessageStopDelta 

type ModelOutputMessageStopDelta struct {
	Kind ModelOutputMessageStopDeltaKind `json:"kind"`
	Stop struct {
		Reason ModelStopReason `json:"reason"`

		// Usage Token counts the provider reported for one model call. Cache and reasoning counts are omitted when the provider reported none.
		Usage ModelUsage `json:"usage"`
	} `json:"stop"`
}

ModelOutputMessageStopDelta defines model for ModelOutputMessageStopDelta.

type ModelOutputMessageStopDeltaKind 

type ModelOutputMessageStopDeltaKind string

ModelOutputMessageStopDeltaKind defines model for ModelOutputMessageStopDelta.Kind. 

const (
	MessageStop ModelOutputMessageStopDeltaKind = "message_stop"
)

Defines values for ModelOutputMessageStopDeltaKind.

func (ModelOutputMessageStopDeltaKind) Valid 

func (e ModelOutputMessageStopDeltaKind) Valid() bool

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

type ModelOutputStopReason 

type ModelOutputStopReason string

ModelOutputStopReason Stop reasons admitted as durable model-output events. 

const (
	ModelOutputStopReasonContentFilter ModelOutputStopReason = "content_filter"
	ModelOutputStopReasonEndTurn       ModelOutputStopReason = "end_turn"
	ModelOutputStopReasonError         ModelOutputStopReason = "error"
	ModelOutputStopReasonMaxTokens     ModelOutputStopReason = "max_tokens"
	ModelOutputStopReasonRefusal       ModelOutputStopReason = "refusal"
	ModelOutputStopReasonToolUse       ModelOutputStopReason = "tool_use"
)

Defines values for ModelOutputStopReason.

func (ModelOutputStopReason) Valid 

func (e ModelOutputStopReason) Valid() bool

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

type ModelOutputStreamBlock 

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

ModelOutputStreamBlock defines model for ModelOutputStreamBlock.

func (ModelOutputStreamBlock) AsAny 

func (t ModelOutputStreamBlock) AsAny() any

AsAny returns the member of ModelOutputStreamBlock named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (ModelOutputStreamBlock) AsModelOutputTextStreamBlock 

func (t ModelOutputStreamBlock) AsModelOutputTextStreamBlock() (ModelOutputTextStreamBlock, error)

AsModelOutputTextStreamBlock returns the union data inside the ModelOutputStreamBlock as a ModelOutputTextStreamBlock

func (ModelOutputStreamBlock) AsModelOutputThinkingStreamBlock 

func (t ModelOutputStreamBlock) AsModelOutputThinkingStreamBlock() (ModelOutputThinkingStreamBlock, error)

AsModelOutputThinkingStreamBlock returns the union data inside the ModelOutputStreamBlock as a ModelOutputThinkingStreamBlock

func (ModelOutputStreamBlock) AsModelOutputToolUseStreamBlock 

func (t ModelOutputStreamBlock) AsModelOutputToolUseStreamBlock() (ModelOutputToolUseStreamBlock, error)

AsModelOutputToolUseStreamBlock returns the union data inside the ModelOutputStreamBlock as a ModelOutputToolUseStreamBlock

func (ModelOutputStreamBlock) Discriminator 

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

func (*ModelOutputStreamBlock) FromModelOutputTextStreamBlock 

func (t *ModelOutputStreamBlock) FromModelOutputTextStreamBlock(v ModelOutputTextStreamBlock) error

FromModelOutputTextStreamBlock overwrites any union data inside the ModelOutputStreamBlock as the provided ModelOutputTextStreamBlock

func (*ModelOutputStreamBlock) FromModelOutputThinkingStreamBlock 

func (t *ModelOutputStreamBlock) FromModelOutputThinkingStreamBlock(v ModelOutputThinkingStreamBlock) error

FromModelOutputThinkingStreamBlock overwrites any union data inside the ModelOutputStreamBlock as the provided ModelOutputThinkingStreamBlock

func (*ModelOutputStreamBlock) FromModelOutputToolUseStreamBlock 

func (t *ModelOutputStreamBlock) FromModelOutputToolUseStreamBlock(v ModelOutputToolUseStreamBlock) error

FromModelOutputToolUseStreamBlock overwrites any union data inside the ModelOutputStreamBlock as the provided ModelOutputToolUseStreamBlock

func (ModelOutputStreamBlock) MarshalJSON 

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

func (*ModelOutputStreamBlock) MergeModelOutputTextStreamBlock 

func (t *ModelOutputStreamBlock) MergeModelOutputTextStreamBlock(v ModelOutputTextStreamBlock) error

MergeModelOutputTextStreamBlock performs a merge with any union data inside the ModelOutputStreamBlock, using the provided ModelOutputTextStreamBlock

func (*ModelOutputStreamBlock) MergeModelOutputThinkingStreamBlock 

func (t *ModelOutputStreamBlock) MergeModelOutputThinkingStreamBlock(v ModelOutputThinkingStreamBlock) error

MergeModelOutputThinkingStreamBlock performs a merge with any union data inside the ModelOutputStreamBlock, using the provided ModelOutputThinkingStreamBlock

func (*ModelOutputStreamBlock) MergeModelOutputToolUseStreamBlock 

func (t *ModelOutputStreamBlock) MergeModelOutputToolUseStreamBlock(v ModelOutputToolUseStreamBlock) error

MergeModelOutputToolUseStreamBlock performs a merge with any union data inside the ModelOutputStreamBlock, using the provided ModelOutputToolUseStreamBlock

func (*ModelOutputStreamBlock) UnmarshalJSON 

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

func (ModelOutputStreamBlock) ValueByDiscriminator 

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

type ModelOutputStreamDelta 

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

ModelOutputStreamDelta defines model for ModelOutputStreamDelta.

func (ModelOutputStreamDelta) AsAny 

func (t ModelOutputStreamDelta) AsAny() any

AsAny returns the member of ModelOutputStreamDelta named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (ModelOutputStreamDelta) AsModelOutputBlockStartDelta 

func (t ModelOutputStreamDelta) AsModelOutputBlockStartDelta() (ModelOutputBlockStartDelta, error)

AsModelOutputBlockStartDelta returns the union data inside the ModelOutputStreamDelta as a ModelOutputBlockStartDelta

func (ModelOutputStreamDelta) AsModelOutputBlockStopDelta 

func (t ModelOutputStreamDelta) AsModelOutputBlockStopDelta() (ModelOutputBlockStopDelta, error)

AsModelOutputBlockStopDelta returns the union data inside the ModelOutputStreamDelta as a ModelOutputBlockStopDelta

func (ModelOutputStreamDelta) AsModelOutputErrorDelta 

func (t ModelOutputStreamDelta) AsModelOutputErrorDelta() (ModelOutputErrorDelta, error)

AsModelOutputErrorDelta returns the union data inside the ModelOutputStreamDelta as a ModelOutputErrorDelta

func (ModelOutputStreamDelta) AsModelOutputMessageStopDelta 

func (t ModelOutputStreamDelta) AsModelOutputMessageStopDelta() (ModelOutputMessageStopDelta, error)

AsModelOutputMessageStopDelta returns the union data inside the ModelOutputStreamDelta as a ModelOutputMessageStopDelta

func (ModelOutputStreamDelta) AsModelOutputTextDelta 

func (t ModelOutputStreamDelta) AsModelOutputTextDelta() (ModelOutputTextDelta, error)

AsModelOutputTextDelta returns the union data inside the ModelOutputStreamDelta as a ModelOutputTextDelta

func (ModelOutputStreamDelta) AsModelOutputThinkingDelta 

func (t ModelOutputStreamDelta) AsModelOutputThinkingDelta() (ModelOutputThinkingDelta, error)

AsModelOutputThinkingDelta returns the union data inside the ModelOutputStreamDelta as a ModelOutputThinkingDelta

func (ModelOutputStreamDelta) AsModelOutputToolArgumentsDelta 

func (t ModelOutputStreamDelta) AsModelOutputToolArgumentsDelta() (ModelOutputToolArgumentsDelta, error)

AsModelOutputToolArgumentsDelta returns the union data inside the ModelOutputStreamDelta as a ModelOutputToolArgumentsDelta

func (ModelOutputStreamDelta) Discriminator 

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

func (*ModelOutputStreamDelta) FromModelOutputBlockStartDelta 

func (t *ModelOutputStreamDelta) FromModelOutputBlockStartDelta(v ModelOutputBlockStartDelta) error

FromModelOutputBlockStartDelta overwrites any union data inside the ModelOutputStreamDelta as the provided ModelOutputBlockStartDelta

func (*ModelOutputStreamDelta) FromModelOutputBlockStopDelta 

func (t *ModelOutputStreamDelta) FromModelOutputBlockStopDelta(v ModelOutputBlockStopDelta) error

FromModelOutputBlockStopDelta overwrites any union data inside the ModelOutputStreamDelta as the provided ModelOutputBlockStopDelta

func (*ModelOutputStreamDelta) FromModelOutputErrorDelta 

func (t *ModelOutputStreamDelta) FromModelOutputErrorDelta(v ModelOutputErrorDelta) error

FromModelOutputErrorDelta overwrites any union data inside the ModelOutputStreamDelta as the provided ModelOutputErrorDelta

func (*ModelOutputStreamDelta) FromModelOutputMessageStopDelta 

func (t *ModelOutputStreamDelta) FromModelOutputMessageStopDelta(v ModelOutputMessageStopDelta) error

FromModelOutputMessageStopDelta overwrites any union data inside the ModelOutputStreamDelta as the provided ModelOutputMessageStopDelta

func (*ModelOutputStreamDelta) FromModelOutputTextDelta 

func (t *ModelOutputStreamDelta) FromModelOutputTextDelta(v ModelOutputTextDelta) error

FromModelOutputTextDelta overwrites any union data inside the ModelOutputStreamDelta as the provided ModelOutputTextDelta

func (*ModelOutputStreamDelta) FromModelOutputThinkingDelta 

func (t *ModelOutputStreamDelta) FromModelOutputThinkingDelta(v ModelOutputThinkingDelta) error

FromModelOutputThinkingDelta overwrites any union data inside the ModelOutputStreamDelta as the provided ModelOutputThinkingDelta

func (*ModelOutputStreamDelta) FromModelOutputToolArgumentsDelta 

func (t *ModelOutputStreamDelta) FromModelOutputToolArgumentsDelta(v ModelOutputToolArgumentsDelta) error

FromModelOutputToolArgumentsDelta overwrites any union data inside the ModelOutputStreamDelta as the provided ModelOutputToolArgumentsDelta

func (ModelOutputStreamDelta) MarshalJSON 

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

func (*ModelOutputStreamDelta) MergeModelOutputBlockStartDelta 

func (t *ModelOutputStreamDelta) MergeModelOutputBlockStartDelta(v ModelOutputBlockStartDelta) error

MergeModelOutputBlockStartDelta performs a merge with any union data inside the ModelOutputStreamDelta, using the provided ModelOutputBlockStartDelta

func (*ModelOutputStreamDelta) MergeModelOutputBlockStopDelta 

func (t *ModelOutputStreamDelta) MergeModelOutputBlockStopDelta(v ModelOutputBlockStopDelta) error

MergeModelOutputBlockStopDelta performs a merge with any union data inside the ModelOutputStreamDelta, using the provided ModelOutputBlockStopDelta

func (*ModelOutputStreamDelta) MergeModelOutputErrorDelta 

func (t *ModelOutputStreamDelta) MergeModelOutputErrorDelta(v ModelOutputErrorDelta) error

MergeModelOutputErrorDelta performs a merge with any union data inside the ModelOutputStreamDelta, using the provided ModelOutputErrorDelta

func (*ModelOutputStreamDelta) MergeModelOutputMessageStopDelta 

func (t *ModelOutputStreamDelta) MergeModelOutputMessageStopDelta(v ModelOutputMessageStopDelta) error

MergeModelOutputMessageStopDelta performs a merge with any union data inside the ModelOutputStreamDelta, using the provided ModelOutputMessageStopDelta

func (*ModelOutputStreamDelta) MergeModelOutputTextDelta 

func (t *ModelOutputStreamDelta) MergeModelOutputTextDelta(v ModelOutputTextDelta) error

MergeModelOutputTextDelta performs a merge with any union data inside the ModelOutputStreamDelta, using the provided ModelOutputTextDelta

func (*ModelOutputStreamDelta) MergeModelOutputThinkingDelta 

func (t *ModelOutputStreamDelta) MergeModelOutputThinkingDelta(v ModelOutputThinkingDelta) error

MergeModelOutputThinkingDelta performs a merge with any union data inside the ModelOutputStreamDelta, using the provided ModelOutputThinkingDelta

func (*ModelOutputStreamDelta) MergeModelOutputToolArgumentsDelta 

func (t *ModelOutputStreamDelta) MergeModelOutputToolArgumentsDelta(v ModelOutputToolArgumentsDelta) error

MergeModelOutputToolArgumentsDelta performs a merge with any union data inside the ModelOutputStreamDelta, using the provided ModelOutputToolArgumentsDelta

func (*ModelOutputStreamDelta) UnmarshalJSON 

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

func (ModelOutputStreamDelta) ValueByDiscriminator 

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

type ModelOutputTextDelta 

type ModelOutputTextDelta struct {
	BlockIndex int                      `json:"block_index"`
	Delta      string                   `json:"delta"`
	Kind       ModelOutputTextDeltaKind `json:"kind"`
}

ModelOutputTextDelta defines model for ModelOutputTextDelta.

type ModelOutputTextDeltaKind 

type ModelOutputTextDeltaKind string

ModelOutputTextDeltaKind defines model for ModelOutputTextDelta.Kind. 

const (
	TextDelta ModelOutputTextDeltaKind = "text_delta"
)

Defines values for ModelOutputTextDeltaKind.

func (ModelOutputTextDeltaKind) Valid 

func (e ModelOutputTextDeltaKind) Valid() bool

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

type ModelOutputTextStreamBlock 

type ModelOutputTextStreamBlock struct {
	Kind ModelOutputTextStreamBlockKind `json:"kind"`
}

ModelOutputTextStreamBlock defines model for ModelOutputTextStreamBlock.

type ModelOutputTextStreamBlockKind 

type ModelOutputTextStreamBlockKind string

ModelOutputTextStreamBlockKind defines model for ModelOutputTextStreamBlock.Kind. 

const (
	ModelOutputTextStreamBlockKindText ModelOutputTextStreamBlockKind = "text"
)

Defines values for ModelOutputTextStreamBlockKind.

func (ModelOutputTextStreamBlockKind) Valid 

func (e ModelOutputTextStreamBlockKind) Valid() bool

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

type ModelOutputThinkingDelta 

type ModelOutputThinkingDelta struct {
	BlockIndex int                          `json:"block_index"`
	Delta      string                       `json:"delta"`
	Kind       ModelOutputThinkingDeltaKind `json:"kind"`
}

ModelOutputThinkingDelta defines model for ModelOutputThinkingDelta.

type ModelOutputThinkingDeltaKind 

type ModelOutputThinkingDeltaKind string

ModelOutputThinkingDeltaKind defines model for ModelOutputThinkingDelta.Kind. 

const (
	ThinkingDelta ModelOutputThinkingDeltaKind = "thinking_delta"
)

Defines values for ModelOutputThinkingDeltaKind.

func (ModelOutputThinkingDeltaKind) Valid 

func (e ModelOutputThinkingDeltaKind) Valid() bool

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

type ModelOutputThinkingStreamBlock 

type ModelOutputThinkingStreamBlock struct {
	Kind ModelOutputThinkingStreamBlockKind `json:"kind"`
}

ModelOutputThinkingStreamBlock defines model for ModelOutputThinkingStreamBlock.

type ModelOutputThinkingStreamBlockKind 

type ModelOutputThinkingStreamBlockKind string

ModelOutputThinkingStreamBlockKind defines model for ModelOutputThinkingStreamBlock.Kind. 

const (
	Thinking ModelOutputThinkingStreamBlockKind = "thinking"
)

Defines values for ModelOutputThinkingStreamBlockKind.

func (ModelOutputThinkingStreamBlockKind) Valid 

func (e ModelOutputThinkingStreamBlockKind) Valid() bool

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

type ModelOutputToolArgumentsDelta 

type ModelOutputToolArgumentsDelta struct {
	BlockIndex int                               `json:"block_index"`
	Delta      string                            `json:"delta"`
	Kind       ModelOutputToolArgumentsDeltaKind `json:"kind"`
}

ModelOutputToolArgumentsDelta defines model for ModelOutputToolArgumentsDelta.

type ModelOutputToolArgumentsDeltaKind 

type ModelOutputToolArgumentsDeltaKind string

ModelOutputToolArgumentsDeltaKind defines model for ModelOutputToolArgumentsDelta.Kind. 

const (
	ToolArgumentsDelta ModelOutputToolArgumentsDeltaKind = "tool_arguments_delta"
)

Defines values for ModelOutputToolArgumentsDeltaKind.

func (ModelOutputToolArgumentsDeltaKind) Valid 

func (e ModelOutputToolArgumentsDeltaKind) Valid() bool

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

type ModelOutputToolUseStreamBlock 

type ModelOutputToolUseStreamBlock struct {
	Kind       ModelOutputToolUseStreamBlockKind `json:"kind"`
	ToolCallID ToolCallID                        `json:"tool_call_id"`
	ToolName   string                            `json:"tool_name"`
}

ModelOutputToolUseStreamBlock defines model for ModelOutputToolUseStreamBlock.

type ModelOutputToolUseStreamBlockKind 

type ModelOutputToolUseStreamBlockKind string

ModelOutputToolUseStreamBlockKind defines model for ModelOutputToolUseStreamBlock.Kind. 

const (
	ToolUse ModelOutputToolUseStreamBlockKind = "tool_use"
)

Defines values for ModelOutputToolUseStreamBlockKind.

func (ModelOutputToolUseStreamBlockKind) Valid 

func (e ModelOutputToolUseStreamBlockKind) Valid() bool

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

type ModelProviderAPIVariant 

type ModelProviderAPIVariant string

ModelProviderAPIVariant Provider-specific flavor of the API format: default, openrouter, or bedrock. 

const (
	Bedrock    ModelProviderAPIVariant = "bedrock"
	Default    ModelProviderAPIVariant = "default"
	Openrouter ModelProviderAPIVariant = "openrouter"
)

Defines values for ModelProviderAPIVariant.

func (ModelProviderAPIVariant) Valid 

func (e ModelProviderAPIVariant) Valid() bool

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

type ModelProviderAPIVariantResponse 

type ModelProviderAPIVariantResponse = string

ModelProviderAPIVariantResponse defines model for ModelProviderAPIVariantResponse.

type ModelProviderAuthKind 

type ModelProviderAuthKind string

ModelProviderAuthKind How the credential is sent: bearer_token, api_key_header, or sigv4 (AWS). 

const (
	APIKeyHeader       ModelProviderAuthKind = "api_key_header"
	BearerToken        ModelProviderAuthKind = "bearer_token"
	ModelProviderSigV4 ModelProviderAuthKind = "sigv4"
)

Defines values for ModelProviderAuthKind.

func (ModelProviderAuthKind) Valid 

func (e ModelProviderAuthKind) Valid() bool

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

type ModelProviderAuthKindResponse 

type ModelProviderAuthKindResponse = string

ModelProviderAuthKindResponse defines model for ModelProviderAuthKindResponse.

type ModelProviderConfig 

type ModelProviderConfig struct {
	// APIFormat Wire protocol the model endpoint speaks: openai-responses, openai-chat-completions, or anthropic-messages.
	APIFormat  ModelAPIFormat                  `json:"api_format"`
	APIVariant ModelProviderAPIVariantResponse `json:"api_variant"`
	AuthKind   ModelProviderAuthKindResponse   `json:"auth_kind"`

	// AuthOptions Non-secret authentication settings for this provider config.
	AuthOptions struct {
		HeaderName *string `json:"header_name,omitempty"`
		Region     *string `json:"region,omitempty"`
		Service    *string `json:"service,omitempty"`
	} `json:"auth_options"`

	// BaseURL Provider endpoint base URL. Normal API mode uses public HTTPS endpoints; localhost and loopback endpoints are only for insecure dev-mode configs.
	BaseURL   string    `json:"base_url"`
	CreatedAt Timestamp `json:"created_at"`

	// CredentialSecretID Secret ID (sec_...).
	CredentialSecretID SecretID `json:"credential_secret_id"`
	EndpointPath       string   `json:"endpoint_path"`

	// Headers Extra HTTP headers sent with every request to this provider.
	Headers       map[string]string     `json:"headers"`
	ID            ModelProviderConfigID `json:"id"`
	IdleTimeoutMs int                   `json:"idle_timeout_ms"`

	// ManagementKind Lifecycle owner. Tenant-managed resources can be changed through tenant APIs. Cluster-managed resources are installed and lifecycle-managed by the control plane; individual APIs may explicitly expose tenant-editable settings.
	ManagementKind ManagementKind `json:"management_kind"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name             ResourceName   `json:"name"`
	OrgID            OrganizationID `json:"org_id"`
	RequestTimeoutMs int            `json:"request_timeout_ms"`

	// SecretHeaders Extra HTTP headers whose values come from the referenced secrets.
	SecretHeaders map[string]SecretID `json:"secret_headers"`
	UpdatedAt     Timestamp           `json:"updated_at"`
}

ModelProviderConfig defines model for ModelProviderConfig.

type ModelProviderConfigID 

type ModelProviderConfigID = string

ModelProviderConfigID defines model for ModelProviderConfigID.

type ModelProviderConfigList 

type ModelProviderConfigList struct {
	Data       []ModelProviderConfig `json:"data"`
	NextCursor *string               `json:"next_cursor"`
}

ModelProviderConfigList defines model for ModelProviderConfigList.

type ModelStopReason 

type ModelStopReason string

ModelStopReason defines model for ModelStopReason. 

const (
	ModelStopReasonContentFilter ModelStopReason = "content_filter"
	ModelStopReasonContextWindow ModelStopReason = "context_window"
	ModelStopReasonEndTurn       ModelStopReason = "end_turn"
	ModelStopReasonMaxTokens     ModelStopReason = "max_tokens"
	ModelStopReasonPause         ModelStopReason = "pause"
	ModelStopReasonRefusal       ModelStopReason = "refusal"
	ModelStopReasonToolUse       ModelStopReason = "tool_use"
	ModelStopReasonUnknown       ModelStopReason = "unknown"
)

Defines values for ModelStopReason.

func (ModelStopReason) Valid 

func (e ModelStopReason) Valid() bool

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

type ModelToolCallContentBlock 

type ModelToolCallContentBlock struct {
	// Input Non-null JSON object containing the arguments emitted for a tool call.
	Input ToolInput `json:"input"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata   *ContentBlockMetadata `json:"metadata,omitempty"`
	Name       string                `json:"name"`
	ToolCallID ToolCallID            `json:"tool_call_id"`

	// ToolType Identifies who manages execution. Built-in and MCP calls are platform-managed; custom calls wait for an external consumer to submit their result.
	ToolType ToolCallType                  `json:"tool_type"`
	Type     ModelToolCallContentBlockType `json:"type"`
}

ModelToolCallContentBlock defines model for ModelToolCallContentBlock.

type ModelToolCallContentBlockType 

type ModelToolCallContentBlockType string

ModelToolCallContentBlockType defines model for ModelToolCallContentBlock.Type. 

const (
	ModelToolCallContentBlockTypeToolCall ModelToolCallContentBlockType = "tool_call"
)

Defines values for ModelToolCallContentBlockType.

func (ModelToolCallContentBlockType) Valid 

func (e ModelToolCallContentBlockType) Valid() bool

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

type ModelUsage 

type ModelUsage struct {
	CacheReadInputTokens  *int `json:"cache_read_input_tokens,omitempty"`
	CacheWriteInputTokens *int `json:"cache_write_input_tokens,omitempty"`
	InputTokensTotal      *int `json:"input_tokens_total,omitempty"`
	OutputTokensTotal     *int `json:"output_tokens_total,omitempty"`
	ReasoningOutputTokens *int `json:"reasoning_output_tokens,omitempty"`
	UncachedInputTokens   *int `json:"uncached_input_tokens,omitempty"`
}

ModelUsage Token counts the provider reported for one model call. Cache and reasoning counts are omitted when the provider reported none.

type ModelUsageTotals 

type ModelUsageTotals struct {
	Cost       UsageCostTotals `json:"cost"`
	Model      UsageModel      `json:"model"`
	ModelCalls int64           `json:"model_calls"`

	// Purpose What the calls were for. `turn` is ordinary agent model calls; `title` is the automatic session-title request, made with the session's own model credentials; `harness` is the model requests of an ACP harness (agent config `harness.kind: acp`) through the platform's harness model endpoint. A model used for several appears once per purpose.
	Purpose *ModelUsageTotalsPurpose `json:"purpose,omitempty"`

	// Tokens Summed token counts across the tallied model calls. Input totals are the sum of uncached, cache-read, and cache-write tokens; output totals include reasoning tokens.
	Tokens UsageTokenTotals `json:"tokens"`
}

ModelUsageTotals defines model for ModelUsageTotals.

type ModelUsageTotalsPurpose 

type ModelUsageTotalsPurpose string

ModelUsageTotalsPurpose What the calls were for. `turn` is ordinary agent model calls; `title` is the automatic session-title request, made with the session's own model credentials; `harness` is the model requests of an ACP harness (agent config `harness.kind: acp`) through the platform's harness model endpoint. A model used for several appears once per purpose. 

const (
	Harness ModelUsageTotalsPurpose = "harness"
	Title   ModelUsageTotalsPurpose = "title"
	Turn    ModelUsageTotalsPurpose = "turn"
)

Defines values for ModelUsageTotalsPurpose.

func (ModelUsageTotalsPurpose) Valid 

func (e ModelUsageTotalsPurpose) Valid() bool

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

type MoveQueuedBacklogInputJSONRequestBody 

type MoveQueuedBacklogInputJSONRequestBody = MoveQueuedBacklogInputRequest

MoveQueuedBacklogInputJSONRequestBody defines body for MoveQueuedBacklogInput for application/json ContentType.

type MoveQueuedBacklogInputRequest 

type MoveQueuedBacklogInputRequest struct {
	AnchorInputID *AgentInputID                         `json:"anchor_input_id,omitempty"`
	Position      MoveQueuedBacklogInputRequestPosition `json:"position"`
}

MoveQueuedBacklogInputRequest defines model for MoveQueuedBacklogInputRequest.

type MoveQueuedBacklogInputRequestPosition 

type MoveQueuedBacklogInputRequestPosition string

MoveQueuedBacklogInputRequestPosition defines model for MoveQueuedBacklogInputRequest.Position. 

const (
	After  MoveQueuedBacklogInputRequestPosition = "after"
	Back   MoveQueuedBacklogInputRequestPosition = "back"
	Before MoveQueuedBacklogInputRequestPosition = "before"
	Front  MoveQueuedBacklogInputRequestPosition = "front"
)

Defines values for MoveQueuedBacklogInputRequestPosition.

func (MoveQueuedBacklogInputRequestPosition) Valid 

func (e MoveQueuedBacklogInputRequestPosition) Valid() bool

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

type NotFound 

type NotFound = ErrorBody

NotFound defines model for NotFound.

type OAuthRefreshSecretMaterial 

type OAuthRefreshSecretMaterial struct {
	ClientID     string  `json:"client_id"`
	ClientSecret *string `json:"client_secret,omitempty"`
	RefreshToken string  `json:"refresh_token"`
	Resource     string  `json:"resource"`

	// TokenEndpoint Must use HTTPS, except that HTTP is allowed for loopback hosts during local development.
	TokenEndpoint string `json:"token_endpoint"`
}

OAuthRefreshSecretMaterial defines model for OAuthRefreshSecretMaterial.

type OAuthTokenSetSecretMaterial 

type OAuthTokenSetSecretMaterial struct {
	AccessToken                 string                          `json:"access_token"`
	AccessTokenExpiresInSeconds *int32                          `json:"access_token_expires_in_seconds,omitempty"`
	IDToken                     *string                         `json:"id_token,omitempty"`
	Kind                        OAuthTokenSetSecretMaterialKind `json:"kind"`
	McpURL                      *string                         `json:"mcp_url,omitempty"`
	Refresh                     *OAuthRefreshSecretMaterial     `json:"refresh,omitempty"`
	Scopes                      *string                         `json:"scopes,omitempty"`
	TokenType                   *string                         `json:"token_type,omitempty"`
}

OAuthTokenSetSecretMaterial defines model for OAuthTokenSetSecretMaterial.

type OAuthTokenSetSecretMaterialKind 

type OAuthTokenSetSecretMaterialKind string

OAuthTokenSetSecretMaterialKind defines model for OAuthTokenSetSecretMaterial.Kind. 

const (
	OauthTokenSet OAuthTokenSetSecretMaterialKind = "oauth_token_set"
)

Defines values for OAuthTokenSetSecretMaterialKind.

func (OAuthTokenSetSecretMaterialKind) Valid 

func (e OAuthTokenSetSecretMaterialKind) Valid() bool

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

type OKResponse 

type OKResponse struct {
	Ok bool `json:"ok"`
}

OKResponse defines model for OKResponse.

type OrgAPIKey 

type OrgAPIKey struct {
	CreatedAt       Timestamp   `json:"created_at"`
	CreatedByUserID UserID      `json:"created_by_user_id"`
	ID              OrgAPIKeyID `json:"id"`
	LastUsedAt      *Timestamp  `json:"last_used_at"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name  ResourceName   `json:"name"`
	OrgID OrganizationID `json:"org_id"`

	// OrgRole The key's org role (admin or member). Empty for revoked keys.
	OrgRole   string     `json:"org_role"`
	RevokedAt *Timestamp `json:"revoked_at"`

	// TokenID Stable non-secret display identifier. It is not embedded in the bearer token.
	TokenID   string    `json:"token_id"`
	UpdatedAt Timestamp `json:"updated_at"`
}

OrgAPIKey defines model for OrgAPIKey.

type OrgAPIKeyID 

type OrgAPIKeyID = string

OrgAPIKeyID defines model for OrgAPIKeyID.

type OrgAPIKeyListParams 

type OrgAPIKeyListParams struct {
	Limit  *PageLimit
	Cursor *PageCursor
}

OrgAPIKeyListParams are the query, header and body fields of listOrgAPIKeys.

type OrgAPIKeyNewParams 

type OrgAPIKeyNewParams struct {
	Name    ResourceName
	OrgRole OrgAPIKeyRole
}

OrgAPIKeyNewParams are the query, header and body fields of createOrgAPIKey.

type OrgAPIKeyProjectService 

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

OrgAPIKeyProjectService groups the orgs.apiKeys.projects methods.

func (*OrgAPIKeyProjectService) List 

func (s *OrgAPIKeyProjectService) List(ctx context.Context, keyID string, opts ...option.RequestOption) (*ListProjectMembershipGrantsResponse, error)

List calls listOrgAPIKeyProjectAccess: GET /orgs/{orgID}/api-keys/{keyID}/projects.

func (*OrgAPIKeyProjectService) Remove 

func (s *OrgAPIKeyProjectService) Remove(ctx context.Context, keyID string, projectID string, opts ...option.RequestOption) error

Remove calls removeOrgAPIKeyProjectRole: DELETE /orgs/{orgID}/api-keys/{keyID}/projects/{projectID}.

func (*OrgAPIKeyProjectService) Set 

func (s *OrgAPIKeyProjectService) Set(ctx context.Context, keyID string, projectID string, params OrgAPIKeyProjectSetParams, opts ...option.RequestOption) (*ProjectMembershipGrant, error)

Set calls setOrgAPIKeyProjectRole: PUT /orgs/{orgID}/api-keys/{keyID}/projects/{projectID}.

type OrgAPIKeyProjectSetParams 

type OrgAPIKeyProjectSetParams struct {
	Role string
}

OrgAPIKeyProjectSetParams are the query, header and body fields of setOrgAPIKeyProjectRole.

type OrgAPIKeyRole 

type OrgAPIKeyRole string

OrgAPIKeyRole The key's org role. Org API keys can never hold the owner role. 

const (
	Admin  OrgAPIKeyRole = "admin"
	Member OrgAPIKeyRole = "member"
)

Defines values for OrgAPIKeyRole.

func (OrgAPIKeyRole) Valid 

func (e OrgAPIKeyRole) Valid() bool

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

type OrgAPIKeyService 

type OrgAPIKeyService struct {
	Projects *OrgAPIKeyProjectService
	// contains filtered or unexported fields
}

OrgAPIKeyService groups the orgs.apiKeys methods.

func (*OrgAPIKeyService) Get 

func (s *OrgAPIKeyService) Get(ctx context.Context, keyID string, opts ...option.RequestOption) (*OrgAPIKey, error)

Get calls getOrgAPIKey: GET /orgs/{orgID}/api-keys/{keyID}.

func (*OrgAPIKeyService) List 

func (s *OrgAPIKeyService) List(ctx context.Context, params OrgAPIKeyListParams, opts ...option.RequestOption) (*CursorPage[OrgAPIKey], error)

List calls listOrgAPIKeys: GET /orgs/{orgID}/api-keys.

func (*OrgAPIKeyService) ListAutoPaging 

func (s *OrgAPIKeyService) ListAutoPaging(ctx context.Context, params OrgAPIKeyListParams, opts ...option.RequestOption) *CursorPageAutoPager[OrgAPIKey]

ListAutoPaging iterates every item of listOrgAPIKeys across pages.

func (*OrgAPIKeyService) New 

func (s *OrgAPIKeyService) New(ctx context.Context, params OrgAPIKeyNewParams, opts ...option.RequestOption) (*CreateOrgAPIKeyResponse, error)

New calls createOrgAPIKey: POST /orgs/{orgID}/api-keys.

func (*OrgAPIKeyService) Revoke 

func (s *OrgAPIKeyService) Revoke(ctx context.Context, keyID string, opts ...option.RequestOption) (*OrgAPIKey, error)

Revoke calls revokeOrgAPIKey: POST /orgs/{orgID}/api-keys/{keyID}/revoke.

func (*OrgAPIKeyService) Update 

func (s *OrgAPIKeyService) Update(ctx context.Context, keyID string, params OrgAPIKeyUpdateParams, opts ...option.RequestOption) (*OrgAPIKey, error)

Update calls updateOrgAPIKey: PATCH /orgs/{orgID}/api-keys/{keyID}.

type OrgAPIKeyUpdateParams 

type OrgAPIKeyUpdateParams struct {
	Name    *ResourceName
	OrgRole *OrgAPIKeyRole
}

OrgAPIKeyUpdateParams are the query, header and body fields of updateOrgAPIKey.

type OrgAgentListParams 

type OrgAgentListParams struct {
	Name             *ResourceNameFilter
	AgentProfileID   *AgentProfileID
	ParentAgentID    *AgentID
	IncludeSubagents *bool
	IncludeArchived  *bool
	IncludeUsage     *AgentIncludeUsage
	Sort             *ResourceListSort
	Limit            *PageLimit
	Cursor           *PageCursor
}

OrgAgentListParams are the query, header and body fields of listOrgAgents.

type OrgAgentProfileListParams 

type OrgAgentProfileListParams struct {
	Name         *ResourceNameFilter
	IncludeStats *AgentProfileIncludeStats
	StatsSince   *AgentProfileStatsSince
	Sort         *ResourceListSort
	Limit        *PageLimit
	Cursor       *PageCursor
}

OrgAgentProfileListParams are the query, header and body fields of listOrgAgentProfiles.

type OrgAgentProfileService 

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

OrgAgentProfileService groups the orgs.agentProfiles methods.

func (*OrgAgentProfileService) List 

func (s *OrgAgentProfileService) List(ctx context.Context, params OrgAgentProfileListParams, opts ...option.RequestOption) (*CursorPage[AgentProfileSummary], error)

List calls listOrgAgentProfiles: GET /orgs/{orgID}/agent-profiles.

func (*OrgAgentProfileService) ListAutoPaging 

func (s *OrgAgentProfileService) ListAutoPaging(ctx context.Context, params OrgAgentProfileListParams, opts ...option.RequestOption) *CursorPageAutoPager[AgentProfileSummary]

ListAutoPaging iterates every item of listOrgAgentProfiles across pages.

type OrgAgentService 

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

OrgAgentService groups the orgs.agents methods.

func (*OrgAgentService) List 

func (s *OrgAgentService) List(ctx context.Context, params OrgAgentListParams, opts ...option.RequestOption) (*CursorPage[Agent], error)

List calls listOrgAgents: GET /orgs/{orgID}/agents.

func (*OrgAgentService) ListAutoPaging 

func (s *OrgAgentService) ListAutoPaging(ctx context.Context, params OrgAgentListParams, opts ...option.RequestOption) *CursorPageAutoPager[Agent]

ListAutoPaging iterates every item of listOrgAgents across pages.

type OrgIntegrationListParams 

type OrgIntegrationListParams struct {
	Name   *ResourceNameFilter
	Limit  *PageLimit
	Cursor *PageCursor
}

OrgIntegrationListParams are the query, header and body fields of listOrgIntegrations.

type OrgIntegrationService 

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

OrgIntegrationService groups the orgs.integrations methods.

func (*OrgIntegrationService) List 

func (s *OrgIntegrationService) List(ctx context.Context, params OrgIntegrationListParams, opts ...option.RequestOption) (*CursorPage[Integration], error)

List calls listOrgIntegrations: GET /orgs/{orgID}/integrations.

func (*OrgIntegrationService) ListAutoPaging 

func (s *OrgIntegrationService) ListAutoPaging(ctx context.Context, params OrgIntegrationListParams, opts ...option.RequestOption) *CursorPageAutoPager[Integration]

ListAutoPaging iterates every item of listOrgIntegrations across pages.

type OrgInvitation 

type OrgInvitation struct {
	CreatedAt Timestamp           `json:"created_at"`
	Email     openapi_types.Email `json:"email"`
	ID        OrgInvitationID     `json:"id"`
	OrgID     OrganizationID      `json:"org_id"`

	// OrgName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	OrgName ResourceName `json:"org_name"`
	OrgRole string       `json:"org_role"`
}

OrgInvitation defines model for OrgInvitation.

type OrgInvitationID 

type OrgInvitationID = string

OrgInvitationID defines model for OrgInvitationID.

type OrgInvitationListParams 

type OrgInvitationListParams struct {
	Limit  *PageLimit
	Cursor *PageCursor
}

OrgInvitationListParams are the query, header and body fields of listOrgInvitations.

type OrgInvitationNewParams 

type OrgInvitationNewParams struct {
	Email openapi_types.Email
	Role  string
}

OrgInvitationNewParams are the query, header and body fields of createOrgInvitation.

type OrgInvitationService 

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

OrgInvitationService groups the orgs.invitations methods.

func (*OrgInvitationService) Delete 

func (s *OrgInvitationService) Delete(ctx context.Context, invitationID string, opts ...option.RequestOption) error

Delete calls deleteOrgInvitation: DELETE /orgs/{orgID}/invitations/{invitationID}.

func (*OrgInvitationService) List 

func (s *OrgInvitationService) List(ctx context.Context, params OrgInvitationListParams, opts ...option.RequestOption) (*CursorPage[OrgInvitation], error)

List calls listOrgInvitations: GET /orgs/{orgID}/invitations.

func (*OrgInvitationService) ListAutoPaging 

func (s *OrgInvitationService) ListAutoPaging(ctx context.Context, params OrgInvitationListParams, opts ...option.RequestOption) *CursorPageAutoPager[OrgInvitation]

ListAutoPaging iterates every item of listOrgInvitations across pages.

func (*OrgInvitationService) New 

func (s *OrgInvitationService) New(ctx context.Context, params OrgInvitationNewParams, opts ...option.RequestOption) (*OrgInvitation, error)

New calls createOrgInvitation: POST /orgs/{orgID}/invitations.

type OrgMachineConnectParams 

type OrgMachineConnectParams struct {
	Cwd         *string
	Description *string
	DisplayName ResourceName
	Env         *map[string]string
	Metadata    *MachineMetadata
	ProjectIDs  *[]ProjectID
	SecretEnv   *map[string]SecretID
	TokenName   *ResourceName
}

OrgMachineConnectParams are the query, header and body fields of connectBYOMachine.

type OrgMachineDaemonTokenListParams 

type OrgMachineDaemonTokenListParams struct {
	Limit  *PageLimit
	Cursor *PageCursor
}

OrgMachineDaemonTokenListParams are the query, header and body fields of listBYOMachineDaemonTokens.

type OrgMachineDaemonTokenNewParams 

type OrgMachineDaemonTokenNewParams struct {
	Metadata *Metadata
	Name     *ResourceName
}

OrgMachineDaemonTokenNewParams are the query, header and body fields of createBYOMachineDaemonToken.

type OrgMachineDaemonTokenService 

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

OrgMachineDaemonTokenService groups the orgs.machines.daemonTokens methods.

func (*OrgMachineDaemonTokenService) List 

func (s *OrgMachineDaemonTokenService) List(ctx context.Context, machineID string, params OrgMachineDaemonTokenListParams, opts ...option.RequestOption) (*CursorPage[MachineDaemonToken], error)

List calls listBYOMachineDaemonTokens: GET /orgs/{orgID}/machines/{machineID}/daemon-tokens.

func (*OrgMachineDaemonTokenService) ListAutoPaging 

func (s *OrgMachineDaemonTokenService) ListAutoPaging(ctx context.Context, machineID string, params OrgMachineDaemonTokenListParams, opts ...option.RequestOption) *CursorPageAutoPager[MachineDaemonToken]

ListAutoPaging iterates every item of listBYOMachineDaemonTokens across pages.

func (*OrgMachineDaemonTokenService) New 

func (s *OrgMachineDaemonTokenService) New(ctx context.Context, machineID string, params OrgMachineDaemonTokenNewParams, opts ...option.RequestOption) (*CreateMachineDaemonTokenResponse, error)

New calls createBYOMachineDaemonToken: POST /orgs/{orgID}/machines/{machineID}/daemon-tokens.

func (*OrgMachineDaemonTokenService) Revoke 

func (s *OrgMachineDaemonTokenService) Revoke(ctx context.Context, machineID string, tokenID string, opts ...option.RequestOption) (*MachineDaemonToken, error)

Revoke calls revokeMachineDaemonToken: POST /orgs/{orgID}/machines/{machineID}/daemon-tokens/{tokenID}/revoke.

type OrgMachineListParams 

type OrgMachineListParams struct {
	Name          *ResourceNameFilter
	SourceKind    *MachineSourceKindFilter
	MachinePoolID *MachinePoolID
	Sort          *ResourceListSort
	Limit         *PageLimit
	Cursor        *PageCursor
}

OrgMachineListParams are the query, header and body fields of listVisibleMachines.

type OrgMachineNewParams 

type OrgMachineNewParams struct {
	Cwd         *string
	Description *string
	DisplayName ResourceName
	Env         *map[string]string
	Metadata    *MachineMetadata
	SecretEnv   *map[string]SecretID
}

OrgMachineNewParams are the query, header and body fields of createMachine.

type OrgMachinePoolCheckConnectionParams 

type OrgMachinePoolCheckConnectionParams struct {
	DefaultMachineProviderOptions *map[string]interface{}
	Provider                      string
	ProviderAuthSecretID          SecretID
	ProviderConfig                *map[string]interface{}
}

OrgMachinePoolCheckConnectionParams are the query, header and body fields of checkMachinePoolConnection.

type OrgMachinePoolListParams 

type OrgMachinePoolListParams struct {
	Name   *ResourceNameFilter
	Sort   *ResourceListSort
	Limit  *PageLimit
	Cursor *PageCursor
}

OrgMachinePoolListParams are the query, header and body fields of listMachinePools.

type OrgMachinePoolNewParams 

type OrgMachinePoolNewParams struct {
	ArchiveAfterPausedDays        *int32
	DefaultCwd                    *string
	DefaultMachineCPU             *int32
	DefaultMachineEnv             *map[string]string
	DefaultMachineMemoryMb        *int32
	DefaultMachineProviderOptions map[string]interface{}
	DefaultMachineSecretEnv       *map[string]SecretID
	DeleteAfterIdleMinutes        *int32
	DeleteAfterPausedDays         *int32
	Description                   *string
	MaxMachineCPU                 *int32
	MaxMachineMemoryMb            *int32
	MaxTotalCPU                   *int32
	MaxTotalMachines              int32
	MaxTotalMemoryMb              *int32
	Metadata                      *MachineMetadata
	MinMachineCPU                 *int32
	MinMachineMemoryMb            *int32
	Name                          ResourceName
	PauseAfterIdleMinutes         *int32
	Provider                      string
	ProviderAuthSecretID          SecretID
	ProviderConfig                *map[string]interface{}
	RuntimeProtectionEnabled      *bool
}

OrgMachinePoolNewParams are the query, header and body fields of createMachinePool.

type OrgMachinePoolService 

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

OrgMachinePoolService groups the orgs.machinePools methods.

func (*OrgMachinePoolService) CheckConnection 

func (s *OrgMachinePoolService) CheckConnection(ctx context.Context, params OrgMachinePoolCheckConnectionParams, opts ...option.RequestOption) error

CheckConnection calls checkMachinePoolConnection: POST /orgs/{orgID}/machine-pools/check-connection.

func (*OrgMachinePoolService) Delete 

func (s *OrgMachinePoolService) Delete(ctx context.Context, poolID string, opts ...option.RequestOption) error

Delete calls deleteMachinePool: DELETE /orgs/{orgID}/machine-pools/{poolID}.

func (*OrgMachinePoolService) Get 

func (s *OrgMachinePoolService) Get(ctx context.Context, poolID string, opts ...option.RequestOption) (*MachinePool, error)

Get calls getMachinePool: GET /orgs/{orgID}/machine-pools/{poolID}.

func (*OrgMachinePoolService) List 

func (s *OrgMachinePoolService) List(ctx context.Context, params OrgMachinePoolListParams, opts ...option.RequestOption) (*CursorPage[MachinePool], error)

List calls listMachinePools: GET /orgs/{orgID}/machine-pools.

func (*OrgMachinePoolService) ListAutoPaging 

func (s *OrgMachinePoolService) ListAutoPaging(ctx context.Context, params OrgMachinePoolListParams, opts ...option.RequestOption) *CursorPageAutoPager[MachinePool]

ListAutoPaging iterates every item of listMachinePools across pages.

func (*OrgMachinePoolService) New 

func (s *OrgMachinePoolService) New(ctx context.Context, params OrgMachinePoolNewParams, opts ...option.RequestOption) (*MachinePool, error)

New calls createMachinePool: POST /orgs/{orgID}/machine-pools.

func (*OrgMachinePoolService) Update 

func (s *OrgMachinePoolService) Update(ctx context.Context, poolID string, params OrgMachinePoolUpdateParams, opts ...option.RequestOption) (*MachinePool, error)

Update calls updateMachinePool: PUT /orgs/{orgID}/machine-pools/{poolID}.

type OrgMachinePoolUpdateParams 

type OrgMachinePoolUpdateParams struct {
	ArchiveAfterPausedDays        *int32
	DefaultCwd                    *string
	DefaultMachineCPU             *int32
	DefaultMachineEnv             *map[string]string
	DefaultMachineMemoryMb        *int32
	DefaultMachineProviderOptions *map[string]interface{}
	DefaultMachineSecretEnv       *map[string]SecretID
	DeleteAfterIdleMinutes        *int32
	DeleteAfterPausedDays         *int32
	Description                   *string
	MaxMachineCPU                 *int32
	MaxMachineMemoryMb            *int32
	MaxTotalCPU                   *int32
	MaxTotalMachines              *int32
	MaxTotalMemoryMb              *int32
	Metadata                      *MachineMetadata
	MinMachineCPU                 *int32
	MinMachineMemoryMb            *int32
	Name                          *ResourceName
	PauseAfterIdleMinutes         *int32
	ProviderAuthSecretID          *SecretID
	ProviderConfig                *map[string]interface{}
	RuntimeProtectionEnabled      *bool
}

OrgMachinePoolUpdateParams are the query, header and body fields of updateMachinePool.

type OrgMachineService 

type OrgMachineService struct {
	DaemonTokens *OrgMachineDaemonTokenService
	// contains filtered or unexported fields
}

OrgMachineService groups the orgs.machines methods.

func (*OrgMachineService) Connect 

func (s *OrgMachineService) Connect(ctx context.Context, params OrgMachineConnectParams, opts ...option.RequestOption) (*ConnectBYOMachineResponse, error)

Connect calls connectBYOMachine: POST /orgs/{orgID}/machines/connect.

func (*OrgMachineService) Delete 

func (s *OrgMachineService) Delete(ctx context.Context, machineID string, opts ...option.RequestOption) error

Delete calls deleteMachine: DELETE /orgs/{orgID}/machines/{machineID}.

func (*OrgMachineService) Get 

func (s *OrgMachineService) Get(ctx context.Context, machineID string, opts ...option.RequestOption) (*Machine, error)

Get calls getMachine: GET /orgs/{orgID}/machines/{machineID}.

func (*OrgMachineService) List 

func (s *OrgMachineService) List(ctx context.Context, params OrgMachineListParams, opts ...option.RequestOption) (*CursorPage[VisibleMachine], error)

List calls listVisibleMachines: GET /orgs/{orgID}/machines.

func (*OrgMachineService) ListAutoPaging 

func (s *OrgMachineService) ListAutoPaging(ctx context.Context, params OrgMachineListParams, opts ...option.RequestOption) *CursorPageAutoPager[VisibleMachine]

ListAutoPaging iterates every item of listVisibleMachines across pages.

func (*OrgMachineService) New 

func (s *OrgMachineService) New(ctx context.Context, params OrgMachineNewParams, opts ...option.RequestOption) (*Machine, error)

New calls createMachine: POST /orgs/{orgID}/machines.

func (*OrgMachineService) Update 

func (s *OrgMachineService) Update(ctx context.Context, machineID string, params OrgMachineUpdateParams, opts ...option.RequestOption) (*Machine, error)

Update calls updateMachine: PATCH /orgs/{orgID}/machines/{machineID}.

type OrgMachineUpdateParams 

type OrgMachineUpdateParams struct {
	Cwd       *string
	Env       *map[string]string
	SecretEnv *map[string]SecretID
}

OrgMachineUpdateParams are the query, header and body fields of updateMachine.

type OrgMember 

type OrgMember struct {
	CreatedAt   Timestamp `json:"created_at"`
	DisplayName string    `json:"display_name"`

	// Email The member's primary verified email, or an empty string if none.
	Email string `json:"email"`

	// Role The member's role in the organization (owner, admin, or member).
	Role   string `json:"role"`
	UserID UserID `json:"user_id"`
}

OrgMember defines model for OrgMember.

type OrgMemberListParams 

type OrgMemberListParams struct {
	Name   *ResourceNameFilter
	Sort   *CreatedResourceListSort
	Limit  *PageLimit
	Cursor *PageCursor
}

OrgMemberListParams are the query, header and body fields of listOrgMembers.

type OrgMemberProjectService 

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

OrgMemberProjectService groups the orgs.members.projects methods.

func (*OrgMemberProjectService) List 

func (s *OrgMemberProjectService) List(ctx context.Context, userID string, opts ...option.RequestOption) (*ListProjectMembershipGrantsResponse, error)

List calls listMemberProjectAccess: GET /orgs/{orgID}/members/{userID}/projects.

func (*OrgMemberProjectService) Remove 

func (s *OrgMemberProjectService) Remove(ctx context.Context, userID string, projectID string, opts ...option.RequestOption) error

Remove calls removeMemberProjectAccess: DELETE /orgs/{orgID}/members/{userID}/projects/{projectID}.

func (*OrgMemberProjectService) Set 

func (s *OrgMemberProjectService) Set(ctx context.Context, userID string, projectID string, params OrgMemberProjectSetParams, opts ...option.RequestOption) (*ProjectMembershipGrant, error)

Set calls setMemberProjectAccess: PUT /orgs/{orgID}/members/{userID}/projects/{projectID}.

type OrgMemberProjectSetParams 

type OrgMemberProjectSetParams struct {
	Role string
}

OrgMemberProjectSetParams are the query, header and body fields of setMemberProjectAccess.

type OrgMemberService 

type OrgMemberService struct {
	Projects *OrgMemberProjectService
	// contains filtered or unexported fields
}

OrgMemberService groups the orgs.members methods.

func (*OrgMemberService) List 

func (s *OrgMemberService) List(ctx context.Context, params OrgMemberListParams, opts ...option.RequestOption) (*CursorPage[OrgMember], error)

List calls listOrgMembers: GET /orgs/{orgID}/members.

func (*OrgMemberService) ListAutoPaging 

func (s *OrgMemberService) ListAutoPaging(ctx context.Context, params OrgMemberListParams, opts ...option.RequestOption) *CursorPageAutoPager[OrgMember]

ListAutoPaging iterates every item of listOrgMembers across pages.

func (*OrgMemberService) Remove 

func (s *OrgMemberService) Remove(ctx context.Context, userID string, opts ...option.RequestOption) error

Remove calls removeOrgMember: DELETE /orgs/{orgID}/members/{userID}.

func (*OrgMemberService) Update 

func (s *OrgMemberService) Update(ctx context.Context, userID string, params OrgMemberUpdateParams, opts ...option.RequestOption) (*OrganizationMembership, error)

Update calls updateOrgMember: PATCH /orgs/{orgID}/members/{userID}.

type OrgMemberUpdateParams 

type OrgMemberUpdateParams struct {
	Role string
}

OrgMemberUpdateParams are the query, header and body fields of updateOrgMember.

type OrgMemoryStoreListParams 

type OrgMemoryStoreListParams struct {
	Limit  *PageLimit
	Name   *ResourceNameFilter
	Cursor *PageCursor
}

OrgMemoryStoreListParams are the query, header and body fields of listOrgMemoryStores.

type OrgMemoryStoreService 

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

OrgMemoryStoreService groups the orgs.memoryStores methods.

func (*OrgMemoryStoreService) List 

func (s *OrgMemoryStoreService) List(ctx context.Context, params OrgMemoryStoreListParams, opts ...option.RequestOption) (*CursorPage[MemoryStore], error)

List calls listOrgMemoryStores: GET /orgs/{orgID}/memory-stores.

func (*OrgMemoryStoreService) ListAutoPaging 

func (s *OrgMemoryStoreService) ListAutoPaging(ctx context.Context, params OrgMemoryStoreListParams, opts ...option.RequestOption) *CursorPageAutoPager[MemoryStore]

ListAutoPaging iterates every item of listOrgMemoryStores across pages.

type OrgModelProviderListParams 

type OrgModelProviderListParams struct {
	Name   *ResourceNameFilter
	Sort   *ResourceListSort
	Limit  *PageLimit
	Cursor *PageCursor
}

OrgModelProviderListParams are the query, header and body fields of listModelProviderConfigs.

type OrgModelProviderModelListParams 

type OrgModelProviderModelListParams struct {
	Limit  *PageLimit
	Cursor *PageCursor
}

OrgModelProviderModelListParams are the query, header and body fields of listConfiguredModels.

type OrgModelProviderModelNewParams 

type OrgModelProviderModelNewParams struct {
	APIVariantOptions         *ModelAPIVariantOptions
	ContextWindowTokens       int
	DefaultCacheRetention     *ModelCacheRetention
	DefaultMaxOutputTokens    *int
	DefaultReasoningEffort    *string
	InputModalities           *[]string
	MaxOutputTokens           *int
	Name                      ResourceName
	OutputModalities          *[]string
	ProviderModelSlug         string
	SupportedReasoningEfforts *[]string
	SupportsReasoning         *bool
	SupportsTools             *bool
}

OrgModelProviderModelNewParams are the query, header and body fields of createConfiguredModel.

type OrgModelProviderModelService 

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

OrgModelProviderModelService groups the orgs.modelProviders.models methods.

func (*OrgModelProviderModelService) Delete 

func (s *OrgModelProviderModelService) Delete(ctx context.Context, modelProviderConfigID string, configuredModelID string, opts ...option.RequestOption) error

Delete calls deleteConfiguredModel: DELETE /orgs/{orgID}/model-provider-configs/{modelProviderConfigID}/models/{configuredModelID}.

func (*OrgModelProviderModelService) List 

func (s *OrgModelProviderModelService) List(ctx context.Context, modelProviderConfigID string, params OrgModelProviderModelListParams, opts ...option.RequestOption) (*CursorPage[ConfiguredModel], error)

List calls listConfiguredModels: GET /orgs/{orgID}/model-provider-configs/{modelProviderConfigID}/models.

func (*OrgModelProviderModelService) ListAutoPaging 

func (s *OrgModelProviderModelService) ListAutoPaging(ctx context.Context, modelProviderConfigID string, params OrgModelProviderModelListParams, opts ...option.RequestOption) *CursorPageAutoPager[ConfiguredModel]

ListAutoPaging iterates every item of listConfiguredModels across pages.

func (*OrgModelProviderModelService) New 

func (s *OrgModelProviderModelService) New(ctx context.Context, modelProviderConfigID string, params OrgModelProviderModelNewParams, opts ...option.RequestOption) (*ConfiguredModel, error)

New calls createConfiguredModel: POST /orgs/{orgID}/model-provider-configs/{modelProviderConfigID}/models.

func (*OrgModelProviderModelService) Update 

func (s *OrgModelProviderModelService) Update(ctx context.Context, modelProviderConfigID string, configuredModelID string, params OrgModelProviderModelUpdateParams, opts ...option.RequestOption) (*ConfiguredModel, error)

Update calls updateConfiguredModel: PUT /orgs/{orgID}/model-provider-configs/{modelProviderConfigID}/models/{configuredModelID}.

type OrgModelProviderModelUpdateParams 

type OrgModelProviderModelUpdateParams struct {
	APIVariantOptions         *ModelAPIVariantOptions
	ContextWindowTokens       *int
	DefaultCacheRetention     *ModelCacheRetention
	DefaultMaxOutputTokens    *int
	DefaultReasoningEffort    *string
	InputModalities           *[]string
	MaxOutputTokens           *int
	Name                      *ResourceName
	OutputModalities          *[]string
	ProviderModelSlug         *string
	SupportedReasoningEfforts *[]string
	SupportsReasoning         *bool
	SupportsTools             *bool
}

OrgModelProviderModelUpdateParams are the query, header and body fields of updateConfiguredModel.

type OrgModelProviderNewParams 

type OrgModelProviderNewParams struct {
	APIFormat   *ModelAPIFormat
	APIVariant  *ModelProviderAPIVariant
	AuthKind    *ModelProviderAuthKind
	AuthOptions *struct {
		HeaderName *string `json:"header_name,omitempty"`
		Region     *string `json:"region,omitempty"`
		Service    *string `json:"service,omitempty"`
	}
	BaseURL            *string
	CredentialSecretID SecretID
	EndpointPath       *string
	Headers            *map[string]string
	IdleTimeoutMs      *int
	Name               ResourceName
	Preset             *CreateModelProviderConfigRequestPreset
	RequestTimeoutMs   *int
	SecretHeaders      *map[string]SecretID
}

OrgModelProviderNewParams are the query, header and body fields of createModelProviderConfig.

type OrgModelProviderService 

type OrgModelProviderService struct {
	Models *OrgModelProviderModelService
	// contains filtered or unexported fields
}

OrgModelProviderService groups the orgs.modelProviders methods.

func (*OrgModelProviderService) Catalog 

func (s *OrgModelProviderService) Catalog(ctx context.Context, modelProviderConfigID string, opts ...option.RequestOption) (*ModelCatalog, error)

Catalog calls getModelCatalog: GET /orgs/{orgID}/model-provider-configs/{modelProviderConfigID}/model-catalog.

func (*OrgModelProviderService) Delete 

func (s *OrgModelProviderService) Delete(ctx context.Context, modelProviderConfigID string, opts ...option.RequestOption) error

Delete calls deleteModelProviderConfig: DELETE /orgs/{orgID}/model-provider-configs/{modelProviderConfigID}.

func (*OrgModelProviderService) Get 

func (s *OrgModelProviderService) Get(ctx context.Context, modelProviderConfigID string, opts ...option.RequestOption) (*ModelProviderConfig, error)

Get calls getModelProviderConfig: GET /orgs/{orgID}/model-provider-configs/{modelProviderConfigID}.

func (*OrgModelProviderService) List 

func (s *OrgModelProviderService) List(ctx context.Context, params OrgModelProviderListParams, opts ...option.RequestOption) (*CursorPage[ModelProviderConfig], error)

List calls listModelProviderConfigs: GET /orgs/{orgID}/model-provider-configs.

func (*OrgModelProviderService) ListAutoPaging 

func (s *OrgModelProviderService) ListAutoPaging(ctx context.Context, params OrgModelProviderListParams, opts ...option.RequestOption) *CursorPageAutoPager[ModelProviderConfig]

ListAutoPaging iterates every item of listModelProviderConfigs across pages.

func (*OrgModelProviderService) New 

func (s *OrgModelProviderService) New(ctx context.Context, params OrgModelProviderNewParams, opts ...option.RequestOption) (*CreateModelProviderConfigResponse, error)

New calls createModelProviderConfig: POST /orgs/{orgID}/model-provider-configs.

func (*OrgModelProviderService) Update 

func (s *OrgModelProviderService) Update(ctx context.Context, modelProviderConfigID string, params OrgModelProviderUpdateParams, opts ...option.RequestOption) (*ModelProviderConfig, error)

Update calls updateModelProviderConfig: PUT /orgs/{orgID}/model-provider-configs/{modelProviderConfigID}.

type OrgModelProviderUpdateParams 

type OrgModelProviderUpdateParams struct {
	AuthKind    *ModelProviderAuthKind
	AuthOptions *struct {
		HeaderName *string `json:"header_name,omitempty"`
		Region     *string `json:"region,omitempty"`
		Service    *string `json:"service,omitempty"`
	}
	BaseURL            *string
	CredentialSecretID *SecretID
	EndpointPath       *string
	Headers            *map[string]string
	IdleTimeoutMs      *int
	RequestTimeoutMs   *int
	SecretHeaders      *map[string]SecretID
}

OrgModelProviderUpdateParams are the query, header and body fields of updateModelProviderConfig.

type OrgNewParams 

type OrgNewParams struct {
	Name ResourceName
}

OrgNewParams are the query, header and body fields of createOrganization.

type OrgOverviewAgentProfileReference 

type OrgOverviewAgentProfileReference struct {
	// AgentCount Agents, not counting subagents, launched from the profile, including archived ones.
	AgentCount int64          `json:"agent_count"`
	ID         AgentProfileID `json:"id"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`
}

OrgOverviewAgentProfileReference defines model for OrgOverviewAgentProfileReference.

type OrgOverviewProjectActivity 

type OrgOverviewProjectActivity struct {
	LastActiveAt Timestamp `json:"last_active_at"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`
}

OrgOverviewProjectActivity defines model for OrgOverviewProjectActivity.

type OrgOverviewResponse 

type OrgOverviewResponse struct {
	// ProjectActivity When each listed project last had an active top-level agent or an agent profile updated, among those the caller can read. Projects with neither are omitted.
	ProjectActivity []OrgOverviewProjectActivity `json:"project_activity"`

	// Projects Projects visible to the caller, most recently active first, capped at 200. Recents and activity still cover every visible project.
	Projects []VisibleProject `json:"projects"`

	// RecentAgentProfiles Most recently updated agent profiles across the caller's readable projects, ordered by updated_at descending.
	RecentAgentProfiles []AgentProfileSummary `json:"recent_agent_profiles"`

	// RecentAgents Most recently active agents across the caller's readable projects, ordered by updated_at descending.
	RecentAgents []Agent `json:"recent_agents"`

	// ReferencedAgentProfiles The agent profiles that recent_agents and recent_agent_profiles reference, with how many agents were launched from each. Profiles since deleted are omitted.
	ReferencedAgentProfiles []OrgOverviewAgentProfileReference `json:"referenced_agent_profiles"`
}

OrgOverviewResponse defines model for OrgOverviewResponse.

type OrgSecretGrantListParams 

type OrgSecretGrantListParams struct {
	Name   *ResourceNameFilter
	Sort   *CreatedResourceListSort
	Limit  *PageLimit
	Cursor *PageCursor
}

OrgSecretGrantListParams are the query, header and body fields of listSecretGrants.

type OrgSecretGrantNewParams 

type OrgSecretGrantNewParams struct {
	TargetProjectID ProjectID
}

OrgSecretGrantNewParams are the query, header and body fields of createSecretGrant.

type OrgSecretGrantService 

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

OrgSecretGrantService groups the orgs.secrets.grants methods.

func (*OrgSecretGrantService) Delete 

func (s *OrgSecretGrantService) Delete(ctx context.Context, secretID string, grantID string, opts ...option.RequestOption) error

Delete calls deleteSecretGrant: DELETE /orgs/{orgID}/secrets/{secretID}/grants/{grantID}.

func (*OrgSecretGrantService) List 

func (s *OrgSecretGrantService) List(ctx context.Context, secretID string, params OrgSecretGrantListParams, opts ...option.RequestOption) (*CursorPage[SecretGrantListItem], error)

List calls listSecretGrants: GET /orgs/{orgID}/secrets/{secretID}/grants.

func (*OrgSecretGrantService) ListAutoPaging 

func (s *OrgSecretGrantService) ListAutoPaging(ctx context.Context, secretID string, params OrgSecretGrantListParams, opts ...option.RequestOption) *CursorPageAutoPager[SecretGrantListItem]

ListAutoPaging iterates every item of listSecretGrants across pages.

func (*OrgSecretGrantService) New 

func (s *OrgSecretGrantService) New(ctx context.Context, secretID string, params OrgSecretGrantNewParams, opts ...option.RequestOption) (*SecretGrant, error)

New calls createSecretGrant: POST /orgs/{orgID}/secrets/{secretID}/grants.

type OrgSecretListParams 

type OrgSecretListParams struct {
	Name           *ResourceNameFilter
	Kind           *SecretKindFilter
	OwnerKind      *ListSecretsParamsOwnerKind
	OwnerProjectID *SecretOwnerProjectIDFilter
	McpOauthFlowID *SecretMCPOAuthFlowIDFilter
	Metadata       *SecretMetadataFilter
	Sort           *ResourceListSort
	Limit          *PageLimit
	Cursor         *PageCursor
}

OrgSecretListParams are the query, header and body fields of listSecrets.

type OrgSecretNewParams 

type OrgSecretNewParams struct {
	Material SecretMaterial
	Metadata *Metadata
	Name     ResourceName
	Owner    SecretOwnerInput
}

OrgSecretNewParams are the query, header and body fields of createSecret.

type OrgSecretOwner 

type OrgSecretOwner struct {
	Kind OrgSecretOwnerKind `json:"kind"`
}

OrgSecretOwner defines model for OrgSecretOwner.

type OrgSecretOwnerInput 

type OrgSecretOwnerInput struct {
	Kind OrgSecretOwnerInputKind `json:"kind"`
}

OrgSecretOwnerInput defines model for OrgSecretOwnerInput.

type OrgSecretOwnerInputKind 

type OrgSecretOwnerInputKind string

OrgSecretOwnerInputKind defines model for OrgSecretOwnerInput.Kind. 

const (
	OrgSecretOwnerInputKindOrg OrgSecretOwnerInputKind = "org"
)

Defines values for OrgSecretOwnerInputKind.

func (OrgSecretOwnerInputKind) Valid 

func (e OrgSecretOwnerInputKind) Valid() bool

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

type OrgSecretOwnerKind 

type OrgSecretOwnerKind string

OrgSecretOwnerKind defines model for OrgSecretOwner.Kind. 

const (
	OrgSecretOwnerKindOrg OrgSecretOwnerKind = "org"
)

Defines values for OrgSecretOwnerKind.

func (OrgSecretOwnerKind) Valid 

func (e OrgSecretOwnerKind) Valid() bool

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

type OrgSecretService 

type OrgSecretService struct {
	Versions *OrgSecretVersionService
	Grants   *OrgSecretGrantService
	// contains filtered or unexported fields
}

OrgSecretService groups the orgs.secrets methods.

func (*OrgSecretService) Delete 

func (s *OrgSecretService) Delete(ctx context.Context, secretID string, opts ...option.RequestOption) error

Delete calls deleteSecret: DELETE /orgs/{orgID}/secrets/{secretID}.

func (*OrgSecretService) Get 

func (s *OrgSecretService) Get(ctx context.Context, secretID string, opts ...option.RequestOption) (*Secret, error)

Get calls getSecret: GET /orgs/{orgID}/secrets/{secretID}.

func (*OrgSecretService) List 

func (s *OrgSecretService) List(ctx context.Context, params OrgSecretListParams, opts ...option.RequestOption) (*CursorPage[Secret], error)

List calls listSecrets: GET /orgs/{orgID}/secrets.

func (*OrgSecretService) ListAutoPaging 

func (s *OrgSecretService) ListAutoPaging(ctx context.Context, params OrgSecretListParams, opts ...option.RequestOption) *CursorPageAutoPager[Secret]

ListAutoPaging iterates every item of listSecrets across pages.

func (*OrgSecretService) New 

func (s *OrgSecretService) New(ctx context.Context, params OrgSecretNewParams, opts ...option.RequestOption) (*Secret, error)

New calls createSecret: POST /orgs/{orgID}/secrets.

func (*OrgSecretService) StartMCPOAuth 

func (s *OrgSecretService) StartMCPOAuth(ctx context.Context, params OrgSecretStartMCPOAuthParams, opts ...option.RequestOption) (*MCPOAuthStartResponse, error)

StartMCPOAuth calls startSecretMCPOAuth: POST /orgs/{orgID}/secrets/mcp-oauth.

func (*OrgSecretService) Update 

func (s *OrgSecretService) Update(ctx context.Context, secretID string, params OrgSecretUpdateParams, opts ...option.RequestOption) (*Secret, error)

Update calls updateSecret: PATCH /orgs/{orgID}/secrets/{secretID}.

type OrgSecretStartMCPOAuthParams 

type OrgSecretStartMCPOAuthParams struct {
	ClientID     *string
	ClientSecret *string
	McpURL       string
	Metadata     *MCPOAuthStartMetadata
	Name         ResourceName
	Owner        SecretOwnerInput
	ReturnTo     *string
	Scopes       *[]string
}

OrgSecretStartMCPOAuthParams are the query, header and body fields of startSecretMCPOAuth.

type OrgSecretUpdateParams 

type OrgSecretUpdateParams struct {
	Metadata *Metadata
	Name     *ResourceName
}

OrgSecretUpdateParams are the query, header and body fields of updateSecret.

type OrgSecretVersionNewParams 

type OrgSecretVersionNewParams struct {
	Material SecretMaterial
}

OrgSecretVersionNewParams are the query, header and body fields of createSecretVersion.

type OrgSecretVersionService 

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

OrgSecretVersionService groups the orgs.secrets.versions methods.

func (*OrgSecretVersionService) New 

func (s *OrgSecretVersionService) New(ctx context.Context, secretID string, params OrgSecretVersionNewParams, opts ...option.RequestOption) (*Secret, error)

New calls createSecretVersion: POST /orgs/{orgID}/secrets/{secretID}/versions.

type OrgService 

type OrgService struct {
	Members        *OrgMemberService
	APIKeys        *OrgAPIKeyService
	Invitations    *OrgInvitationService
	Skills         *OrgSkillService
	Secrets        *OrgSecretService
	Machines       *OrgMachineService
	MachinePools   *OrgMachinePoolService
	ModelProviders *OrgModelProviderService
	MemoryStores   *OrgMemoryStoreService
	Agents         *OrgAgentService
	AgentProfiles  *OrgAgentProfileService
	Integrations   *OrgIntegrationService
	// contains filtered or unexported fields
}

OrgService groups the orgs methods.

func (*OrgService) Delete 

func (s *OrgService) Delete(ctx context.Context, orgID string, opts ...option.RequestOption) error

Delete calls deleteOrganization: DELETE /orgs/{orgID}.

func (*OrgService) List 

func (s *OrgService) List(ctx context.Context, opts ...option.RequestOption) (*ListOrganizationsResponse, error)

List calls listOrganizations: GET /orgs.

func (*OrgService) New 

func (s *OrgService) New(ctx context.Context, params OrgNewParams, opts ...option.RequestOption) (*CreateOrganizationResponse, error)

New calls createOrganization: POST /orgs.

func (*OrgService) Overview 

func (s *OrgService) Overview(ctx context.Context, opts ...option.RequestOption) (*OrgOverviewResponse, error)

Overview calls getOrgOverview: GET /orgs/{orgID}/overview.

func (*OrgService) Usage 

func (s *OrgService) Usage(ctx context.Context, params OrgUsageParams, opts ...option.RequestOption) (*UsageReport, error)

Usage calls getOrgUsage: GET /orgs/{orgID}/usage.

func (*OrgService) UsageTimeseries 

func (s *OrgService) UsageTimeseries(ctx context.Context, params OrgUsageTimeseriesParams, opts ...option.RequestOption) (*UsageTimeseries, error)

UsageTimeseries calls getOrgUsageTimeseries: GET /orgs/{orgID}/usage/timeseries.

type OrgSkillGrantListParams 

type OrgSkillGrantListParams struct {
	Name   *ResourceNameFilter
	Sort   *CreatedResourceListSort
	Limit  *PageLimit
	Cursor *PageCursor
}

OrgSkillGrantListParams are the query, header and body fields of listSkillGrants.

type OrgSkillGrantNewParams 

type OrgSkillGrantNewParams struct {
	TargetProjectID ProjectID
}

OrgSkillGrantNewParams are the query, header and body fields of createSkillGrant.

type OrgSkillGrantService 

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

OrgSkillGrantService groups the orgs.skills.grants methods.

func (*OrgSkillGrantService) Delete 

func (s *OrgSkillGrantService) Delete(ctx context.Context, skillID string, grantID string, opts ...option.RequestOption) error

Delete calls deleteSkillGrant: DELETE /orgs/{orgID}/skills/{skillID}/grants/{grantID}.

func (*OrgSkillGrantService) List 

func (s *OrgSkillGrantService) List(ctx context.Context, skillID string, params OrgSkillGrantListParams, opts ...option.RequestOption) (*CursorPage[SkillGrantListItem], error)

List calls listSkillGrants: GET /orgs/{orgID}/skills/{skillID}/grants.

func (*OrgSkillGrantService) ListAutoPaging 

func (s *OrgSkillGrantService) ListAutoPaging(ctx context.Context, skillID string, params OrgSkillGrantListParams, opts ...option.RequestOption) *CursorPageAutoPager[SkillGrantListItem]

ListAutoPaging iterates every item of listSkillGrants across pages.

func (*OrgSkillGrantService) New 

func (s *OrgSkillGrantService) New(ctx context.Context, skillID string, params OrgSkillGrantNewParams, opts ...option.RequestOption) (*SkillGrant, error)

New calls createSkillGrant: POST /orgs/{orgID}/skills/{skillID}/grants.

type OrgSkillListParams 

type OrgSkillListParams struct {
	Name           *ResourceNameFilter
	OwnerKind      *ListSkillsParamsOwnerKind
	OwnerProjectID *SkillOwnerProjectIDFilter
	Sort           *ResourceListSort
	Limit          *PageLimit
	Cursor         *PageCursor
}

OrgSkillListParams are the query, header and body fields of listSkills.

type OrgSkillNewParams 

type OrgSkillNewParams struct {
	Archive io.Reader
	Owner   SkillOwnerInput
}

OrgSkillNewParams are the query, header and body fields of createSkill.

type OrgSkillOwner 

type OrgSkillOwner struct {
	Kind OrgSkillOwnerKind `json:"kind"`
}

OrgSkillOwner defines model for OrgSkillOwner.

type OrgSkillOwnerInput 

type OrgSkillOwnerInput struct {
	Kind OrgSkillOwnerInputKind `json:"kind"`
}

OrgSkillOwnerInput defines model for OrgSkillOwnerInput.

type OrgSkillOwnerInputKind 

type OrgSkillOwnerInputKind string

OrgSkillOwnerInputKind defines model for OrgSkillOwnerInput.Kind. 

const (
	OrgSkillOwnerInputKindOrg OrgSkillOwnerInputKind = "org"
)

Defines values for OrgSkillOwnerInputKind.

func (OrgSkillOwnerInputKind) Valid 

func (e OrgSkillOwnerInputKind) Valid() bool

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

type OrgSkillOwnerKind 

type OrgSkillOwnerKind string

OrgSkillOwnerKind defines model for OrgSkillOwner.Kind. 

const (
	OrgSkillOwnerKindOrg OrgSkillOwnerKind = "org"
)

Defines values for OrgSkillOwnerKind.

func (OrgSkillOwnerKind) Valid 

func (e OrgSkillOwnerKind) Valid() bool

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

type OrgSkillService 

type OrgSkillService struct {
	Grants *OrgSkillGrantService
	// contains filtered or unexported fields
}

OrgSkillService groups the orgs.skills methods.

func (*OrgSkillService) Delete 

func (s *OrgSkillService) Delete(ctx context.Context, skillID string, opts ...option.RequestOption) error

Delete calls deleteSkill: DELETE /orgs/{orgID}/skills/{skillID}.

func (*OrgSkillService) Get 

func (s *OrgSkillService) Get(ctx context.Context, skillID string, opts ...option.RequestOption) (*Skill, error)

Get calls getSkill: GET /orgs/{orgID}/skills/{skillID}.

func (*OrgSkillService) List 

func (s *OrgSkillService) List(ctx context.Context, params OrgSkillListParams, opts ...option.RequestOption) (*CursorPage[Skill], error)

List calls listSkills: GET /orgs/{orgID}/skills.

func (*OrgSkillService) ListAutoPaging 

func (s *OrgSkillService) ListAutoPaging(ctx context.Context, params OrgSkillListParams, opts ...option.RequestOption) *CursorPageAutoPager[Skill]

ListAutoPaging iterates every item of listSkills across pages.

func (*OrgSkillService) New 

func (s *OrgSkillService) New(ctx context.Context, params OrgSkillNewParams, opts ...option.RequestOption) (*Skill, error)

New calls createSkill: POST /orgs/{orgID}/skills.

func (*OrgSkillService) Update 

func (s *OrgSkillService) Update(ctx context.Context, skillID string, params OrgSkillUpdateParams, opts ...option.RequestOption) (*Skill, error)

Update calls updateSkill: POST /orgs/{orgID}/skills/{skillID}.

type OrgSkillUpdateParams 

type OrgSkillUpdateParams struct {
	Archive io.Reader
	SkillMd *string
}

OrgSkillUpdateParams are the query, header and body fields of updateSkill.

type OrgUsageParams 

type OrgUsageParams struct {
	Since             *UsageSince
	Until             *UsageUntil
	IncludeProjectIDs *UsageIncludeProjectIDs
	ExcludeProjectIDs *UsageExcludeProjectIDs
}

OrgUsageParams are the query, header and body fields of getOrgUsage.

type OrgUsageTimeseriesParams 

type OrgUsageTimeseriesParams struct {
	Since            *UsageSince
	Until            *UsageUntil
	Timezone         *string
	Interval         *UsageTimeseriesInterval
	Metric           *UsageTimeseriesMetric
	GroupBy          *UsageTimeseriesGroupBy
	GroupLimit       *int
	ProjectIDs       *[]ProjectID
	AgentProfileIDs  *[]AgentProfileID
	IncludeSubagents *bool
}

OrgUsageTimeseriesParams are the query, header and body fields of getOrgUsageTimeseries.

type Organization 

type Organization struct {
	CreatedAt Timestamp      `json:"created_at"`
	ID        OrganizationID `json:"id"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name      ResourceName `json:"name"`
	UpdatedAt Timestamp    `json:"updated_at"`
}

Organization defines model for Organization.

type OrganizationID 

type OrganizationID = string

OrganizationID defines model for OrganizationID.

type OrganizationMembership 

type OrganizationMembership struct {
	CreatedAt Timestamp      `json:"created_at"`
	OrgID     OrganizationID `json:"org_id"`
	Role      string         `json:"role"`
	UserID    UserID         `json:"user_id"`
}

OrganizationMembership defines model for OrganizationMembership.

type PageCursor 

type PageCursor = string

PageCursor defines model for PageCursor.

type PageLimit 

type PageLimit = int32

PageLimit defines model for PageLimit.

type PatchAgentModelOverrideJSONRequestBody 

type PatchAgentModelOverrideJSONRequestBody = AgentModelOverridePatch

PatchAgentModelOverrideJSONRequestBody defines body for PatchAgentModelOverride for application/json ContentType.

type PatchAgentSessionModelOverrideJSONRequestBody 

type PatchAgentSessionModelOverrideJSONRequestBody = AgentModelOverridePatch

PatchAgentSessionModelOverrideJSONRequestBody defines body for PatchAgentSessionModelOverride for application/json ContentType.

type PersonalAccessToken 

type PersonalAccessToken struct {
	CreatedAt  Timestamp             `json:"created_at"`
	ID         PersonalAccessTokenID `json:"id"`
	LastUsedAt *Timestamp            `json:"last_used_at"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name      ResourceName `json:"name"`
	RevokedAt *Timestamp   `json:"revoked_at"`

	// TokenID Stable non-secret display identifier. It is not embedded in the bearer token.
	TokenID string `json:"token_id"`
	UserID  UserID `json:"user_id"`
}

PersonalAccessToken defines model for PersonalAccessToken.

type PersonalAccessTokenID 

type PersonalAccessTokenID = string

PersonalAccessTokenID defines model for PersonalAccessTokenID.

type PersonalAccessTokenListParams 

type PersonalAccessTokenListParams struct {
	Limit  *PageLimit
	Cursor *PageCursor
}

PersonalAccessTokenListParams are the query, header and body fields of listPersonalAccessTokens.

type PersonalAccessTokenNewParams 

type PersonalAccessTokenNewParams struct {
	Name ResourceName
}

PersonalAccessTokenNewParams are the query, header and body fields of createPersonalAccessToken.

type PersonalAccessTokenService 

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

PersonalAccessTokenService groups the personalAccessTokens methods.

func (*PersonalAccessTokenService) List 

func (s *PersonalAccessTokenService) List(ctx context.Context, params PersonalAccessTokenListParams, opts ...option.RequestOption) (*CursorPage[PersonalAccessToken], error)

List calls listPersonalAccessTokens: GET /personal-access-tokens.

func (*PersonalAccessTokenService) ListAutoPaging 

func (s *PersonalAccessTokenService) ListAutoPaging(ctx context.Context, params PersonalAccessTokenListParams, opts ...option.RequestOption) *CursorPageAutoPager[PersonalAccessToken]

ListAutoPaging iterates every item of listPersonalAccessTokens across pages.

func (*PersonalAccessTokenService) New 

func (s *PersonalAccessTokenService) New(ctx context.Context, params PersonalAccessTokenNewParams, opts ...option.RequestOption) (*CreatePersonalAccessTokenResponse, error)

New calls createPersonalAccessToken: POST /personal-access-tokens.

func (*PersonalAccessTokenService) Revoke 

func (s *PersonalAccessTokenService) Revoke(ctx context.Context, tokenID string, opts ...option.RequestOption) (*PersonalAccessToken, error)

Revoke calls revokePersonalAccessToken: POST /personal-access-tokens/{tokenID}/revoke.

type ProcessActionID 

type ProcessActionID = string

ProcessActionID defines model for ProcessActionID.

type ProcessID 

type ProcessID = string

ProcessID defines model for ProcessID.

type Project 

type Project = ProjectFields

Project Shared project fields composed into project response schemas. Composing schemas close their final shape with unevaluatedProperties.

type ProjectAccess 

type ProjectAccess struct {
	CanManage       bool `json:"can_manage"`
	CanManageAccess bool `json:"can_manage_access"`
	CanOperate      bool `json:"can_operate"`
	CanRead         bool `json:"can_read"`
}

ProjectAccess defines model for ProjectAccess.

type ProjectEventWebhookScope 

type ProjectEventWebhookScope struct {
	Type ProjectEventWebhookScopeType `json:"type"`
}

ProjectEventWebhookScope defines model for ProjectEventWebhookScope.

type ProjectEventWebhookScopeType 

type ProjectEventWebhookScopeType string

ProjectEventWebhookScopeType defines model for ProjectEventWebhookScope.Type. 

const (
	ProjectEventWebhookScopeTypeProject ProjectEventWebhookScopeType = "project"
)

Defines values for ProjectEventWebhookScopeType.

func (ProjectEventWebhookScopeType) Valid 

func (e ProjectEventWebhookScopeType) Valid() bool

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

type ProjectFields 

type ProjectFields struct {
	CreatedAt Timestamp `json:"created_at"`

	// ID Project ID (proj_...).
	ID ProjectID `json:"id"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name      ResourceName   `json:"name"`
	OrgID     OrganizationID `json:"org_id"`
	UpdatedAt Timestamp      `json:"updated_at"`
}

ProjectFields Shared project fields composed into project response schemas. Composing schemas close their final shape with unevaluatedProperties.

type ProjectID 

type ProjectID = string

ProjectID Project ID (proj_...).

type ProjectListParams 

type ProjectListParams struct {
	Limit  *PageLimit
	Cursor *PageCursor
}

ProjectListParams are the query, header and body fields of listVisibleProjects.

type ProjectMachineGrant 

type ProjectMachineGrant struct {
	CreatedAt   Timestamp             `json:"created_at"`
	Description string                `json:"description"`
	ID          ProjectMachineGrantID `json:"id"`

	// MachineID Machine ID (mch_...).
	MachineID MachineID `json:"machine_id"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata Metadata       `json:"metadata"`
	OrgID    OrganizationID `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID                 ProjectID                     `json:"project_id"`
	ProjectMachinePoolGrantID *ProjectMachinePoolGrantID    `json:"project_machine_pool_grant_id,omitempty"`
	SourceKind                ProjectMachineGrantSourceKind `json:"source_kind"`
	UpdatedAt                 Timestamp                     `json:"updated_at"`
}

ProjectMachineGrant defines model for ProjectMachineGrant.

type ProjectMachineGrantID 

type ProjectMachineGrantID = string

ProjectMachineGrantID defines model for ProjectMachineGrantID.

type ProjectMachineGrantListItem 

type ProjectMachineGrantListItem struct {
	Grant   ProjectMachineGrant `json:"grant"`
	Machine MachineSummary      `json:"machine"`
}

ProjectMachineGrantListItem defines model for ProjectMachineGrantListItem.

type ProjectMachineGrantSourceKind 

type ProjectMachineGrantSourceKind string

ProjectMachineGrantSourceKind defines model for ProjectMachineGrantSourceKind. 

const (
	ProjectMachineGrantSourceKindExplicit ProjectMachineGrantSourceKind = "explicit"
	ProjectMachineGrantSourceKindPool     ProjectMachineGrantSourceKind = "pool"
)

Defines values for ProjectMachineGrantSourceKind.

func (ProjectMachineGrantSourceKind) Valid 

func (e ProjectMachineGrantSourceKind) Valid() bool

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

type ProjectMachinePoolGrant 

type ProjectMachinePoolGrant struct {
	CreatedAt         Timestamp `json:"created_at"`
	DefaultCwd        string    `json:"default_cwd"`
	DefaultMachineCPU *int32    `json:"default_machine_cpu"`

	// DefaultMachineEnvOverlay Env overlay merged over the pool's default_machine_env for machines materialized through this grant; a null entry removes the key.
	DefaultMachineEnvOverlay             map[string]*string     `json:"default_machine_env_overlay"`
	DefaultMachineMemoryMb               *int32                 `json:"default_machine_memory_mb"`
	DefaultMachineProviderOptionsOverlay map[string]interface{} `json:"default_machine_provider_options_overlay"`

	// DefaultMachineSecretEnvOverlay Secret env overlay merged over the pool's default_machine_secret_env for machines materialized through this grant; a null entry removes the key.
	DefaultMachineSecretEnvOverlay map[string]*string `json:"default_machine_secret_env_overlay"`

	// DeleteAfterIdleMinutes Idle minutes before deleting a machine created through this grant. Zero disables deletion for this grant; null inherits the pool default.
	DeleteAfterIdleMinutes *int32                    `json:"delete_after_idle_minutes"`
	Description            string                    `json:"description"`
	ID                     ProjectMachinePoolGrantID `json:"id"`

	// MachinePoolID Machine pool ID (mpo_...).
	MachinePoolID      MachinePoolID `json:"machine_pool_id"`
	MaxMachineCPU      *int32        `json:"max_machine_cpu"`
	MaxMachineMemoryMb *int32        `json:"max_machine_memory_mb"`
	MaxTotalCPU        *int32        `json:"max_total_cpu"`
	MaxTotalMachines   *int32        `json:"max_total_machines"`
	MaxTotalMemoryMb   *int32        `json:"max_total_memory_mb"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata           Metadata       `json:"metadata"`
	MinMachineCPU      *int32         `json:"min_machine_cpu"`
	MinMachineMemoryMb *int32         `json:"min_machine_memory_mb"`
	OrgID              OrganizationID `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`
	UpdatedAt Timestamp `json:"updated_at"`
}

ProjectMachinePoolGrant defines model for ProjectMachinePoolGrant.

type ProjectMachinePoolGrantID 

type ProjectMachinePoolGrantID = string

ProjectMachinePoolGrantID defines model for ProjectMachinePoolGrantID.

type ProjectMachinePoolGrantListItem 

type ProjectMachinePoolGrantListItem struct {
	Grant       ProjectMachinePoolGrant `json:"grant"`
	MachinePool MachinePoolSummary      `json:"machine_pool"`
}

ProjectMachinePoolGrantListItem defines model for ProjectMachinePoolGrantListItem.

type ProjectMembershipGrant 

type ProjectMembershipGrant struct {
	CreatedAt Timestamp `json:"created_at"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// ProjectName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	ProjectName ResourceName `json:"project_name"`

	// Role The member's role on the project (admin, developer, operator, or viewer).
	Role string `json:"role"`
}

ProjectMembershipGrant defines model for ProjectMembershipGrant.

type ProjectModelGrant 

type ProjectModelGrant struct {
	ConfiguredModelID ConfiguredModelID `json:"configured_model_id"`

	// ContextWindowTokens Project context budget for input and output tokens, or omitted/null to inherit from the configured model. Triggers compaction when estimated input exceeds the remaining budget after output and safety reserves. The turn fails if compaction cannot make it fit.
	ContextWindowTokens *int      `json:"context_window_tokens,omitempty"`
	CreatedAt           Timestamp `json:"created_at"`

	// DefaultCacheRetention Prompt-cache preference for model requests; `short` when omitted. `short` applies the route's default caching (explicit cache breakpoints where the provider requires them) and, where the route accepts one, a stable conversation key for cache-aware routing. `long` prefers the route's extended cache lifetime where one exists (currently Anthropic's one-hour cache, which on Bedrock requires Claude 4.5 or newer) and behaves like `short` elsewhere. `none` sends no BMA-managed cache controls or conversation key; providers may still cache prefixes on their own.
	DefaultCacheRetention *ModelCacheRetention `json:"default_cache_retention,omitempty"`

	// DefaultMaxOutputTokens Project default per-request output-token cap, or omitted/null to inherit from the configured model.
	DefaultMaxOutputTokens *int `json:"default_max_output_tokens,omitempty"`

	// DefaultReasoningEffort Project default reasoning effort, or omitted/empty to inherit from the configured model.
	DefaultReasoningEffort *string             `json:"default_reasoning_effort,omitempty"`
	ID                     ProjectModelGrantID `json:"id"`

	// InputModalities Project subset of configured-model input types (text, image, or file). Empty means inherit.
	InputModalities []string `json:"input_modalities"`

	// MaxOutputTokens Project output-token ceiling, or omitted/null to inherit from the configured model.
	MaxOutputTokens *int           `json:"max_output_tokens,omitempty"`
	OrgID           OrganizationID `json:"org_id"`

	// OutputModalities Project subset of configured-model output types. Empty means inherit.
	OutputModalities []string `json:"output_modalities"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// SupportedReasoningEfforts Project subset of configured-model reasoning efforts. Empty means inherit. When non-empty, default_reasoning_effort must resolve to one of these values.
	SupportedReasoningEfforts []string `json:"supported_reasoning_efforts"`

	// SupportsReasoning Project-level reasoning override, or omitted/null to inherit from the configured model.
	SupportsReasoning *bool `json:"supports_reasoning,omitempty"`

	// SupportsTools Project-level tool-use override, or omitted/null to inherit from the configured model.
	SupportsTools *bool     `json:"supports_tools,omitempty"`
	UpdatedAt     Timestamp `json:"updated_at"`
}

ProjectModelGrant defines model for ProjectModelGrant.

type ProjectModelGrantEffectiveReasoning 

type ProjectModelGrantEffectiveReasoning struct {
	// DefaultReasoningEffort Reasoning effort sent when an agent config does not set model.reasoning.effort. Empty means the provider default.
	DefaultReasoningEffort string `json:"default_reasoning_effort"`

	// SupportedReasoningEfforts Values an agent config may set as model.reasoning.effort, including limits the model's API format imposes when the configured model lists none. Empty means any value is accepted.
	SupportedReasoningEfforts []string `json:"supported_reasoning_efforts"`

	// SupportsReasoning Whether agents can use this model's reasoning features. False when the grant no longer fits the configured model.
	SupportsReasoning bool `json:"supports_reasoning"`
}

ProjectModelGrantEffectiveReasoning Reasoning settings agents in this project get for the model, after project grant overrides are applied to the configured model's current revision.

type ProjectModelGrantEnvelope 

type ProjectModelGrantEnvelope struct {
	Grant ProjectModelGrant `json:"grant"`
}

ProjectModelGrantEnvelope defines model for ProjectModelGrantEnvelope.

type ProjectModelGrantID 

type ProjectModelGrantID = string

ProjectModelGrantID defines model for ProjectModelGrantID.

type ProjectModelGrantListItem 

type ProjectModelGrantListItem struct {
	// EffectiveReasoning Reasoning settings agents in this project get for the model, after project grant overrides are applied to the configured model's current revision.
	EffectiveReasoning ProjectModelGrantEffectiveReasoning `json:"effective_reasoning"`
	Grant              ProjectModelGrant                   `json:"grant"`
	Model              ConfiguredModelSummary              `json:"model"`
}

ProjectModelGrantListItem defines model for ProjectModelGrantListItem.

type ProjectNewParams 

type ProjectNewParams struct {
	Name ResourceName
}

ProjectNewParams are the query, header and body fields of createProject.

type ProjectSecretAccess 

type ProjectSecretAccess struct {
	Availability SecretAvailability `json:"availability"`
	Secret       Secret             `json:"secret"`
}

ProjectSecretAccess defines model for ProjectSecretAccess.

type ProjectSecretOwner 

type ProjectSecretOwner struct {
	Kind ProjectSecretOwnerKind `json:"kind"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`
}

ProjectSecretOwner defines model for ProjectSecretOwner.

type ProjectSecretOwnerInput 

type ProjectSecretOwnerInput struct {
	Kind ProjectSecretOwnerInputKind `json:"kind"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`
}

ProjectSecretOwnerInput defines model for ProjectSecretOwnerInput.

type ProjectSecretOwnerInputKind 

type ProjectSecretOwnerInputKind string

ProjectSecretOwnerInputKind defines model for ProjectSecretOwnerInput.Kind. 

const (
	ProjectSecretOwnerInputKindProject ProjectSecretOwnerInputKind = "project"
)

Defines values for ProjectSecretOwnerInputKind.

func (ProjectSecretOwnerInputKind) Valid 

func (e ProjectSecretOwnerInputKind) Valid() bool

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

type ProjectSecretOwnerKind 

type ProjectSecretOwnerKind string

ProjectSecretOwnerKind defines model for ProjectSecretOwner.Kind. 

const (
	ProjectSecretOwnerKindProject ProjectSecretOwnerKind = "project"
)

Defines values for ProjectSecretOwnerKind.

func (ProjectSecretOwnerKind) Valid 

func (e ProjectSecretOwnerKind) Valid() bool

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

type ProjectService 

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

ProjectService groups the projects methods.

func (*ProjectService) Delete 

func (s *ProjectService) Delete(ctx context.Context, projectID string, opts ...option.RequestOption) error

Delete calls deleteProject: DELETE /orgs/{orgID}/projects/{projectID}.

func (*ProjectService) List 

func (s *ProjectService) List(ctx context.Context, params ProjectListParams, opts ...option.RequestOption) (*CursorPage[VisibleProject], error)

List calls listVisibleProjects: GET /orgs/{orgID}/projects.

func (*ProjectService) ListAutoPaging 

func (s *ProjectService) ListAutoPaging(ctx context.Context, params ProjectListParams, opts ...option.RequestOption) *CursorPageAutoPager[VisibleProject]

ListAutoPaging iterates every item of listVisibleProjects across pages.

func (*ProjectService) New 

func (s *ProjectService) New(ctx context.Context, params ProjectNewParams, opts ...option.RequestOption) (*Project, error)

New calls createProject: POST /orgs/{orgID}/projects.

func (*ProjectService) Usage 

func (s *ProjectService) Usage(ctx context.Context, params ProjectUsageParams, opts ...option.RequestOption) (*UsageReport, error)

Usage calls getProjectUsage: GET /orgs/{orgID}/projects/{projectID}/usage.

type ProjectSkillAccess 

type ProjectSkillAccess struct {
	Availability SkillAvailability `json:"availability"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`
	Skill     Skill     `json:"skill"`
}

ProjectSkillAccess defines model for ProjectSkillAccess.

type ProjectSkillOwner 

type ProjectSkillOwner struct {
	Kind ProjectSkillOwnerKind `json:"kind"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`
}

ProjectSkillOwner defines model for ProjectSkillOwner.

type ProjectSkillOwnerInput 

type ProjectSkillOwnerInput struct {
	Kind ProjectSkillOwnerInputKind `json:"kind"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`
}

ProjectSkillOwnerInput defines model for ProjectSkillOwnerInput.

type ProjectSkillOwnerInputKind 

type ProjectSkillOwnerInputKind string

ProjectSkillOwnerInputKind defines model for ProjectSkillOwnerInput.Kind. 

const (
	ProjectSkillOwnerInputKindProject ProjectSkillOwnerInputKind = "project"
)

Defines values for ProjectSkillOwnerInputKind.

func (ProjectSkillOwnerInputKind) Valid 

func (e ProjectSkillOwnerInputKind) Valid() bool

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

type ProjectSkillOwnerKind 

type ProjectSkillOwnerKind string

ProjectSkillOwnerKind defines model for ProjectSkillOwner.Kind. 

const (
	ProjectSkillOwnerKindProject ProjectSkillOwnerKind = "project"
)

Defines values for ProjectSkillOwnerKind.

func (ProjectSkillOwnerKind) Valid 

func (e ProjectSkillOwnerKind) Valid() bool

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

type ProjectUsageParams 

type ProjectUsageParams struct {
	Since *UsageSince
	Until *UsageUntil
}

ProjectUsageParams are the query, header and body fields of getProjectUsage.

type PromoteQueuedInputToSteeringJSONRequestBody 

type PromoteQueuedInputToSteeringJSONRequestBody = PromoteQueuedInputToSteeringRequest

PromoteQueuedInputToSteeringJSONRequestBody defines body for PromoteQueuedInputToSteering for application/json ContentType.

type PromoteQueuedInputToSteeringRequest 

type PromoteQueuedInputToSteeringRequest struct {
	// CancelOpenInteractions When true, atomically cancels open interactions associated with the current turn's unfinished tool calls as this queued input becomes steering. Their parent tool calls complete as canceled; the turn, runtime, and unrelated tool calls are preserved.
	CancelOpenInteractions *bool `json:"cancel_open_interactions,omitempty"`
}

PromoteQueuedInputToSteeringRequest defines model for PromoteQueuedInputToSteeringRequest.

type PromoteSessionArtifactJSONRequestBody 

type PromoteSessionArtifactJSONRequestBody = PromoteSessionArtifactRequest

PromoteSessionArtifactJSONRequestBody defines body for PromoteSessionArtifact for application/json ContentType.

type PromoteSessionArtifactParams 

type PromoteSessionArtifactParams struct {
	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

PromoteSessionArtifactParams defines parameters for PromoteSessionArtifact.

type PromoteSessionArtifactRequest 

type PromoteSessionArtifactRequest struct {
	// Filename File name; defaults to the artifact's filename.
	Filename *string `json:"filename,omitempty"`

	// Metadata String labels for the file.
	Metadata *map[string]string `json:"metadata,omitempty"`

	// Scope project (default) or session (scoped to this session).
	Scope *PromoteSessionArtifactRequestScope `json:"scope,omitempty"`
}

PromoteSessionArtifactRequest defines model for PromoteSessionArtifactRequest.

type PromoteSessionArtifactRequestScope 

type PromoteSessionArtifactRequestScope string

PromoteSessionArtifactRequestScope project (default) or session (scoped to this session). 

const (
	PromoteSessionArtifactRequestScopeProject PromoteSessionArtifactRequestScope = "project"
	PromoteSessionArtifactRequestScopeSession PromoteSessionArtifactRequestScope = "session"
)

Defines values for PromoteSessionArtifactRequestScope.

func (PromoteSessionArtifactRequestScope) Valid 

func (e PromoteSessionArtifactRequestScope) Valid() bool

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

type PutActorJSONRequestBody 

type PutActorJSONRequestBody = ExternalActorParams

PutActorJSONRequestBody defines body for PutActor for application/json ContentType.

type PutAgentExecutorBindingJSONRequestBody 

type PutAgentExecutorBindingJSONRequestBody = AgentExecutorBindingInput

PutAgentExecutorBindingJSONRequestBody defines body for PutAgentExecutorBinding for application/json ContentType.

type PutAgentModelOverrideJSONRequestBody 

type PutAgentModelOverrideJSONRequestBody = AgentModelOverrideInput

PutAgentModelOverrideJSONRequestBody defines body for PutAgentModelOverride for application/json ContentType.

type PutAgentSessionModelOverrideJSONRequestBody 

type PutAgentSessionModelOverrideJSONRequestBody = AgentModelOverrideInput

PutAgentSessionModelOverrideJSONRequestBody defines body for PutAgentSessionModelOverride for application/json ContentType.

type ReasoningContentBlock 

type ReasoningContentBlock struct {
	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata *ContentBlockMetadata     `json:"metadata,omitempty"`
	Text     string                    `json:"text"`
	Type     ReasoningContentBlockType `json:"type"`
}

ReasoningContentBlock defines model for ReasoningContentBlock.

type ReasoningContentBlockType 

type ReasoningContentBlockType string

ReasoningContentBlockType defines model for ReasoningContentBlock.Type. 

const (
	Reasoning ReasoningContentBlockType = "reasoning"
)

Defines values for ReasoningContentBlockType.

func (ReasoningContentBlockType) Valid 

func (e ReasoningContentBlockType) Valid() bool

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

type RecordMachineFailureParams 

type RecordMachineFailureParams struct {
	Stage         RecordMachineFailureParamsStage `form:"stage" json:"stage"`
	ExitStatus    *int                            `form:"exit_status,omitempty" json:"exit_status,omitempty"`
	CaptureStatus *int                            `form:"capture_status,omitempty" json:"capture_status,omitempty"`
	DaemonVersion *string                         `form:"daemon_version,omitempty" json:"daemon_version,omitempty"`
	TargetVersion *string                         `form:"target_version,omitempty" json:"target_version,omitempty"`
}

RecordMachineFailureParams defines parameters for RecordMachineFailure.

type RecordMachineFailureParamsStage 

type RecordMachineFailureParamsStage string

RecordMachineFailureParamsStage defines parameters for RecordMachineFailure. 

const (
	RecordMachineFailureParamsStageDaemonInstall     RecordMachineFailureParamsStage = "daemon_install"
	RecordMachineFailureParamsStageDaemonRuntime     RecordMachineFailureParamsStage = "daemon_runtime"
	RecordMachineFailureParamsStageDaemonUninstall   RecordMachineFailureParamsStage = "daemon_uninstall"
	RecordMachineFailureParamsStageDaemonUninstalled RecordMachineFailureParamsStage = "daemon_uninstalled"
	RecordMachineFailureParamsStageDaemonUpdate      RecordMachineFailureParamsStage = "daemon_update"
	RecordMachineFailureParamsStageStartupScript     RecordMachineFailureParamsStage = "startup_script"
)

Defines values for RecordMachineFailureParamsStage.

func (RecordMachineFailureParamsStage) Valid 

func (e RecordMachineFailureParamsStage) Valid() bool

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

type RecordMachineFailureTextBody 

type RecordMachineFailureTextBody = string

RecordMachineFailureTextBody defines parameters for RecordMachineFailure.

type RecordMachineFailureTextRequestBody 

type RecordMachineFailureTextRequestBody = RecordMachineFailureTextBody

RecordMachineFailureTextRequestBody defines body for RecordMachineFailure for text/plain ContentType.

type RenameAgentProfileJSONRequestBody 

type RenameAgentProfileJSONRequestBody = RenameAgentProfileRequest

RenameAgentProfileJSONRequestBody defines body for RenameAgentProfile for application/json ContentType.

type RenameAgentProfileRequest 

type RenameAgentProfileRequest struct {
	// Description Omit to keep the stored description; an empty string clears it.
	Description *string `json:"description,omitempty"`

	// Metadata Caller-owned labels of an agent profile (string keys and values).
	Metadata *AgentProfileMetadata `json:"metadata,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name ResourceName `json:"name"`
}

RenameAgentProfileRequest defines model for RenameAgentProfileRequest.

type RenewDesktopControlJSONRequestBody 

type RenewDesktopControlJSONRequestBody = DesktopControlLeaseRequest

RenewDesktopControlJSONRequestBody defines body for RenewDesktopControl for application/json ContentType.

type ReportDaemonMachineBackupRestoreJSONRequestBody 

type ReportDaemonMachineBackupRestoreJSONRequestBody = DaemonMachineBackupRestoreResult

ReportDaemonMachineBackupRestoreJSONRequestBody defines body for ReportDaemonMachineBackupRestore for application/json ContentType.

type ResolveAgentConfigToolsJSONRequestBody 

type ResolveAgentConfigToolsJSONRequestBody = ResolveAgentConfigToolsRequest

ResolveAgentConfigToolsJSONRequestBody defines body for ResolveAgentConfigTools for application/json ContentType.

type ResolveAgentConfigToolsRequest 

type ResolveAgentConfigToolsRequest struct {
	// Source Agent config source as YAML or JSON text, or, with source_format json, as a JSON object. Only the fields that determine tools are read.
	Source       ResolveAgentConfigToolsRequest_Source      `json:"source"`
	SourceFormat ResolveAgentConfigToolsRequestSourceFormat `json:"source_format"`
}

ResolveAgentConfigToolsRequest defines model for ResolveAgentConfigToolsRequest.

type ResolveAgentConfigToolsRequestSource0 

type ResolveAgentConfigToolsRequestSource0 = string

ResolveAgentConfigToolsRequestSource0 defines model for .

type ResolveAgentConfigToolsRequestSourceFormat 

type ResolveAgentConfigToolsRequestSourceFormat string

ResolveAgentConfigToolsRequestSourceFormat defines model for ResolveAgentConfigToolsRequest.SourceFormat. 

const (
	ResolveAgentConfigToolsRequestSourceFormatJSON ResolveAgentConfigToolsRequestSourceFormat = "json"
	ResolveAgentConfigToolsRequestSourceFormatYaml ResolveAgentConfigToolsRequestSourceFormat = "yaml"
)

Defines values for ResolveAgentConfigToolsRequestSourceFormat.

func (ResolveAgentConfigToolsRequestSourceFormat) Valid 

func (e ResolveAgentConfigToolsRequestSourceFormat) Valid() bool

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

type ResolveAgentConfigToolsRequest_Source 

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

ResolveAgentConfigToolsRequest_Source Agent config source as YAML or JSON text, or, with source_format json, as a JSON object. Only the fields that determine tools are read.

func (ResolveAgentConfigToolsRequest_Source) AsAgentConfigToolsDefinition 

func (t ResolveAgentConfigToolsRequest_Source) AsAgentConfigToolsDefinition() (AgentConfigToolsDefinition, error)

AsAgentConfigToolsDefinition returns the union data inside the ResolveAgentConfigToolsRequest_Source as a AgentConfigToolsDefinition

func (ResolveAgentConfigToolsRequest_Source) AsResolveAgentConfigToolsRequestSource0 

func (t ResolveAgentConfigToolsRequest_Source) AsResolveAgentConfigToolsRequestSource0() (ResolveAgentConfigToolsRequestSource0, error)

AsResolveAgentConfigToolsRequestSource0 returns the union data inside the ResolveAgentConfigToolsRequest_Source as a ResolveAgentConfigToolsRequestSource0

func (*ResolveAgentConfigToolsRequest_Source) FromAgentConfigToolsDefinition 

func (t *ResolveAgentConfigToolsRequest_Source) FromAgentConfigToolsDefinition(v AgentConfigToolsDefinition) error

FromAgentConfigToolsDefinition overwrites any union data inside the ResolveAgentConfigToolsRequest_Source as the provided AgentConfigToolsDefinition

func (*ResolveAgentConfigToolsRequest_Source) FromResolveAgentConfigToolsRequestSource0 

func (t *ResolveAgentConfigToolsRequest_Source) FromResolveAgentConfigToolsRequestSource0(v ResolveAgentConfigToolsRequestSource0) error

FromResolveAgentConfigToolsRequestSource0 overwrites any union data inside the ResolveAgentConfigToolsRequest_Source as the provided ResolveAgentConfigToolsRequestSource0

func (ResolveAgentConfigToolsRequest_Source) MarshalJSON 

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

func (*ResolveAgentConfigToolsRequest_Source) MergeAgentConfigToolsDefinition 

func (t *ResolveAgentConfigToolsRequest_Source) MergeAgentConfigToolsDefinition(v AgentConfigToolsDefinition) error

MergeAgentConfigToolsDefinition performs a merge with any union data inside the ResolveAgentConfigToolsRequest_Source, using the provided AgentConfigToolsDefinition

func (*ResolveAgentConfigToolsRequest_Source) MergeResolveAgentConfigToolsRequestSource0 

func (t *ResolveAgentConfigToolsRequest_Source) MergeResolveAgentConfigToolsRequestSource0(v ResolveAgentConfigToolsRequestSource0) error

MergeResolveAgentConfigToolsRequestSource0 performs a merge with any union data inside the ResolveAgentConfigToolsRequest_Source, using the provided ResolveAgentConfigToolsRequestSource0

func (*ResolveAgentConfigToolsRequest_Source) UnmarshalJSON 

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

type ResolveAgentInteractionJSONRequestBody 

type ResolveAgentInteractionJSONRequestBody = ResolveAgentInteractionRequest

ResolveAgentInteractionJSONRequestBody defines body for ResolveAgentInteraction for application/json ContentType.

type ResolveAgentInteractionRequest 

type ResolveAgentInteractionRequest struct {
	// Actor Identity and attributes of an external actor. Actors are upserted by (provider_tenant_id, provider_user_id) with the external provider. Omitted attributes keep their stored values; provided attributes are overwritten, including empty values. bma actors are implicit and hosted integrations own their own actor identities.
	Actor   *ExternalActorParams `json:"actor,omitempty"`
	Answers []InteractionAnswer  `json:"answers"`
}

ResolveAgentInteractionRequest defines model for ResolveAgentInteractionRequest.

type ResolvedAgentConfigTool 

type ResolvedAgentConfigTool struct {
	Enabled    bool                    `json:"enabled"`
	Name       string                  `json:"name"`
	Permission ToolPermissionSelection `json:"permission"`
}

ResolvedAgentConfigTool defines model for ResolvedAgentConfigTool.

type ResolvedAgentConfigTools 

type ResolvedAgentConfigTools struct {
	Tools []ResolvedAgentConfigTool `json:"tools"`
}

ResolvedAgentConfigTools defines model for ResolvedAgentConfigTools.

type ResourceListSort 

type ResourceListSort string

ResourceListSort Sort order for named resources that expose created and modified timestamps. 

const (
	ResourceListSortCreatedAt      ResourceListSort = "created_at"
	ResourceListSortMinusCreatedAt ResourceListSort = "-created_at"
	ResourceListSortMinusName      ResourceListSort = "-name"
	ResourceListSortMinusUpdatedAt ResourceListSort = "-updated_at"
	ResourceListSortName           ResourceListSort = "name"
	ResourceListSortUpdatedAt      ResourceListSort = "updated_at"
)

Defines values for ResourceListSort.

func (ResourceListSort) Valid 

func (e ResourceListSort) Valid() bool

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

type ResourceName 

type ResourceName = string

ResourceName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.

type ResourceNameFilter 

type ResourceNameFilter = string

ResourceNameFilter defines model for ResourceNameFilter.

type ResourceNameReference 

type ResourceNameReference = string

ResourceNameReference Name of an existing resource, resolved when the config is compiled.

type RestoreMachineFromBackupJSONRequestBody 

type RestoreMachineFromBackupJSONRequestBody = RestoreMachineFromBackupRequest

RestoreMachineFromBackupJSONRequestBody defines body for RestoreMachineFromBackup for application/json ContentType.

type RestoreMachineFromBackupRequest 

type RestoreMachineFromBackupRequest struct {
	// BackupID The ready backup to restore; defaults to the newest.
	BackupID *string `json:"backup_id,omitempty"`
}

RestoreMachineFromBackupRequest defines model for RestoreMachineFromBackupRequest.

type ResumeDesktopAgentJSONRequestBody 

type ResumeDesktopAgentJSONRequestBody = DesktopGenerationRequest

ResumeDesktopAgentJSONRequestBody defines body for ResumeDesktopAgent for application/json ContentType.

type RunnableTool 

type RunnableTool interface {
	Name() string
	// Definition is the agent config entry of tools.<name>.
	Definition() AgentConfigDefinitionTool
	// contains filtered or unexported methods
}

RunnableTool is a custom tool for Agents.ToolCalls.Runner.

func DefineTool 

func DefineTool[In any](name, description string, inputSchema map[string]any, fn func(ctx context.Context, input In, call ToolCall) (ToolContent, error)) RunnableTool

DefineTool defines a custom tool. inputSchema is the JSON Schema of the input object; the call input is decoded into In (a decoding error is reported to the model; unknown members are ignored) before fn runs. Return ToolError for a failure the model should see; any other error is reported the same way.

type Secret 

type Secret struct {
	CreatedAt            Timestamp `json:"created_at"`
	CurrentVersionNumber int32     `json:"current_version_number"`

	// ID Secret ID (sec_...).
	ID   SecretID   `json:"id"`
	Kind SecretKind `json:"kind"`

	// ManagementKind Lifecycle owner. Tenant-managed resources can be changed through tenant APIs. Cluster-managed resources are installed and lifecycle-managed by the control plane; individual APIs may explicitly expose tenant-editable settings.
	ManagementKind ManagementKind `json:"management_kind"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata Metadata `json:"metadata"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name        ResourceName   `json:"name"`
	OrgID       OrganizationID `json:"org_id"`
	Owner       SecretOwner    `json:"owner"`
	PayloadKeys []string       `json:"payload_keys"`
	UpdatedAt   Timestamp      `json:"updated_at"`
}

Secret defines model for Secret.

type SecretAvailability 

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

SecretAvailability defines model for SecretAvailability.

func (SecretAvailability) AsAny 

func (t SecretAvailability) AsAny() any

AsAny returns the member of SecretAvailability named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (SecretAvailability) AsDirectSecretAvailability 

func (t SecretAvailability) AsDirectSecretAvailability() (DirectSecretAvailability, error)

AsDirectSecretAvailability returns the union data inside the SecretAvailability as a DirectSecretAvailability

func (SecretAvailability) AsGrantedSecretAvailability 

func (t SecretAvailability) AsGrantedSecretAvailability() (GrantedSecretAvailability, error)

AsGrantedSecretAvailability returns the union data inside the SecretAvailability as a GrantedSecretAvailability

func (SecretAvailability) Discriminator 

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

func (*SecretAvailability) FromDirectSecretAvailability 

func (t *SecretAvailability) FromDirectSecretAvailability(v DirectSecretAvailability) error

FromDirectSecretAvailability overwrites any union data inside the SecretAvailability as the provided DirectSecretAvailability

func (*SecretAvailability) FromGrantedSecretAvailability 

func (t *SecretAvailability) FromGrantedSecretAvailability(v GrantedSecretAvailability) error

FromGrantedSecretAvailability overwrites any union data inside the SecretAvailability as the provided GrantedSecretAvailability

func (SecretAvailability) MarshalJSON 

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

func (*SecretAvailability) MergeDirectSecretAvailability 

func (t *SecretAvailability) MergeDirectSecretAvailability(v DirectSecretAvailability) error

MergeDirectSecretAvailability performs a merge with any union data inside the SecretAvailability, using the provided DirectSecretAvailability

func (*SecretAvailability) MergeGrantedSecretAvailability 

func (t *SecretAvailability) MergeGrantedSecretAvailability(v GrantedSecretAvailability) error

MergeGrantedSecretAvailability performs a merge with any union data inside the SecretAvailability, using the provided GrantedSecretAvailability

func (*SecretAvailability) UnmarshalJSON 

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

func (SecretAvailability) ValueByDiscriminator 

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

type SecretAvailabilitySourceFilter 

type SecretAvailabilitySourceFilter string

SecretAvailabilitySourceFilter defines model for SecretAvailabilitySourceFilter. 

const (
	SecretAvailabilitySourceFilterDirect SecretAvailabilitySourceFilter = "direct"
	SecretAvailabilitySourceFilterGrant  SecretAvailabilitySourceFilter = "grant"
)

Defines values for SecretAvailabilitySourceFilter.

func (SecretAvailabilitySourceFilter) Valid 

func (e SecretAvailabilitySourceFilter) Valid() bool

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

type SecretGrant 

type SecretGrant struct {
	CreatedAt Timestamp      `json:"created_at"`
	ID        SecretGrantID  `json:"id"`
	OrgID     OrganizationID `json:"org_id"`

	// SecretID Secret ID (sec_...).
	SecretID SecretID `json:"secret_id"`

	// TargetProjectID Project ID (proj_...).
	TargetProjectID ProjectID `json:"target_project_id"`
}

SecretGrant defines model for SecretGrant.

type SecretGrantCreateRequest 

type SecretGrantCreateRequest struct {
	// TargetProjectID Project ID (proj_...).
	TargetProjectID ProjectID `json:"target_project_id"`
}

SecretGrantCreateRequest defines model for SecretGrantCreateRequest.

type SecretGrantID 

type SecretGrantID = string

SecretGrantID defines model for SecretGrantID.

type SecretGrantListItem 

type SecretGrantListItem struct {
	Grant         SecretGrant `json:"grant"`
	TargetProject Project     `json:"target_project"`
}

SecretGrantListItem defines model for SecretGrantListItem.

type SecretID 

type SecretID = string

SecretID Secret ID (sec_...).

type SecretKind 

type SecretKind string

SecretKind defines model for SecretKind. 

const (
	SecretKindAWSCredentials       SecretKind = "aws_credentials"
	SecretKindGeneric              SecretKind = "generic"
	SecretKindGitHubAppCredentials SecretKind = "github_app_credentials"
	SecretKindOAuthTokenSet        SecretKind = "oauth_token_set"
	SecretKindSlackAppCredentials  SecretKind = "slack_app_credentials"
)

Defines values for SecretKind.

func (SecretKind) Valid 

func (e SecretKind) Valid() bool

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

type SecretKindFilter 

type SecretKindFilter = SecretKind

SecretKindFilter defines model for SecretKindFilter.

type SecretListParams 

type SecretListParams struct {
	Name               *ResourceNameFilter
	Kind               *SecretKindFilter
	OwnerKind          *ListProjectAvailableSecretsParamsOwnerKind
	AvailabilitySource *ListProjectAvailableSecretsParamsAvailabilitySource
	Metadata           *SecretMetadataFilter
	Sort               *ResourceListSort
	Limit              *PageLimit
	Cursor             *PageCursor
}

SecretListParams are the query, header and body fields of listProjectAvailableSecrets.

type SecretMCPOAuthFlowIDFilter 

type SecretMCPOAuthFlowIDFilter = MCPOAuthFlowID

SecretMCPOAuthFlowIDFilter defines model for SecretMCPOAuthFlowIDFilter.

type SecretMaterial 

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

SecretMaterial The secret's value. kind selects its shape: generic, oauth_token_set, aws_credentials, or github_app_credentials.

func (SecretMaterial) AsAWSCredentialsSecretMaterial 

func (t SecretMaterial) AsAWSCredentialsSecretMaterial() (AWSCredentialsSecretMaterial, error)

AsAWSCredentialsSecretMaterial returns the union data inside the SecretMaterial as a AWSCredentialsSecretMaterial

func (SecretMaterial) AsAny 

func (t SecretMaterial) AsAny() any

AsAny returns the member of SecretMaterial named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (SecretMaterial) AsGenericSecretMaterial 

func (t SecretMaterial) AsGenericSecretMaterial() (GenericSecretMaterial, error)

AsGenericSecretMaterial returns the union data inside the SecretMaterial as a GenericSecretMaterial

func (SecretMaterial) AsGitHubAppCredentialsSecretMaterial 

func (t SecretMaterial) AsGitHubAppCredentialsSecretMaterial() (GitHubAppCredentialsSecretMaterial, error)

AsGitHubAppCredentialsSecretMaterial returns the union data inside the SecretMaterial as a GitHubAppCredentialsSecretMaterial

func (SecretMaterial) AsOAuthTokenSetSecretMaterial 

func (t SecretMaterial) AsOAuthTokenSetSecretMaterial() (OAuthTokenSetSecretMaterial, error)

AsOAuthTokenSetSecretMaterial returns the union data inside the SecretMaterial as a OAuthTokenSetSecretMaterial

func (SecretMaterial) Discriminator 

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

func (*SecretMaterial) FromAWSCredentialsSecretMaterial 

func (t *SecretMaterial) FromAWSCredentialsSecretMaterial(v AWSCredentialsSecretMaterial) error

FromAWSCredentialsSecretMaterial overwrites any union data inside the SecretMaterial as the provided AWSCredentialsSecretMaterial

func (*SecretMaterial) FromGenericSecretMaterial 

func (t *SecretMaterial) FromGenericSecretMaterial(v GenericSecretMaterial) error

FromGenericSecretMaterial overwrites any union data inside the SecretMaterial as the provided GenericSecretMaterial

func (*SecretMaterial) FromGitHubAppCredentialsSecretMaterial 

func (t *SecretMaterial) FromGitHubAppCredentialsSecretMaterial(v GitHubAppCredentialsSecretMaterial) error

FromGitHubAppCredentialsSecretMaterial overwrites any union data inside the SecretMaterial as the provided GitHubAppCredentialsSecretMaterial

func (*SecretMaterial) FromOAuthTokenSetSecretMaterial 

func (t *SecretMaterial) FromOAuthTokenSetSecretMaterial(v OAuthTokenSetSecretMaterial) error

FromOAuthTokenSetSecretMaterial overwrites any union data inside the SecretMaterial as the provided OAuthTokenSetSecretMaterial

func (SecretMaterial) MarshalJSON 

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

func (*SecretMaterial) MergeAWSCredentialsSecretMaterial 

func (t *SecretMaterial) MergeAWSCredentialsSecretMaterial(v AWSCredentialsSecretMaterial) error

MergeAWSCredentialsSecretMaterial performs a merge with any union data inside the SecretMaterial, using the provided AWSCredentialsSecretMaterial

func (*SecretMaterial) MergeGenericSecretMaterial 

func (t *SecretMaterial) MergeGenericSecretMaterial(v GenericSecretMaterial) error

MergeGenericSecretMaterial performs a merge with any union data inside the SecretMaterial, using the provided GenericSecretMaterial

func (*SecretMaterial) MergeGitHubAppCredentialsSecretMaterial 

func (t *SecretMaterial) MergeGitHubAppCredentialsSecretMaterial(v GitHubAppCredentialsSecretMaterial) error

MergeGitHubAppCredentialsSecretMaterial performs a merge with any union data inside the SecretMaterial, using the provided GitHubAppCredentialsSecretMaterial

func (*SecretMaterial) MergeOAuthTokenSetSecretMaterial 

func (t *SecretMaterial) MergeOAuthTokenSetSecretMaterial(v OAuthTokenSetSecretMaterial) error

MergeOAuthTokenSetSecretMaterial performs a merge with any union data inside the SecretMaterial, using the provided OAuthTokenSetSecretMaterial

func (*SecretMaterial) UnmarshalJSON 

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

func (SecretMaterial) ValueByDiscriminator 

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

type SecretMetadataFilter 

type SecretMetadataFilter map[string]string

SecretMetadataFilter defines model for SecretMetadataFilter.

type SecretOwner 

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

SecretOwner defines model for SecretOwner.

func (SecretOwner) AsAny 

func (t SecretOwner) AsAny() any

AsAny returns the member of SecretOwner named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (SecretOwner) AsOrgSecretOwner 

func (t SecretOwner) AsOrgSecretOwner() (OrgSecretOwner, error)

AsOrgSecretOwner returns the union data inside the SecretOwner as a OrgSecretOwner

func (SecretOwner) AsProjectSecretOwner 

func (t SecretOwner) AsProjectSecretOwner() (ProjectSecretOwner, error)

AsProjectSecretOwner returns the union data inside the SecretOwner as a ProjectSecretOwner

func (SecretOwner) AsUserSecretOwner 

func (t SecretOwner) AsUserSecretOwner() (UserSecretOwner, error)

AsUserSecretOwner returns the union data inside the SecretOwner as a UserSecretOwner

func (SecretOwner) Discriminator 

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

func (*SecretOwner) FromOrgSecretOwner 

func (t *SecretOwner) FromOrgSecretOwner(v OrgSecretOwner) error

FromOrgSecretOwner overwrites any union data inside the SecretOwner as the provided OrgSecretOwner

func (*SecretOwner) FromProjectSecretOwner 

func (t *SecretOwner) FromProjectSecretOwner(v ProjectSecretOwner) error

FromProjectSecretOwner overwrites any union data inside the SecretOwner as the provided ProjectSecretOwner

func (*SecretOwner) FromUserSecretOwner 

func (t *SecretOwner) FromUserSecretOwner(v UserSecretOwner) error

FromUserSecretOwner overwrites any union data inside the SecretOwner as the provided UserSecretOwner

func (SecretOwner) MarshalJSON 

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

func (*SecretOwner) MergeOrgSecretOwner 

func (t *SecretOwner) MergeOrgSecretOwner(v OrgSecretOwner) error

MergeOrgSecretOwner performs a merge with any union data inside the SecretOwner, using the provided OrgSecretOwner

func (*SecretOwner) MergeProjectSecretOwner 

func (t *SecretOwner) MergeProjectSecretOwner(v ProjectSecretOwner) error

MergeProjectSecretOwner performs a merge with any union data inside the SecretOwner, using the provided ProjectSecretOwner

func (*SecretOwner) MergeUserSecretOwner 

func (t *SecretOwner) MergeUserSecretOwner(v UserSecretOwner) error

MergeUserSecretOwner performs a merge with any union data inside the SecretOwner, using the provided UserSecretOwner

func (*SecretOwner) UnmarshalJSON 

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

func (SecretOwner) ValueByDiscriminator 

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

type SecretOwnerInput 

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

SecretOwnerInput Who owns the secret: {"kind":"org"}, {"kind":"project","project_id":"proj_..."}, or {"kind":"user"}. The owner cannot change later.

func (SecretOwnerInput) AsAny 

func (t SecretOwnerInput) AsAny() any

AsAny returns the member of SecretOwnerInput named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (SecretOwnerInput) AsOrgSecretOwnerInput 

func (t SecretOwnerInput) AsOrgSecretOwnerInput() (OrgSecretOwnerInput, error)

AsOrgSecretOwnerInput returns the union data inside the SecretOwnerInput as a OrgSecretOwnerInput

func (SecretOwnerInput) AsProjectSecretOwnerInput 

func (t SecretOwnerInput) AsProjectSecretOwnerInput() (ProjectSecretOwnerInput, error)

AsProjectSecretOwnerInput returns the union data inside the SecretOwnerInput as a ProjectSecretOwnerInput

func (SecretOwnerInput) AsUserSecretOwnerInput 

func (t SecretOwnerInput) AsUserSecretOwnerInput() (UserSecretOwnerInput, error)

AsUserSecretOwnerInput returns the union data inside the SecretOwnerInput as a UserSecretOwnerInput

func (SecretOwnerInput) Discriminator 

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

func (*SecretOwnerInput) FromOrgSecretOwnerInput 

func (t *SecretOwnerInput) FromOrgSecretOwnerInput(v OrgSecretOwnerInput) error

FromOrgSecretOwnerInput overwrites any union data inside the SecretOwnerInput as the provided OrgSecretOwnerInput

func (*SecretOwnerInput) FromProjectSecretOwnerInput 

func (t *SecretOwnerInput) FromProjectSecretOwnerInput(v ProjectSecretOwnerInput) error

FromProjectSecretOwnerInput overwrites any union data inside the SecretOwnerInput as the provided ProjectSecretOwnerInput

func (*SecretOwnerInput) FromUserSecretOwnerInput 

func (t *SecretOwnerInput) FromUserSecretOwnerInput(v UserSecretOwnerInput) error

FromUserSecretOwnerInput overwrites any union data inside the SecretOwnerInput as the provided UserSecretOwnerInput

func (SecretOwnerInput) MarshalJSON 

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

func (*SecretOwnerInput) MergeOrgSecretOwnerInput 

func (t *SecretOwnerInput) MergeOrgSecretOwnerInput(v OrgSecretOwnerInput) error

MergeOrgSecretOwnerInput performs a merge with any union data inside the SecretOwnerInput, using the provided OrgSecretOwnerInput

func (*SecretOwnerInput) MergeProjectSecretOwnerInput 

func (t *SecretOwnerInput) MergeProjectSecretOwnerInput(v ProjectSecretOwnerInput) error

MergeProjectSecretOwnerInput performs a merge with any union data inside the SecretOwnerInput, using the provided ProjectSecretOwnerInput

func (*SecretOwnerInput) MergeUserSecretOwnerInput 

func (t *SecretOwnerInput) MergeUserSecretOwnerInput(v UserSecretOwnerInput) error

MergeUserSecretOwnerInput performs a merge with any union data inside the SecretOwnerInput, using the provided UserSecretOwnerInput

func (*SecretOwnerInput) UnmarshalJSON 

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

func (SecretOwnerInput) ValueByDiscriminator 

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

type SecretOwnerKindFilter 

type SecretOwnerKindFilter string

SecretOwnerKindFilter defines model for SecretOwnerKindFilter. 

const (
	SecretOwnerKindFilterOrg     SecretOwnerKindFilter = "org"
	SecretOwnerKindFilterProject SecretOwnerKindFilter = "project"
	SecretOwnerKindFilterUser    SecretOwnerKindFilter = "user"
)

Defines values for SecretOwnerKindFilter.

func (SecretOwnerKindFilter) Valid 

func (e SecretOwnerKindFilter) Valid() bool

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

type SecretOwnerProjectIDFilter 

type SecretOwnerProjectIDFilter = ProjectID

SecretOwnerProjectIDFilter Project ID (proj_...).

type SecretService 

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

SecretService groups the secrets methods.

func (*SecretService) Get 

func (s *SecretService) Get(ctx context.Context, secretID string, opts ...option.RequestOption) (*ProjectSecretAccess, error)

Get calls getProjectAvailableSecret: GET /orgs/{orgID}/projects/{projectID}/secrets/{secretID}.

func (*SecretService) List 

func (s *SecretService) List(ctx context.Context, params SecretListParams, opts ...option.RequestOption) (*CursorPage[ProjectSecretAccess], error)

List calls listProjectAvailableSecrets: GET /orgs/{orgID}/projects/{projectID}/secrets.

func (*SecretService) ListAutoPaging 

func (s *SecretService) ListAutoPaging(ctx context.Context, params SecretListParams, opts ...option.RequestOption) *CursorPageAutoPager[ProjectSecretAccess]

ListAutoPaging iterates every item of listProjectAvailableSecrets across pages.

type SecretVersionRequest 

type SecretVersionRequest struct {
	// Material The secret's value. kind selects its shape: generic, oauth_token_set, aws_credentials, or github_app_credentials.
	Material SecretMaterial `json:"material"`
}

SecretVersionRequest defines model for SecretVersionRequest.

type SendDesktopActionsJSONRequestBody 

type SendDesktopActionsJSONRequestBody = DesktopActionRequest

SendDesktopActionsJSONRequestBody defines body for SendDesktopActions for application/json ContentType.

type ServerError 

type ServerError struct {
	// Code Stable error code carried by 5XX statuses. Subset of the Error code enum whose statuses are server errors.
	Code ServerErrorCode `json:"code"`

	// Error Human-readable error message. Do not match on it programmatically.
	Error string `json:"error"`
}

ServerError defines model for ServerError.

type ServerErrorCode 

type ServerErrorCode = string

ServerErrorCode Stable error code carried by 5XX statuses. Subset of the Error code enum whose statuses are server errors.

type ServiceUnavailable 

type ServiceUnavailable = ErrorBody

ServiceUnavailable defines model for ServiceUnavailable.

type SessionArtifactList 

type SessionArtifactList struct {
	Data       []Artifact `json:"data"`
	NextCursor *string    `json:"next_cursor"`
}

SessionArtifactList defines model for SessionArtifactList.

type SessionFileResource 

type SessionFileResource struct {
	CreatedAt Timestamp `json:"created_at"`
	Digest    string    `json:"digest"`

	// FileID File ID (file_...).
	FileID   FileID `json:"file_id"`
	Filename string `json:"filename"`
	ID       string `json:"id"`
	MimeType string `json:"mime_type"`

	// MountPath Absolute path the session's tools read the file at.
	MountPath string                  `json:"mount_path"`
	SizeBytes int64                   `json:"size_bytes"`
	Type      SessionFileResourceType `json:"type"`
	UpdatedAt Timestamp               `json:"updated_at"`
}

SessionFileResource A file mounted into a session. file_id is the session instance created for the mount, not the mounted file's id; GET /files/{file_id} and its content read it.

type SessionFileResourceList 

type SessionFileResourceList struct {
	Data []SessionFileResource `json:"data"`
}

SessionFileResourceList defines model for SessionFileResourceList.

type SessionFileResourceType 

type SessionFileResourceType string

SessionFileResourceType defines model for SessionFileResource.Type. 

const (
	SessionFileResourceTypeFile SessionFileResourceType = "file"
)

Defines values for SessionFileResourceType.

func (SessionFileResourceType) Valid 

func (e SessionFileResourceType) Valid() bool

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

type SessionListParams 

type SessionListParams struct {
	AgentProfileID   *AgentProfileID
	IncludeArchived  *bool
	IncludeDefault   *bool
	IncludeSubagents *bool
	Order            *ListProjectAgentSessionsParamsOrder
	AfterID          *string
	Limit            *int32
}

SessionListParams are the query, header and body fields of listProjectAgentSessions.

type SessionService 

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

SessionService groups the sessions methods.

func (*SessionService) Get 

func (s *SessionService) Get(ctx context.Context, sessionID string, opts ...option.RequestOption) (*AgentSessionEnvelope, error)

Get calls getProjectAgentSession: GET /orgs/{orgID}/projects/{projectID}/agent-sessions/{sessionID}.

func (*SessionService) List 

func (s *SessionService) List(ctx context.Context, params SessionListParams, opts ...option.RequestOption) (*CursorPage[AgentSession], error)

List calls listProjectAgentSessions: GET /orgs/{orgID}/projects/{projectID}/agent-sessions.

func (*SessionService) ListAutoPaging 

func (s *SessionService) ListAutoPaging(ctx context.Context, params SessionListParams, opts ...option.RequestOption) *CursorPageAutoPager[AgentSession]

ListAutoPaging iterates every item of listProjectAgentSessions across pages.

type SetMemberProjectAccessJSONRequestBody 

type SetMemberProjectAccessJSONRequestBody = SetProjectMembershipRequest

SetMemberProjectAccessJSONRequestBody defines body for SetMemberProjectAccess for application/json ContentType.

type SetOrgAPIKeyProjectRoleJSONRequestBody 

type SetOrgAPIKeyProjectRoleJSONRequestBody = SetProjectMembershipRequest

SetOrgAPIKeyProjectRoleJSONRequestBody defines body for SetOrgAPIKeyProjectRole for application/json ContentType.

type SetProjectMembershipRequest 

type SetProjectMembershipRequest struct {
	// Role The member's project role (admin, developer, operator, or viewer).
	Role string `json:"role"`
}

SetProjectMembershipRequest defines model for SetProjectMembershipRequest.

type Skill 

type Skill struct {
	CreatedAt   Timestamp `json:"created_at"`
	Description string    `json:"description"`

	// Files Files in the skill archive, including SKILL.md, with paths relative to the skill's top-level directory. Returned when fetching a single skill; omitted from list responses.
	Files *[]SkillFile `json:"files,omitempty"`
	ID    SkillID      `json:"id"`

	// Name Machine-readable skill identifier consisting of lowercase ASCII segments separated by single hyphens.
	Name  SkillName      `json:"name"`
	OrgID OrganizationID `json:"org_id"`
	Owner SkillOwner     `json:"owner"`

	// Revision Latest revision number of the skill.
	Revision   int32           `json:"revision"`
	RevisionID SkillRevisionID `json:"revision_id"`
	SkillMd    *string         `json:"skill_md,omitempty"`
	UpdatedAt  Timestamp       `json:"updated_at"`
}

Skill defines model for Skill.

type SkillAvailability 

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

SkillAvailability defines model for SkillAvailability.

func (SkillAvailability) AsAny 

func (t SkillAvailability) AsAny() any

AsAny returns the member of SkillAvailability named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (SkillAvailability) AsDirectSkillAvailability 

func (t SkillAvailability) AsDirectSkillAvailability() (DirectSkillAvailability, error)

AsDirectSkillAvailability returns the union data inside the SkillAvailability as a DirectSkillAvailability

func (SkillAvailability) AsGrantedSkillAvailability 

func (t SkillAvailability) AsGrantedSkillAvailability() (GrantedSkillAvailability, error)

AsGrantedSkillAvailability returns the union data inside the SkillAvailability as a GrantedSkillAvailability

func (SkillAvailability) Discriminator 

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

func (*SkillAvailability) FromDirectSkillAvailability 

func (t *SkillAvailability) FromDirectSkillAvailability(v DirectSkillAvailability) error

FromDirectSkillAvailability overwrites any union data inside the SkillAvailability as the provided DirectSkillAvailability

func (*SkillAvailability) FromGrantedSkillAvailability 

func (t *SkillAvailability) FromGrantedSkillAvailability(v GrantedSkillAvailability) error

FromGrantedSkillAvailability overwrites any union data inside the SkillAvailability as the provided GrantedSkillAvailability

func (SkillAvailability) MarshalJSON 

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

func (*SkillAvailability) MergeDirectSkillAvailability 

func (t *SkillAvailability) MergeDirectSkillAvailability(v DirectSkillAvailability) error

MergeDirectSkillAvailability performs a merge with any union data inside the SkillAvailability, using the provided DirectSkillAvailability

func (*SkillAvailability) MergeGrantedSkillAvailability 

func (t *SkillAvailability) MergeGrantedSkillAvailability(v GrantedSkillAvailability) error

MergeGrantedSkillAvailability performs a merge with any union data inside the SkillAvailability, using the provided GrantedSkillAvailability

func (*SkillAvailability) UnmarshalJSON 

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

func (SkillAvailability) ValueByDiscriminator 

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

type SkillAvailabilitySourceFilter 

type SkillAvailabilitySourceFilter string

SkillAvailabilitySourceFilter defines model for SkillAvailabilitySourceFilter. 

const (
	SkillAvailabilitySourceFilterDirect SkillAvailabilitySourceFilter = "direct"
	SkillAvailabilitySourceFilterGrant  SkillAvailabilitySourceFilter = "grant"
)

Defines values for SkillAvailabilitySourceFilter.

func (SkillAvailabilitySourceFilter) Valid 

func (e SkillAvailabilitySourceFilter) Valid() bool

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

type SkillFile 

type SkillFile struct {
	Path string `json:"path"`
	Size int64  `json:"size"`
}

SkillFile defines model for SkillFile.

type SkillGrant 

type SkillGrant struct {
	CreatedAt Timestamp      `json:"created_at"`
	ID        SkillGrantID   `json:"id"`
	OrgID     OrganizationID `json:"org_id"`
	SkillID   SkillID        `json:"skill_id"`

	// TargetProjectID Project ID (proj_...).
	TargetProjectID ProjectID `json:"target_project_id"`
}

SkillGrant defines model for SkillGrant.

type SkillGrantCreateRequest 

type SkillGrantCreateRequest struct {
	// TargetProjectID Project ID (proj_...).
	TargetProjectID ProjectID `json:"target_project_id"`
}

SkillGrantCreateRequest defines model for SkillGrantCreateRequest.

type SkillGrantID 

type SkillGrantID = string

SkillGrantID defines model for SkillGrantID.

type SkillGrantListItem 

type SkillGrantListItem struct {
	Grant         SkillGrant `json:"grant"`
	TargetProject Project    `json:"target_project"`
}

SkillGrantListItem defines model for SkillGrantListItem.

type SkillID 

type SkillID = string

SkillID defines model for SkillID.

type SkillListParams 

type SkillListParams struct {
	Name               *ResourceNameFilter
	OwnerKind          *ListProjectAvailableSkillsParamsOwnerKind
	AvailabilitySource *ListProjectAvailableSkillsParamsAvailabilitySource
	Sort               *ResourceListSort
	Limit              *PageLimit
	Cursor             *PageCursor
}

SkillListParams are the query, header and body fields of listProjectAvailableSkills.

type SkillName 

type SkillName = string

SkillName Machine-readable skill identifier consisting of lowercase ASCII segments separated by single hyphens.

type SkillOwner 

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

SkillOwner defines model for SkillOwner.

func (SkillOwner) AsAny 

func (t SkillOwner) AsAny() any

AsAny returns the member of SkillOwner named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (SkillOwner) AsOrgSkillOwner 

func (t SkillOwner) AsOrgSkillOwner() (OrgSkillOwner, error)

AsOrgSkillOwner returns the union data inside the SkillOwner as a OrgSkillOwner

func (SkillOwner) AsProjectSkillOwner 

func (t SkillOwner) AsProjectSkillOwner() (ProjectSkillOwner, error)

AsProjectSkillOwner returns the union data inside the SkillOwner as a ProjectSkillOwner

func (SkillOwner) AsUserSkillOwner 

func (t SkillOwner) AsUserSkillOwner() (UserSkillOwner, error)

AsUserSkillOwner returns the union data inside the SkillOwner as a UserSkillOwner

func (SkillOwner) Discriminator 

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

func (*SkillOwner) FromOrgSkillOwner 

func (t *SkillOwner) FromOrgSkillOwner(v OrgSkillOwner) error

FromOrgSkillOwner overwrites any union data inside the SkillOwner as the provided OrgSkillOwner

func (*SkillOwner) FromProjectSkillOwner 

func (t *SkillOwner) FromProjectSkillOwner(v ProjectSkillOwner) error

FromProjectSkillOwner overwrites any union data inside the SkillOwner as the provided ProjectSkillOwner

func (*SkillOwner) FromUserSkillOwner 

func (t *SkillOwner) FromUserSkillOwner(v UserSkillOwner) error

FromUserSkillOwner overwrites any union data inside the SkillOwner as the provided UserSkillOwner

func (SkillOwner) MarshalJSON 

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

func (*SkillOwner) MergeOrgSkillOwner 

func (t *SkillOwner) MergeOrgSkillOwner(v OrgSkillOwner) error

MergeOrgSkillOwner performs a merge with any union data inside the SkillOwner, using the provided OrgSkillOwner

func (*SkillOwner) MergeProjectSkillOwner 

func (t *SkillOwner) MergeProjectSkillOwner(v ProjectSkillOwner) error

MergeProjectSkillOwner performs a merge with any union data inside the SkillOwner, using the provided ProjectSkillOwner

func (*SkillOwner) MergeUserSkillOwner 

func (t *SkillOwner) MergeUserSkillOwner(v UserSkillOwner) error

MergeUserSkillOwner performs a merge with any union data inside the SkillOwner, using the provided UserSkillOwner

func (*SkillOwner) UnmarshalJSON 

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

func (SkillOwner) ValueByDiscriminator 

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

type SkillOwnerInput 

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

SkillOwnerInput defines model for SkillOwnerInput.

func (SkillOwnerInput) AsAny 

func (t SkillOwnerInput) AsAny() any

AsAny returns the member of SkillOwnerInput named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (SkillOwnerInput) AsOrgSkillOwnerInput 

func (t SkillOwnerInput) AsOrgSkillOwnerInput() (OrgSkillOwnerInput, error)

AsOrgSkillOwnerInput returns the union data inside the SkillOwnerInput as a OrgSkillOwnerInput

func (SkillOwnerInput) AsProjectSkillOwnerInput 

func (t SkillOwnerInput) AsProjectSkillOwnerInput() (ProjectSkillOwnerInput, error)

AsProjectSkillOwnerInput returns the union data inside the SkillOwnerInput as a ProjectSkillOwnerInput

func (SkillOwnerInput) AsUserSkillOwnerInput 

func (t SkillOwnerInput) AsUserSkillOwnerInput() (UserSkillOwnerInput, error)

AsUserSkillOwnerInput returns the union data inside the SkillOwnerInput as a UserSkillOwnerInput

func (SkillOwnerInput) Discriminator 

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

func (*SkillOwnerInput) FromOrgSkillOwnerInput 

func (t *SkillOwnerInput) FromOrgSkillOwnerInput(v OrgSkillOwnerInput) error

FromOrgSkillOwnerInput overwrites any union data inside the SkillOwnerInput as the provided OrgSkillOwnerInput

func (*SkillOwnerInput) FromProjectSkillOwnerInput 

func (t *SkillOwnerInput) FromProjectSkillOwnerInput(v ProjectSkillOwnerInput) error

FromProjectSkillOwnerInput overwrites any union data inside the SkillOwnerInput as the provided ProjectSkillOwnerInput

func (*SkillOwnerInput) FromUserSkillOwnerInput 

func (t *SkillOwnerInput) FromUserSkillOwnerInput(v UserSkillOwnerInput) error

FromUserSkillOwnerInput overwrites any union data inside the SkillOwnerInput as the provided UserSkillOwnerInput

func (SkillOwnerInput) MarshalJSON 

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

func (*SkillOwnerInput) MergeOrgSkillOwnerInput 

func (t *SkillOwnerInput) MergeOrgSkillOwnerInput(v OrgSkillOwnerInput) error

MergeOrgSkillOwnerInput performs a merge with any union data inside the SkillOwnerInput, using the provided OrgSkillOwnerInput

func (*SkillOwnerInput) MergeProjectSkillOwnerInput 

func (t *SkillOwnerInput) MergeProjectSkillOwnerInput(v ProjectSkillOwnerInput) error

MergeProjectSkillOwnerInput performs a merge with any union data inside the SkillOwnerInput, using the provided ProjectSkillOwnerInput

func (*SkillOwnerInput) MergeUserSkillOwnerInput 

func (t *SkillOwnerInput) MergeUserSkillOwnerInput(v UserSkillOwnerInput) error

MergeUserSkillOwnerInput performs a merge with any union data inside the SkillOwnerInput, using the provided UserSkillOwnerInput

func (*SkillOwnerInput) UnmarshalJSON 

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

func (SkillOwnerInput) ValueByDiscriminator 

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

type SkillOwnerKindFilter 

type SkillOwnerKindFilter string

SkillOwnerKindFilter defines model for SkillOwnerKindFilter. 

const (
	SkillOwnerKindFilterOrg     SkillOwnerKindFilter = "org"
	SkillOwnerKindFilterProject SkillOwnerKindFilter = "project"
	SkillOwnerKindFilterUser    SkillOwnerKindFilter = "user"
)

Defines values for SkillOwnerKindFilter.

func (SkillOwnerKindFilter) Valid 

func (e SkillOwnerKindFilter) Valid() bool

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

type SkillOwnerProjectIDFilter 

type SkillOwnerProjectIDFilter = ProjectID

SkillOwnerProjectIDFilter Project ID (proj_...).

type SkillRevisionID 

type SkillRevisionID = string

SkillRevisionID defines model for SkillRevisionID.

type SkillService 

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

SkillService groups the skills methods.

func (*SkillService) List 

func (s *SkillService) List(ctx context.Context, params SkillListParams, opts ...option.RequestOption) (*CursorPage[ProjectSkillAccess], error)

List calls listProjectAvailableSkills: GET /orgs/{orgID}/projects/{projectID}/skills.

func (*SkillService) ListAutoPaging 

func (s *SkillService) ListAutoPaging(ctx context.Context, params SkillListParams, opts ...option.RequestOption) *CursorPageAutoPager[ProjectSkillAccess]

ListAutoPaging iterates every item of listProjectAvailableSkills across pages.

type SlackSetup 

type SlackSetup struct {
	ActionsURL    string                 `json:"actions_url"`
	EventsURL     string                 `json:"events_url"`
	ExpiresAt     Timestamp              `json:"expires_at"`
	FlowID        IntegrationOAuthFlowID `json:"flow_id"`
	IntegrationID IntegrationID          `json:"integration_id"`
	OauthURL      string                 `json:"oauth_url"`
	Provider      string                 `json:"provider"`
	RedirectURI   string                 `json:"redirect_uri"`

	// SetupRevision Integration setup revision captured by this authorization flow.
	SetupRevision int    `json:"setup_revision"`
	SlackAppID    string `json:"slack_app_id"`
}

SlackSetup defines model for SlackSetup.

type SlackSetupIcon 

type SlackSetupIcon struct {
	DataBase64 string  `json:"data_base64"`
	Filename   *string `json:"filename,omitempty"`
}

SlackSetupIcon defines model for SlackSetupIcon.

type StartSecretMCPOAuthJSONRequestBody 

type StartSecretMCPOAuthJSONRequestBody = MCPOAuthStartRequest

StartSecretMCPOAuthJSONRequestBody defines body for StartSecretMCPOAuth for application/json ContentType.

type Stream 

type Stream[T any] = apicore.Stream[T]

Stream is a typed server-sent event stream.

type StreamEventsEvent 

type StreamEventsEvent struct {
	Event    string
	ID       string
	Sequence int64
	Data     json.RawMessage
	// contains filtered or unexported fields
}

StreamEventsEvent is one server-sent event frame. Event is the SSE event name; durable frames also carry ID and Sequence. AsAny returns the decoded payload: AgentInputEvent (agent_input), ModelOutputEvent (model_output), ToolResultEvent (tool_result), ContextCheckpointEvent (context_checkpoint), ExecutorEvent (executor_event), ToolCallUpdate (tool_call_update), ModelOutputDelta (model_output_delta), ExecutorInteractionUpdate (executor_interaction_update), AgentEventDelta (agent_event_delta).

func (StreamEventsEvent) AsAny 

func (e StreamEventsEvent) AsAny() any

AsAny returns the payload as its contract type; switch on it.

type StreamEventsParams 

type StreamEventsParams struct {
	// SessionID Agent session ID (ses_...). Omit to use the agent's default session.
	SessionID     *string `form:"session_id,omitempty" json:"session_id,omitempty"`
	AfterSequence *int64  `form:"after_sequence,omitempty" json:"after_sequence,omitempty"`

	// StreamDeltas Opt in to ephemeral delta streamed frames while a model call is in flight. This includes partial assistant text, tool call, and reasoning output. Each frame carries the public `turn_id` and `model_call_context_id` it belongs to, and `tool_use` block starts carry the same public `tool_call_id` the durable `model_output` content block and `tool_result` event will use. Deltas are best-effort: they are not persisted and are not replayed on reconnect. The durable `model_output` event remains the source of truth. Default false.
	StreamDeltas *bool  `form:"stream_deltas,omitempty" json:"stream_deltas,omitempty"`
	LastEventID  *int64 `json:"Last-Event-ID,omitempty"`
}

StreamEventsParams defines parameters for StreamEvents.

type StructuredDataContentBlock 

type StructuredDataContentBlock struct {
	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata *ContentBlockMetadata          `json:"metadata,omitempty"`
	Type     StructuredDataContentBlockType `json:"type"`

	// Value Public JSON payload whose shape is determined by the event or interaction kind.
	Value JSONBlob `json:"value"`
}

StructuredDataContentBlock defines model for StructuredDataContentBlock.

type StructuredDataContentBlockType 

type StructuredDataContentBlockType string

StructuredDataContentBlockType defines model for StructuredDataContentBlock.Type. 

const (
	StructuredData StructuredDataContentBlockType = "structured_data"
)

Defines values for StructuredDataContentBlockType.

func (StructuredDataContentBlockType) Valid 

func (e StructuredDataContentBlockType) Valid() bool

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

type SubmitDesktopActionJSONRequestBody 

type SubmitDesktopActionJSONRequestBody = DesktopAgentActionRequest

SubmitDesktopActionJSONRequestBody defines body for SubmitDesktopAction for application/json ContentType.

type SubmitToolCallResultJSONRequestBody 

type SubmitToolCallResultJSONRequestBody = SubmitToolCallResultRequest

SubmitToolCallResultJSONRequestBody defines body for SubmitToolCallResult for application/json ContentType.

type SubmitToolCallResultRequest 

type SubmitToolCallResultRequest struct {
	// ContentBlocks At most 20 inline media blocks per submission, each holding up to 10 MiB of decoded media and up to 24 MiB decoded across the submission. Non-media blocks may hold up to 1 MiB combined. The whole request body is capped at 48 MiB.
	ContentBlocks []SubmitToolResultContentBlock `json:"content_blocks"`

	// Outcome Whether the custom tool call succeeded or failed.
	Outcome SubmitToolCallResultRequestOutcome `json:"outcome"`
}

SubmitToolCallResultRequest defines model for SubmitToolCallResultRequest.

type SubmitToolCallResultRequestOutcome 

type SubmitToolCallResultRequestOutcome string

SubmitToolCallResultRequestOutcome Whether the custom tool call succeeded or failed. 

const (
	SubmitToolCallResultRequestOutcomeFailed    SubmitToolCallResultRequestOutcome = "failed"
	SubmitToolCallResultRequestOutcomeSucceeded SubmitToolCallResultRequestOutcome = "succeeded"
)

Defines values for SubmitToolCallResultRequestOutcome.

func (SubmitToolCallResultRequestOutcome) Valid 

func (e SubmitToolCallResultRequestOutcome) Valid() bool

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

type SubmitToolCallResultResponse 

type SubmitToolCallResultResponse struct {
	// ToolCall A model-emitted tool call together with its current lifecycle state.
	ToolCall   ToolCall   `json:"tool_call"`
	ToolResult ToolResult `json:"tool_result"`
}

SubmitToolCallResultResponse defines model for SubmitToolCallResultResponse.

type SubmitToolResultContentBlock 

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

SubmitToolResultContentBlock Submission accepts inline media. The persisted response exposes that media as a `media_ref` block.

func (SubmitToolResultContentBlock) AsAny 

func (t SubmitToolResultContentBlock) AsAny() any

AsAny returns the member of SubmitToolResultContentBlock named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (SubmitToolResultContentBlock) AsInlineMediaContentBlock 

func (t SubmitToolResultContentBlock) AsInlineMediaContentBlock() (InlineMediaContentBlock, error)

AsInlineMediaContentBlock returns the union data inside the SubmitToolResultContentBlock as a InlineMediaContentBlock

func (SubmitToolResultContentBlock) AsStructuredDataContentBlock 

func (t SubmitToolResultContentBlock) AsStructuredDataContentBlock() (StructuredDataContentBlock, error)

AsStructuredDataContentBlock returns the union data inside the SubmitToolResultContentBlock as a StructuredDataContentBlock

func (SubmitToolResultContentBlock) AsTextContentBlock 

func (t SubmitToolResultContentBlock) AsTextContentBlock() (TextContentBlock, error)

AsTextContentBlock returns the union data inside the SubmitToolResultContentBlock as a TextContentBlock

func (SubmitToolResultContentBlock) Discriminator 

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

func (*SubmitToolResultContentBlock) FromInlineMediaContentBlock 

func (t *SubmitToolResultContentBlock) FromInlineMediaContentBlock(v InlineMediaContentBlock) error

FromInlineMediaContentBlock overwrites any union data inside the SubmitToolResultContentBlock as the provided InlineMediaContentBlock

func (*SubmitToolResultContentBlock) FromStructuredDataContentBlock 

func (t *SubmitToolResultContentBlock) FromStructuredDataContentBlock(v StructuredDataContentBlock) error

FromStructuredDataContentBlock overwrites any union data inside the SubmitToolResultContentBlock as the provided StructuredDataContentBlock

func (*SubmitToolResultContentBlock) FromTextContentBlock 

func (t *SubmitToolResultContentBlock) FromTextContentBlock(v TextContentBlock) error

FromTextContentBlock overwrites any union data inside the SubmitToolResultContentBlock as the provided TextContentBlock

func (SubmitToolResultContentBlock) MarshalJSON 

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

func (*SubmitToolResultContentBlock) MergeInlineMediaContentBlock 

func (t *SubmitToolResultContentBlock) MergeInlineMediaContentBlock(v InlineMediaContentBlock) error

MergeInlineMediaContentBlock performs a merge with any union data inside the SubmitToolResultContentBlock, using the provided InlineMediaContentBlock

func (*SubmitToolResultContentBlock) MergeStructuredDataContentBlock 

func (t *SubmitToolResultContentBlock) MergeStructuredDataContentBlock(v StructuredDataContentBlock) error

MergeStructuredDataContentBlock performs a merge with any union data inside the SubmitToolResultContentBlock, using the provided StructuredDataContentBlock

func (*SubmitToolResultContentBlock) MergeTextContentBlock 

func (t *SubmitToolResultContentBlock) MergeTextContentBlock(v TextContentBlock) error

MergeTextContentBlock performs a merge with any union data inside the SubmitToolResultContentBlock, using the provided TextContentBlock

func (*SubmitToolResultContentBlock) UnmarshalJSON 

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

func (SubmitToolResultContentBlock) ValueByDiscriminator 

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

type TerminalSession 

type TerminalSession struct {
	CloseReason *string    `json:"close_reason,omitempty"`
	ClosedAt    *time.Time `json:"closed_at,omitempty"`
	Cols        *int32     `json:"cols,omitempty"`
	CreatedAt   time.Time  `json:"created_at"`
	Cwd         *string    `json:"cwd,omitempty"`
	ExitCode    *int32     `json:"exit_code,omitempty"`

	// ID Terminal session ID (tsn_...).
	ID TerminalSessionID `json:"id"`

	// MachineID Machine ID (mch_...).
	MachineID MachineID      `json:"machine_id"`
	OrgID     OrganizationID `json:"org_id"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID            `json:"project_id"`
	Rows      *int32               `json:"rows,omitempty"`
	Shell     *string              `json:"shell,omitempty"`
	State     TerminalSessionState `json:"state"`
}

TerminalSession defines model for TerminalSession.

type TerminalSessionID 

type TerminalSessionID = string

TerminalSessionID Terminal session ID (tsn_...).

type TerminalSessionState 

type TerminalSessionState string

TerminalSessionState defines model for TerminalSession.State. 

const (
	Closed   TerminalSessionState = "closed"
	Closing  TerminalSessionState = "closing"
	Failed   TerminalSessionState = "failed"
	Running  TerminalSessionState = "running"
	Starting TerminalSessionState = "starting"
)

Defines values for TerminalSessionState.

func (TerminalSessionState) Valid 

func (e TerminalSessionState) Valid() bool

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

type TextContentBlock 

type TextContentBlock struct {
	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata *ContentBlockMetadata `json:"metadata,omitempty"`
	Text     string                `json:"text"`
	Type     TextContentBlockType  `json:"type"`
}

TextContentBlock defines model for TextContentBlock.

func NewTextContentBlock 

func NewTextContentBlock(text string) TextContentBlock

NewTextContentBlock builds a text content block.

type TextContentBlockType 

type TextContentBlockType string

TextContentBlockType defines model for TextContentBlock.Type. 

const (
	Text TextContentBlockType = "text"
)

Defines values for TextContentBlockType.

func (TextContentBlockType) Valid 

func (e TextContentBlockType) Valid() bool

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

type Timestamp 

type Timestamp = time.Time

Timestamp defines model for Timestamp.

type ToolCall 

type ToolCall struct {
	AgentID     AgentID    `json:"agent_id"`
	CompletedAt *Timestamp `json:"completed_at,omitempty"`
	CreatedAt   Timestamp  `json:"created_at"`
	ID          ToolCallID `json:"id"`

	// Input Non-null JSON object containing the arguments emitted for a tool call.
	Input ToolInput `json:"input"`
	Name  string    `json:"name"`

	// Outcome Terminal outcome, present only when state is completed.
	Outcome        *ToolCallOutcome `json:"outcome,omitempty"`
	ProviderCallID string           `json:"provider_call_id"`

	// SessionID Agent session (ses_...) whose turn made the call.
	SessionID string `json:"session_id"`

	// State Current lifecycle state. awaiting_authorization has not evaluated its permission mode; awaiting_permission has an open authorization prompt; ready is authorized and eligible to run; running has an active worker; waiting has durable work that will complete the call independently; completed is terminal and includes outcome and completed_at. Custom calls remain ready until a consumer submits their result.
	State  ToolCallState `json:"state"`
	TurnID AgentTurnID   `json:"turn_id"`

	// Type Identifies who manages execution. Built-in and MCP calls are platform-managed; custom calls wait for an external consumer to submit their result.
	Type ToolCallType `json:"type"`
}

ToolCall A model-emitted tool call together with its current lifecycle state.

type ToolCallEnvelope 

type ToolCallEnvelope struct {
	// ToolCall A model-emitted tool call together with its current lifecycle state.
	ToolCall ToolCall `json:"tool_call"`
}

ToolCallEnvelope defines model for ToolCallEnvelope.

type ToolCallError 

type ToolCallError struct{ Content ToolContent }

ToolCallError is a tool-level failure reported to the model.

func (*ToolCallError) Error 

func (e *ToolCallError) Error() string

type ToolCallID 

type ToolCallID = string

ToolCallID defines model for ToolCallID.

type ToolCallOutcome 

type ToolCallOutcome string

ToolCallOutcome Terminal outcome, present only when state is completed. 

const (
	ToolCallOutcomeCanceled  ToolCallOutcome = "canceled"
	ToolCallOutcomeDenied    ToolCallOutcome = "denied"
	ToolCallOutcomeFailed    ToolCallOutcome = "failed"
	ToolCallOutcomeSucceeded ToolCallOutcome = "succeeded"
)

Defines values for ToolCallOutcome.

func (ToolCallOutcome) Valid 

func (e ToolCallOutcome) Valid() bool

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

type ToolCallState 

type ToolCallState string

ToolCallState Current lifecycle state. awaiting_authorization has not evaluated its permission mode; awaiting_permission has an open authorization prompt; ready is authorized and eligible to run; running has an active worker; waiting has durable work that will complete the call independently; completed is terminal and includes outcome and completed_at. Custom calls remain ready until a consumer submits their result. 

const (
	ToolCallStateAwaitingAuthorization ToolCallState = "awaiting_authorization"
	ToolCallStateAwaitingPermission    ToolCallState = "awaiting_permission"
	ToolCallStateCompleted             ToolCallState = "completed"
	ToolCallStateReady                 ToolCallState = "ready"
	ToolCallStateRunning               ToolCallState = "running"
	ToolCallStateWaiting               ToolCallState = "waiting"
)

Defines values for ToolCallState.

func (ToolCallState) Valid 

func (e ToolCallState) Valid() bool

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

type ToolCallType 

type ToolCallType string

ToolCallType Identifies who manages execution. Built-in and MCP calls are platform-managed; custom calls wait for an external consumer to submit their result. 

const (
	ToolCallTypeBuiltIn ToolCallType = "built_in"
	ToolCallTypeCustom  ToolCallType = "custom"
	ToolCallTypeMCP     ToolCallType = "mcp"
)

Defines values for ToolCallType.

func (ToolCallType) Valid 

func (e ToolCallType) Valid() bool

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

type ToolCallUpdate 

type ToolCallUpdate struct {
	AgentID           *AgentID                `json:"agent_id,omitempty"`
	InteractionUpdate *AgentInteractionUpdate `json:"interaction_update,omitempty"`

	// State Current lifecycle state. awaiting_authorization has not evaluated its permission mode; awaiting_permission has an open authorization prompt; ready is authorized and eligible to run; running has an active worker; waiting has durable work that will complete the call independently; completed is terminal and includes outcome and completed_at. Custom calls remain ready until a consumer submits their result.
	State      ToolCallState `json:"state"`
	ToolCallID ToolCallID    `json:"tool_call_id"`
}

ToolCallUpdate A notification that a tool call entered a lifecycle state. On the event stream, this is ephemeral and sent for the streamed agent and every subagent beneath it, so questions, permission requests, and custom tool calls anywhere in the tree surface here; query the list endpoints with `include_subagents` for the current rows.

type ToolCatalog 

type ToolCatalog struct {
	BuiltInTools          []ToolCatalogEntry    `json:"built_in_tools"`
	CustomToolPermissions ToolPermissionProfile `json:"custom_tool_permissions"`
	McpToolPermissions    ToolPermissionProfile `json:"mcp_tool_permissions"`
}

ToolCatalog defines model for ToolCatalog.

type ToolCatalogEntry 

type ToolCatalogEntry struct {
	DefaultPermission ToolPermissionSelection `json:"default_permission"`
	Description       string                  `json:"description"`

	// Implicit Whether this tool supports implicit inclusion based on config resources or integration context, even when explicitly configured.
	Implicit        *bool                `json:"implicit,omitempty"`
	Name            string               `json:"name"`
	PermissionModes []ToolPermissionMode `json:"permission_modes"`
}

ToolCatalogEntry defines model for ToolCatalogEntry.

type ToolCatalogService 

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

ToolCatalogService groups the toolCatalog methods.

func (*ToolCatalogService) Get 

func (s *ToolCatalogService) Get(ctx context.Context, opts ...option.RequestOption) (*ToolCatalog, error)

Get calls getToolCatalog: GET /tool-catalog.

type ToolContent 

type ToolContent []SubmitToolResultContentBlock

ToolContent is what a tool returns to the model.

func ToolText 

func ToolText(text string) ToolContent

ToolText is a ToolContent of one text block.

type ToolInput 

type ToolInput map[string]interface{}

ToolInput Non-null JSON object containing the arguments emitted for a tool call.

type ToolPermissionMode 

type ToolPermissionMode struct {
	Description      string                 `json:"description"`
	Label            string                 `json:"label"`
	Name             string                 `json:"name"`
	ParametersSchema map[string]interface{} `json:"parameters_schema"`
}

ToolPermissionMode defines model for ToolPermissionMode.

type ToolPermissionProfile 

type ToolPermissionProfile struct {
	DefaultPermission ToolPermissionSelection `json:"default_permission"`
	PermissionModes   []ToolPermissionMode    `json:"permission_modes"`
}

ToolPermissionProfile defines model for ToolPermissionProfile.

type ToolPermissionSelection 

type ToolPermissionSelection struct {
	Mode       string                 `json:"mode"`
	Parameters map[string]interface{} `json:"parameters"`
}

ToolPermissionSelection defines model for ToolPermissionSelection.

type ToolResult 

type ToolResult struct {
	AgentID       AgentID                  `json:"agent_id"`
	ContentBlocks []ToolResultContentBlock `json:"content_blocks"`
	CreatedAt     Timestamp                `json:"created_at"`
	EventID       AgentEventID             `json:"event_id"`

	// Outcome Terminal outcome, present only when state is completed.
	Outcome    ToolCallOutcome `json:"outcome"`
	ToolCallID ToolCallID      `json:"tool_call_id"`
}

ToolResult defines model for ToolResult.

type ToolResultContentBlock 

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

ToolResultContentBlock defines model for ToolResultContentBlock.

func (ToolResultContentBlock) AsAny 

func (t ToolResultContentBlock) AsAny() any

AsAny returns the member of ToolResultContentBlock named by its discriminator, or nil for a value this SDK does not know; switch on its type.

func (ToolResultContentBlock) AsMediaRefContentBlock 

func (t ToolResultContentBlock) AsMediaRefContentBlock() (MediaRefContentBlock, error)

AsMediaRefContentBlock returns the union data inside the ToolResultContentBlock as a MediaRefContentBlock

func (ToolResultContentBlock) AsStructuredDataContentBlock 

func (t ToolResultContentBlock) AsStructuredDataContentBlock() (StructuredDataContentBlock, error)

AsStructuredDataContentBlock returns the union data inside the ToolResultContentBlock as a StructuredDataContentBlock

func (ToolResultContentBlock) AsTextContentBlock 

func (t ToolResultContentBlock) AsTextContentBlock() (TextContentBlock, error)

AsTextContentBlock returns the union data inside the ToolResultContentBlock as a TextContentBlock

func (ToolResultContentBlock) Discriminator 

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

func (*ToolResultContentBlock) FromMediaRefContentBlock 

func (t *ToolResultContentBlock) FromMediaRefContentBlock(v MediaRefContentBlock) error

FromMediaRefContentBlock overwrites any union data inside the ToolResultContentBlock as the provided MediaRefContentBlock

func (*ToolResultContentBlock) FromStructuredDataContentBlock 

func (t *ToolResultContentBlock) FromStructuredDataContentBlock(v StructuredDataContentBlock) error

FromStructuredDataContentBlock overwrites any union data inside the ToolResultContentBlock as the provided StructuredDataContentBlock

func (*ToolResultContentBlock) FromTextContentBlock 

func (t *ToolResultContentBlock) FromTextContentBlock(v TextContentBlock) error

FromTextContentBlock overwrites any union data inside the ToolResultContentBlock as the provided TextContentBlock

func (ToolResultContentBlock) MarshalJSON 

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

func (*ToolResultContentBlock) MergeMediaRefContentBlock 

func (t *ToolResultContentBlock) MergeMediaRefContentBlock(v MediaRefContentBlock) error

MergeMediaRefContentBlock performs a merge with any union data inside the ToolResultContentBlock, using the provided MediaRefContentBlock

func (*ToolResultContentBlock) MergeStructuredDataContentBlock 

func (t *ToolResultContentBlock) MergeStructuredDataContentBlock(v StructuredDataContentBlock) error

MergeStructuredDataContentBlock performs a merge with any union data inside the ToolResultContentBlock, using the provided StructuredDataContentBlock

func (*ToolResultContentBlock) MergeTextContentBlock 

func (t *ToolResultContentBlock) MergeTextContentBlock(v TextContentBlock) error

MergeTextContentBlock performs a merge with any union data inside the ToolResultContentBlock, using the provided TextContentBlock

func (*ToolResultContentBlock) UnmarshalJSON 

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

func (ToolResultContentBlock) ValueByDiscriminator 

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

type ToolResultEvent 

type ToolResultEvent struct {
	AgentID        AgentID                       `json:"agent_id"`
	ContentBlocks  []ToolResultContentBlock      `json:"content_blocks"`
	CreatedAt      Timestamp                     `json:"created_at"`
	EventKind      ToolResultEventEventKind      `json:"event_kind"`
	ID             AgentEventID                  `json:"id"`
	IsOpeningEvent ToolResultEventIsOpeningEvent `json:"is_opening_event"`
	OrgID          OrganizationID                `json:"org_id"`

	// Outcome Terminal outcome, present only when state is completed.
	Outcome ToolCallOutcome `json:"outcome"`

	// ProjectID Project ID (proj_...).
	ProjectID ProjectID `json:"project_id"`

	// Sequence Positive per-agent event, turn, or live-frame sequence.
	Sequence   AgentSequence `json:"sequence"`
	ToolCallID ToolCallID    `json:"tool_call_id"`
	TurnID     AgentTurnID   `json:"turn_id"`

	// TurnSequence Positive per-agent event, turn, or live-frame sequence.
	TurnSequence AgentSequence `json:"turn_sequence"`
}

ToolResultEvent defines model for ToolResultEvent.

type ToolResultEventEventKind 

type ToolResultEventEventKind string

ToolResultEventEventKind defines model for ToolResultEvent.EventKind. 

const (
	ToolResultEventEventKindToolResult ToolResultEventEventKind = "tool_result"
)

Defines values for ToolResultEventEventKind.

func (ToolResultEventEventKind) Valid 

func (e ToolResultEventEventKind) Valid() bool

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

type ToolResultEventIsOpeningEvent 

type ToolResultEventIsOpeningEvent bool

ToolResultEventIsOpeningEvent defines model for ToolResultEvent.IsOpeningEvent. 

const (
	ToolResultEventIsOpeningEventFalse ToolResultEventIsOpeningEvent = false
)

Defines values for ToolResultEventIsOpeningEvent.

func (ToolResultEventIsOpeningEvent) Valid 

func (e ToolResultEventIsOpeningEvent) Valid() bool

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

type ToolRunner 

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

ToolRunner answers custom tool calls of one agent.

func (*ToolRunner) Run 

func (r *ToolRunner) Run(ctx context.Context) error

Run handles every ready custom call (of the agent and its subagents) whose name matches a tool: it decodes the input, runs the tool and submits the result. Ready calls are listed on every (re)connection of the event stream, so calls that became ready while disconnected are not lost. A 409 on submit (another consumer answered the call first) counts as handled. Run returns nil when ctx is canceled, else the error that stopped it (the reconnect budget spent, a terminal stream error); it never returns because the stream ended. It waits for running tools before returning.

type ToolRunnerParams 

type ToolRunnerParams struct {
	// SessionID limits the agent's own calls to one session; calls of
	// subagents are always handled.
	SessionID string
	Tools     []RunnableTool
	// MaxReconnects bounds event stream reconnects in a row that receive no
	// data before Run fails; 0 (the default) is unlimited, with backoff up
	// to 8s, so a runner rides out deployments. Independent of
	// option.WithMaxRetries, which bounds each request.
	MaxReconnects int
}

ToolRunnerParams selects the calls a runner handles.

type Unauthorized 

type Unauthorized = ErrorBody

Unauthorized defines model for Unauthorized.

type UnprocessableEntity 

type UnprocessableEntity = ErrorBody

UnprocessableEntity defines model for UnprocessableEntity.

type UpdateAgentConfigJSONRequestBody 

type UpdateAgentConfigJSONRequestBody = UpdateAgentConfigRequest

UpdateAgentConfigJSONRequestBody defines body for UpdateAgentConfig for application/json ContentType.

type UpdateAgentConfigParams 

type UpdateAgentConfigParams struct {
	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

UpdateAgentConfigParams defines parameters for UpdateAgentConfig.

type UpdateAgentConfigRequest 

type UpdateAgentConfigRequest struct {
	// ExpectedCurrentConfigID Agent config ID (acfg_...).
	ExpectedCurrentConfigID *AgentConfigID `json:"expected_current_config_id,omitempty"`

	// Source Agent config source as YAML or JSON text, or, with source_format json, as a JSON object.
	Source AgentConfigSourceInput `json:"source"`

	// SourceFormat Format of source: yaml or json.
	SourceFormat UpdateAgentConfigRequestSourceFormat `json:"source_format"`
}

UpdateAgentConfigRequest Replaces a live agent's config. expected_current_config_id makes the change conditional on the agent still running that config, so concurrent editors get a conflict instead of silently overwriting each other.

type UpdateAgentConfigRequestSourceFormat 

type UpdateAgentConfigRequestSourceFormat string

UpdateAgentConfigRequestSourceFormat Format of source: yaml or json. 

const (
	UpdateAgentConfigRequestSourceFormatJSON UpdateAgentConfigRequestSourceFormat = "json"
	UpdateAgentConfigRequestSourceFormatYaml UpdateAgentConfigRequestSourceFormat = "yaml"
)

Defines values for UpdateAgentConfigRequestSourceFormat.

func (UpdateAgentConfigRequestSourceFormat) Valid 

func (e UpdateAgentConfigRequestSourceFormat) Valid() bool

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

type UpdateAgentConfigResponse 

type UpdateAgentConfigResponse struct {
	AgentConfig AgentConfig  `json:"agent_config"`
	AgentInput  AgentInput   `json:"agent_input"`
	EventID     AgentEventID `json:"event_id"`
}

UpdateAgentConfigResponse defines model for UpdateAgentConfigResponse.

type UpdateAgentProfileJSONRequestBody 

type UpdateAgentProfileJSONRequestBody = UpdateAgentProfileRequest

UpdateAgentProfileJSONRequestBody defines body for UpdateAgentProfile for application/json ContentType.

type UpdateAgentProfileParams 

type UpdateAgentProfileParams struct {
	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`
}

UpdateAgentProfileParams defines parameters for UpdateAgentProfile.

type UpdateAgentProfileRequest 

type UpdateAgentProfileRequest struct {
	// Config Agent config ID (acfg_...).
	Config AgentConfigID `json:"config"`

	// ExpectedCurrentConfigID Agent config ID (acfg_...).
	ExpectedCurrentConfigID AgentConfigID `json:"expected_current_config_id"`
}

UpdateAgentProfileRequest defines model for UpdateAgentProfileRequest.

type UpdateAgentSessionJSONRequestBody 

type UpdateAgentSessionJSONRequestBody = UpdateAgentSessionRequest

UpdateAgentSessionJSONRequestBody defines body for UpdateAgentSession for application/json ContentType.

type UpdateAgentSessionRequest 

type UpdateAgentSessionRequest struct {
	AgentConfigID *string             `json:"agent_config_id,omitempty"`
	EnvironmentID *openapi_types.UUID `json:"environment_id,omitempty"`

	// ExpectedUpdatedAt Optimistic version check. The update applies only while the session's updated_at still equals this value; otherwise it answers 409 conflict. Anything that writes the session (an update, the automatic title) moves updated_at.
	ExpectedUpdatedAt *time.Time              `json:"expected_updated_at,omitempty"`
	Metadata          *map[string]interface{} `json:"metadata,omitempty"`
}

UpdateAgentSessionRequest defines model for UpdateAgentSessionRequest.

type UpdateConfiguredModelJSONRequestBody 

type UpdateConfiguredModelJSONRequestBody = UpdateConfiguredModelRequest

UpdateConfiguredModelJSONRequestBody defines body for UpdateConfiguredModel for application/json ContentType.

type UpdateConfiguredModelRequest 

type UpdateConfiguredModelRequest struct {
	// APIVariantOptions Extra top-level JSON fields to include in provider requests for this configured model. Use this for provider-specific settings that BMA does not expose as typed fields, such as OpenRouter `provider` routing or sampling parameters. BMA still controls the fields it needs to run the agent correctly, including the model, prompt/messages, streaming, tools, output-token limit, and selected reasoning policy. Provider passthrough values for those fields are ignored. For OpenRouter routing options, see https://openrouter.ai/docs/guides/routing/provider-selection and general request parameters at https://openrouter.ai/docs/api/reference/parameters. BMA-managed OpenRouter providers accept only sampling, reasoning, and per-model routing options here.
	APIVariantOptions *ModelAPIVariantOptions `json:"api_variant_options,omitempty"`

	// ContextWindowTokens Context budget for input and output tokens. Triggers compaction when estimated input exceeds the remaining budget after output and safety reserves. The turn fails if compaction cannot make it fit.
	ContextWindowTokens *int `json:"context_window_tokens,omitempty"`

	// DefaultCacheRetention Prompt-cache preference for model requests; `short` when omitted. `short` applies the route's default caching (explicit cache breakpoints where the provider requires them) and, where the route accepts one, a stable conversation key for cache-aware routing. `long` prefers the route's extended cache lifetime where one exists (currently Anthropic's one-hour cache, which on Bedrock requires Claude 4.5 or newer) and behaves like `short` elsewhere. `none` sends no BMA-managed cache controls or conversation key; providers may still cache prefixes on their own.
	DefaultCacheRetention *ModelCacheRetention `json:"default_cache_retention,omitempty"`

	// DefaultMaxOutputTokens Optional per-request output allowance unless a project or agent overrides it. Without a default or known ceiling, Messages uses 64000 tokens; other formats omit the allowance.
	DefaultMaxOutputTokens *int `json:"default_max_output_tokens,omitempty"`

	// DefaultReasoningEffort Default reasoning effort to send for models/API formats that support effort-style reasoning controls. Requires supports_reasoning=true. When supported_reasoning_efforts is present, this value must be listed there.
	DefaultReasoningEffort *string `json:"default_reasoning_effort,omitempty"`

	// InputModalities Input types this configured model accepts. BMA recognizes text, image, and file; an empty list leaves capabilities unspecified.
	InputModalities *[]string `json:"input_modalities,omitempty"`

	// MaxOutputTokens Known output-token ceiling for this model. Omitted keeps the current value. Null clears it to unknown for every API format.
	MaxOutputTokens *int `json:"max_output_tokens,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name *ResourceName `json:"name,omitempty"`

	// OutputModalities Output types this configured model can return. BMA currently consumes text output.
	OutputModalities *[]string `json:"output_modalities,omitempty"`

	// ProviderModelSlug Exact provider model slug sent to the provider endpoint. Free-pool, `:online`, and preset model ids are not accepted on BMA-managed OpenRouter providers.
	ProviderModelSlug *string `json:"provider_model_slug,omitempty"`

	// SupportedReasoningEfforts Reasoning effort values this configured model accepts. Requires supports_reasoning=true when non-empty.
	SupportedReasoningEfforts *[]string `json:"supported_reasoning_efforts,omitempty"`

	// SupportsReasoning Whether BMA should use this model's reasoning features. For OpenAI Responses, this also enables encrypted reasoning replay for stateless calls. Omitted keeps the current value.
	SupportsReasoning *bool `json:"supports_reasoning,omitempty"`

	// SupportsTools Whether this configured model can receive tool definitions and emit tool calls. Agent configs with enabled tools are rejected when this is false. Omitted keeps the current value.
	SupportsTools *bool `json:"supports_tools,omitempty"`
}

UpdateConfiguredModelRequest Update a configured model. Omitted fields keep their current values. Runtime changes create a new immutable model revision; changing only name just renames the model.

type UpdateCronTriggerJSONRequestBody 

type UpdateCronTriggerJSONRequestBody = UpdateCronTriggerRequest

UpdateCronTriggerJSONRequestBody defines body for UpdateCronTrigger for application/json ContentType.

type UpdateCronTriggerRequest 

type UpdateCronTriggerRequest struct {
	// Cron Standard five-field cron expression (minute, hour, day of month, month, day of week). `TZ=`/`CRON_TZ=` prefixes are rejected; set the `timezone` field instead.
	Cron *CronExpression `json:"cron,omitempty"`

	// Enabled Whether the trigger fires on schedule; false pauses it.
	Enabled *bool `json:"enabled,omitempty"`

	// MessageTemplate Go text/template rendered on each firing to produce the message sent to the target. The template receives a `trigger` value with `name`, `fired_at`, `last_fired_at`, and `local_date` fields. Timestamps remain UTC; local_date is the scheduled occurrence's ISO date in the schedule timezone. Required for agent and profile targets; omitted for integration targets, which use their own settings. Rendering is capped at 64 KiB of output and one second of wall-clock time, and `printf` width and precision specifiers are capped at 1024; a firing whose template fails to render is recorded in `failure_report` without sending a message.
	MessageTemplate *CronMessageTemplate `json:"message_template,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name *ResourceName `json:"name,omitempty"`

	// Target What each firing does: type agent sends the message to an existing agent, type profile launches a new agent from a profile, and type integration hands the firing to an integration, such as a new Slack or Discord thread.
	Target *CronTriggerTarget `json:"target,omitempty"`

	// Timezone IANA time zone the schedule is evaluated in.
	Timezone *CronTimezone `json:"timezone,omitempty"`
}

UpdateCronTriggerRequest defines model for UpdateCronTriggerRequest.

type UpdateEventWebhookJSONRequestBody 

type UpdateEventWebhookJSONRequestBody = UpdateEventWebhookRequest

UpdateEventWebhookJSONRequestBody defines body for UpdateEventWebhook for application/json ContentType.

type UpdateEventWebhookRequest 

type UpdateEventWebhookRequest struct {
	EventTypes *[]EventWebhookEventType `json:"event_types,omitempty"`

	// SigningSecretID Project-available generic secret. Omit to preserve signing, or set to null to remove it.
	SigningSecretID *SecretID `json:"signing_secret_id,omitempty"`

	// URL Public HTTPS endpoint, at most 2048 bytes after URL encoding.
	URL *string `json:"url,omitempty"`
}

UpdateEventWebhookRequest defines model for UpdateEventWebhookRequest.

type UpdateIntegrationJSONRequestBody 

type UpdateIntegrationJSONRequestBody = UpdateIntegrationRequest

UpdateIntegrationJSONRequestBody defines body for UpdateIntegration for application/json ContentType.

type UpdateIntegrationRequest 

type UpdateIntegrationRequest struct {
	// Settings Integration-owned settings JSON. Validate against capabilities.settings.input_schema from the integration catalog. Public profile references use aprf_ IDs and resolve at runtime. GitHub integrations use GitHubIntegrationSettings; Slack and Discord integrations use ChatIntegrationSettings.
	Settings IntegrationSettings `json:"settings"`
}

UpdateIntegrationRequest Replaces integration settings. Name and integration_kind are immutable and only accepted on create. Preserve integration-level fields when editing launcher settings.

type UpdateMachineJSONRequestBody 

type UpdateMachineJSONRequestBody = UpdateMachineRequest

UpdateMachineJSONRequestBody defines body for UpdateMachine for application/json ContentType.

type UpdateMachinePoolJSONRequestBody 

type UpdateMachinePoolJSONRequestBody = UpdateMachinePoolRequest

UpdateMachinePoolJSONRequestBody defines body for UpdateMachinePool for application/json ContentType.

type UpdateMachinePoolRequest 

type UpdateMachinePoolRequest struct {
	// ArchiveAfterPausedDays Days a machine stays paused before it is archived. Null clears it; omitted leaves it unchanged. Requires pause_after_idle_minutes.
	ArchiveAfterPausedDays *int32 `json:"archive_after_paused_days,omitempty"`

	// DefaultCwd Default working directory for processes on machines created from the pool after this change.
	DefaultCwd *string `json:"default_cwd,omitempty"`

	// DefaultMachineCPU Default CPU count for new machines in the pool.
	DefaultMachineCPU *int32 `json:"default_machine_cpu,omitempty"`

	// DefaultMachineEnv Default environment for pool machines. A machine's environment, including resolved secret_env values, is applied to the provider machine at provisioning, so the provider_options startup_script and the daemon run with it, and is resolved again for each process at launch.
	DefaultMachineEnv *map[string]string `json:"default_machine_env,omitempty"`

	// DefaultMachineMemoryMb Default memory in MB for new machines in the pool.
	DefaultMachineMemoryMb *int32 `json:"default_machine_memory_mb,omitempty"`

	// DefaultMachineProviderOptions Provider-specific options applied to new machines in the pool.
	DefaultMachineProviderOptions *map[string]interface{} `json:"default_machine_provider_options,omitempty"`

	// DefaultMachineSecretEnv Default secret environment for pool machines, mapping env names to generic secret references. References are resolved to secret values wherever the machine environment is applied.
	DefaultMachineSecretEnv *map[string]SecretID `json:"default_machine_secret_env,omitempty"`

	// DeleteAfterIdleMinutes Idle minutes before deleting a machine from this pool. Null clears the pool default; omitted leaves it unchanged.
	DeleteAfterIdleMinutes *int32 `json:"delete_after_idle_minutes,omitempty"`

	// DeleteAfterPausedDays Days a machine stays paused before it is deleted, counted from when it paused. Null clears it; omitted leaves it unchanged. Requires pause_after_idle_minutes; cannot be combined with archive_after_paused_days.
	DeleteAfterPausedDays *int32 `json:"delete_after_paused_days,omitempty"`

	// Description Optional description of the pool.
	Description *string `json:"description,omitempty"`

	// MaxMachineCPU Largest CPU count a single machine in the pool can use.
	MaxMachineCPU *int32 `json:"max_machine_cpu,omitempty"`

	// MaxMachineMemoryMb Largest memory in MB a single machine in the pool can use.
	MaxMachineMemoryMb *int32 `json:"max_machine_memory_mb,omitempty"`

	// MaxTotalCPU Deprecated, not enforced: organization and project in-use machine CPU quotas govern capacity.
	MaxTotalCPU *int32 `json:"max_total_cpu,omitempty"`

	// MaxTotalMachines Deprecated, not enforced: how many machines a pool has no longer blocks new machines. Organization and project quotas over in-use machines (org resource limits max_in_use_pool_machines_per_project and max_in_use_pool_machines_per_org) govern capacity.
	MaxTotalMachines *int32 `json:"max_total_machines,omitempty"`

	// MaxTotalMemoryMb Deprecated, not enforced: organization and project in-use machine memory quotas govern capacity.
	MaxTotalMemoryMb *int32 `json:"max_total_memory_mb,omitempty"`

	// Metadata User-supplied metadata stored on a machine, provided directly or copied from the machine pool that provisions it. A restriction of Metadata that leaves room for one reserved pair - BMA sets observed_platform on the machine to the platform reported by its daemon, so the key is reserved and at most 15 user pairs are accepted.
	Metadata *MachineMetadata `json:"metadata,omitempty"`

	// MinMachineCPU Smallest CPU count a single machine in the pool can use.
	MinMachineCPU *int32 `json:"min_machine_cpu,omitempty"`

	// MinMachineMemoryMb Smallest memory in MB a single machine in the pool can use.
	MinMachineMemoryMb *int32 `json:"min_machine_memory_mb,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name *ResourceName `json:"name,omitempty"`

	// PauseAfterIdleMinutes Idle minutes before pausing a machine from this pool. Null clears it; omitted leaves it unchanged. Exclusive with delete_after_idle_minutes.
	PauseAfterIdleMinutes *int32 `json:"pause_after_idle_minutes,omitempty"`

	// ProviderAuthSecretID Secret ID (sec_...).
	ProviderAuthSecretID *SecretID `json:"provider_auth_secret_id,omitempty"`

	// ProviderConfig Provider-specific settings for the pool.
	ProviderConfig *map[string]interface{} `json:"provider_config,omitempty"`

	// RuntimeProtectionEnabled Whether BMA should delete a pool machine when its provider remains running after its daemon becomes inactive.
	RuntimeProtectionEnabled *bool `json:"runtime_protection_enabled,omitempty"`
}

UpdateMachinePoolRequest defines model for UpdateMachinePoolRequest.

type UpdateMachineRequest 

type UpdateMachineRequest struct {
	// Cwd Default working directory for processes started on the machine.
	Cwd *string `json:"cwd,omitempty"`

	// Env Environment variables set for processes started on the machine.
	Env *map[string]string `json:"env,omitempty"`

	// SecretEnv Environment variable names mapped to secret IDs (sec_...) whose values are set for processes started on the machine.
	SecretEnv *map[string]SecretID `json:"secret_env,omitempty"`
}

UpdateMachineRequest defines model for UpdateMachineRequest.

type UpdateMemoryStore 

type UpdateMemoryStore struct {
	AgentAccess *MemoryStoreAccess `json:"agent_access,omitempty"`
	Description *string            `json:"description,omitempty"`
}

UpdateMemoryStore defines model for UpdateMemoryStore.

type UpdateMemoryStoreJSONRequestBody 

type UpdateMemoryStoreJSONRequestBody = UpdateMemoryStore

UpdateMemoryStoreJSONRequestBody defines body for UpdateMemoryStore for application/json ContentType.

type UpdateModelProviderConfigJSONRequestBody 

type UpdateModelProviderConfigJSONRequestBody = UpdateModelProviderConfigRequest

UpdateModelProviderConfigJSONRequestBody defines body for UpdateModelProviderConfig for application/json ContentType.

type UpdateModelProviderConfigRequest 

type UpdateModelProviderConfigRequest struct {
	// AuthKind How the credential is sent: bearer_token, api_key_header, or sigv4 (AWS).
	AuthKind *ModelProviderAuthKind `json:"auth_kind,omitempty"`

	// AuthOptions Non-secret authentication settings. Use an empty object with bearer_token. With api_key_header, set {"header_name":"..."}. With sigv4, set the AWS signing service and region.
	AuthOptions *struct {
		HeaderName *string `json:"header_name,omitempty"`
		Region     *string `json:"region,omitempty"`
		Service    *string `json:"service,omitempty"`
	} `json:"auth_options,omitempty"`

	// BaseURL Provider endpoint base URL. Normal API mode requires a public HTTPS endpoint; localhost and loopback endpoints are accepted only when the API is running in insecure dev mode.
	BaseURL *string `json:"base_url,omitempty"`

	// CredentialSecretID Secret ID (sec_...).
	CredentialSecretID *SecretID `json:"credential_secret_id,omitempty"`

	// EndpointPath URL path under base_url. This changes where requests are sent, not which API format BMA speaks.
	EndpointPath *string `json:"endpoint_path,omitempty"`

	// Headers Extra HTTP headers sent with every request to this provider. Values are stored and returned as plain text; use secret_headers for keys and tokens. Replaces all headers when provided.
	Headers *map[string]string `json:"headers,omitempty"`

	// IdleTimeoutMs Maximum wait for response headers or the next response bytes, in milliseconds. Heartbeats count as activity. Local response processing does not consume this idle budget.
	IdleTimeoutMs *int `json:"idle_timeout_ms,omitempty"`

	// RequestTimeoutMs Total deadline for one provider attempt, including reasoning and response streaming, in milliseconds. Retries have separate deadlines.
	RequestTimeoutMs *int `json:"request_timeout_ms,omitempty"`

	// SecretHeaders Extra HTTP headers whose values come from org-owned generic secrets, mapping header names to secret references. Replaces all secret headers when provided.
	SecretHeaders *map[string]SecretID `json:"secret_headers,omitempty"`
}

UpdateModelProviderConfigRequest Update a provider config. Omitted fields keep their current values.

type UpdateOrgAPIKeyJSONRequestBody 

type UpdateOrgAPIKeyJSONRequestBody = UpdateOrgAPIKeyRequest

UpdateOrgAPIKeyJSONRequestBody defines body for UpdateOrgAPIKey for application/json ContentType.

type UpdateOrgAPIKeyRequest 

type UpdateOrgAPIKeyRequest struct {
	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name *ResourceName `json:"name,omitempty"`

	// OrgRole The key's org role. Org API keys can never hold the owner role.
	OrgRole *OrgAPIKeyRole `json:"org_role,omitempty"`
}

UpdateOrgAPIKeyRequest defines model for UpdateOrgAPIKeyRequest.

type UpdateOrgMemberJSONRequestBody 

type UpdateOrgMemberJSONRequestBody = UpdateOrgMemberRequest

UpdateOrgMemberJSONRequestBody defines body for UpdateOrgMember for application/json ContentType.

type UpdateOrgMemberRequest 

type UpdateOrgMemberRequest struct {
	// Role The member's new org role (admin or member).
	Role string `json:"role"`
}

UpdateOrgMemberRequest defines model for UpdateOrgMemberRequest.

type UpdateProjectMachinePoolGrantJSONRequestBody 

type UpdateProjectMachinePoolGrantJSONRequestBody = UpdateProjectMachinePoolGrantRequest

UpdateProjectMachinePoolGrantJSONRequestBody defines body for UpdateProjectMachinePoolGrant for application/json ContentType.

type UpdateProjectMachinePoolGrantRequest 

type UpdateProjectMachinePoolGrantRequest struct {
	// DefaultCwd Default working directory for processes on this project's machines created from the pool after this change.
	DefaultCwd *string `json:"default_cwd,omitempty"`

	// DefaultMachineCPU Default CPU count for machines this project creates from the pool, overriding the pool's default.
	DefaultMachineCPU *int32 `json:"default_machine_cpu,omitempty"`

	// DefaultMachineEnvOverlay Env overlay merged over the pool's default_machine_env for machines this project creates from the pool afterward; a null entry removes the key.
	DefaultMachineEnvOverlay *map[string]*string `json:"default_machine_env_overlay,omitempty"`

	// DefaultMachineMemoryMb Default memory in MB for machines this project creates from the pool, overriding the pool's default.
	DefaultMachineMemoryMb *int32 `json:"default_machine_memory_mb,omitempty"`

	// DefaultMachineProviderOptionsOverlay Provider-specific options layered over the pool's provider options for this project's machines.
	DefaultMachineProviderOptionsOverlay *map[string]interface{} `json:"default_machine_provider_options_overlay,omitempty"`

	// DefaultMachineSecretEnvOverlay Secret env overlay merged over the pool's default_machine_secret_env for machines this project creates from the pool afterward; a null entry removes the key.
	DefaultMachineSecretEnvOverlay *map[string]*string `json:"default_machine_secret_env_overlay,omitempty"`

	// DeleteAfterIdleMinutes Idle minutes before deleting a machine created through this grant. Use 0 to disable for this grant; null restores inheritance from the pool; omitted leaves it unchanged. Values from 1 through 4 are invalid.
	DeleteAfterIdleMinutes *int32 `json:"delete_after_idle_minutes,omitempty"`

	// Description Optional note about this grant.
	Description *string `json:"description,omitempty"`

	// MaxMachineCPU Largest CPU count one of this project's machines can request.
	MaxMachineCPU *int32 `json:"max_machine_cpu,omitempty"`

	// MaxMachineMemoryMb Largest memory in MB one of this project's machines can request.
	MaxMachineMemoryMb *int32 `json:"max_machine_memory_mb,omitempty"`

	// MaxTotalCPU Maximum total CPU across this project's live machines from the pool.
	MaxTotalCPU *int32 `json:"max_total_cpu,omitempty"`

	// MaxTotalMachines Maximum number of live machines this project can have from the pool.
	MaxTotalMachines *int32 `json:"max_total_machines,omitempty"`

	// MaxTotalMemoryMb Maximum total memory in MB across this project's live machines from the pool.
	MaxTotalMemoryMb *int32 `json:"max_total_memory_mb,omitempty"`

	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata *Metadata `json:"metadata,omitempty"`

	// MinMachineCPU Smallest CPU count one of this project's machines can request.
	MinMachineCPU *int32 `json:"min_machine_cpu,omitempty"`

	// MinMachineMemoryMb Smallest memory in MB one of this project's machines can request.
	MinMachineMemoryMb *int32 `json:"min_machine_memory_mb,omitempty"`
}

UpdateProjectMachinePoolGrantRequest Update a project machine pool grant. Omitted fields keep their current values. Null clears an override so the grant follows the machine pool again. Overlay objects and metadata are replaced whole when present; send an empty object to clear them.

type UpdateProjectModelGrantJSONRequestBody 

type UpdateProjectModelGrantJSONRequestBody = UpdateProjectModelGrantRequest

UpdateProjectModelGrantJSONRequestBody defines body for UpdateProjectModelGrant for application/json ContentType.

type UpdateProjectModelGrantRequest 

type UpdateProjectModelGrantRequest struct {
	// ContextWindowTokens Project context budget for input and output tokens. Cannot exceed the configured model's budget. Triggers compaction when estimated input exceeds the remaining budget after output and safety reserves. The turn fails if compaction cannot make it fit.
	ContextWindowTokens   *int                 `json:"context_window_tokens,omitempty"`
	DefaultCacheRetention *ModelCacheRetention `json:"default_cache_retention,omitempty"`

	// DefaultMaxOutputTokens Project default per-request output-token cap.
	DefaultMaxOutputTokens *int `json:"default_max_output_tokens,omitempty"`

	// DefaultReasoningEffort Project default reasoning effort.
	DefaultReasoningEffort *string `json:"default_reasoning_effort,omitempty"`

	// InputModalities Project subset of configured-model input types.
	InputModalities *[]string `json:"input_modalities,omitempty"`

	// MaxOutputTokens Project output-token ceiling. Cannot exceed the configured model's ceiling.
	MaxOutputTokens *int `json:"max_output_tokens,omitempty"`

	// OutputModalities Project subset of configured-model output types.
	OutputModalities *[]string `json:"output_modalities,omitempty"`

	// SupportedReasoningEfforts Project subset of configured-model reasoning efforts. If this excludes the inherited default_reasoning_effort, set default_reasoning_effort on the grant too.
	SupportedReasoningEfforts *[]string `json:"supported_reasoning_efforts,omitempty"`

	// SupportsReasoning Project-level reasoning gate. Can disable reasoning, but cannot enable reasoning when the configured model does not support it.
	SupportsReasoning *bool `json:"supports_reasoning,omitempty"`

	// SupportsTools Project-level tool-use gate. Can disable tools, but cannot enable tools when the configured model does not support them.
	SupportsTools *bool `json:"supports_tools,omitempty"`
}

UpdateProjectModelGrantRequest Update a project model grant's overrides. Omitted fields keep their current values. Null clears an override so the project inherits from the configured model; for arrays, an empty array clears the override.

type UpdateSecretJSONRequestBody 

type UpdateSecretJSONRequestBody = UpdateSecretRequest

UpdateSecretJSONRequestBody defines body for UpdateSecret for application/json ContentType.

type UpdateSecretRequest 

type UpdateSecretRequest struct {
	// Metadata Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 characters, values must be strings of up to 512 characters.
	Metadata *Metadata `json:"metadata,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name *ResourceName `json:"name,omitempty"`
}

UpdateSecretRequest defines model for UpdateSecretRequest.

type UpdateSkillMultipartRequestBody 

type UpdateSkillMultipartRequestBody = UpdateSkillRequest

UpdateSkillMultipartRequestBody defines body for UpdateSkill for multipart/form-data ContentType.

type UpdateSkillRequest 

type UpdateSkillRequest struct {
	Archive *openapi_types.File `json:"archive,omitempty"`

	// SkillMd Replacement SKILL.md content. Every other file in the current revision's archive is preserved unchanged.
	SkillMd *string `json:"skill_md,omitempty"`
	// contains filtered or unexported fields
}

UpdateSkillRequest defines model for UpdateSkillRequest.

func (UpdateSkillRequest) AsUpdateSkillRequest0 

func (t UpdateSkillRequest) AsUpdateSkillRequest0() (UpdateSkillRequest0, error)

AsUpdateSkillRequest0 returns the union data inside the UpdateSkillRequest as a UpdateSkillRequest0

func (UpdateSkillRequest) AsUpdateSkillRequest1 

func (t UpdateSkillRequest) AsUpdateSkillRequest1() (UpdateSkillRequest1, error)

AsUpdateSkillRequest1 returns the union data inside the UpdateSkillRequest as a UpdateSkillRequest1

func (*UpdateSkillRequest) FromUpdateSkillRequest0 

func (t *UpdateSkillRequest) FromUpdateSkillRequest0(v UpdateSkillRequest0) error

FromUpdateSkillRequest0 overwrites any union data inside the UpdateSkillRequest as the provided UpdateSkillRequest0

func (*UpdateSkillRequest) FromUpdateSkillRequest1 

func (t *UpdateSkillRequest) FromUpdateSkillRequest1(v UpdateSkillRequest1) error

FromUpdateSkillRequest1 overwrites any union data inside the UpdateSkillRequest as the provided UpdateSkillRequest1

func (UpdateSkillRequest) MarshalJSON 

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

func (*UpdateSkillRequest) MergeUpdateSkillRequest0 

func (t *UpdateSkillRequest) MergeUpdateSkillRequest0(v UpdateSkillRequest0) error

MergeUpdateSkillRequest0 performs a merge with any union data inside the UpdateSkillRequest, using the provided UpdateSkillRequest0

func (*UpdateSkillRequest) MergeUpdateSkillRequest1 

func (t *UpdateSkillRequest) MergeUpdateSkillRequest1(v UpdateSkillRequest1) error

MergeUpdateSkillRequest1 performs a merge with any union data inside the UpdateSkillRequest, using the provided UpdateSkillRequest1

func (*UpdateSkillRequest) UnmarshalJSON 

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

type UpdateSkillRequest0 

type UpdateSkillRequest0 struct {
	Archive openapi_types.File `json:"archive"`
}

UpdateSkillRequest0 defines model for .

type UpdateSkillRequest1 

type UpdateSkillRequest1 struct {
	SkillMd string `json:"skill_md"`
}

UpdateSkillRequest1 defines model for .

type UploadDaemonFileParams 

type UploadDaemonFileParams struct {
	// Filename Required for artifact uploads; ignored for memory uploads.
	Filename *string `form:"filename,omitempty" json:"filename,omitempty"`
}

UploadDaemonFileParams defines parameters for UploadDaemonFile.

type UploadDaemonMachineBackupArchiveParams 

type UploadDaemonMachineBackupArchiveParams struct {
	XBMABackupFingerprint *string `json:"X-BMA-Backup-Fingerprint,omitempty"`
}

UploadDaemonMachineBackupArchiveParams defines parameters for UploadDaemonMachineBackupArchive.

type UploadDaemonSessionOutputParams 

type UploadDaemonSessionOutputParams struct {
	// Path The file's path relative to /mnt/session/outputs.
	Path string `form:"path" json:"path"`

	// XBMAFileDigest SHA-256 digest of the body; a mismatch is 409 and stores nothing.
	XBMAFileDigest string `json:"X-BMA-File-Digest"`
}

UploadDaemonSessionOutputParams defines parameters for UploadDaemonSessionOutput.

type UploadFileParams 

type UploadFileParams struct {
	// Filename Bare file name (1-255 characters).
	Filename string `form:"filename" json:"filename"`

	// IdempotencyKey Idempotency key for replay-safe mutating requests.
	IdempotencyKey *IdempotencyKey `json:"Idempotency-Key,omitempty"`

	// XBMAFileMetadata JSON object of string labels to store with the file (at most 16; keys [A-Za-z0-9_.-]{1,64}, values up to 512 characters).
	XBMAFileMetadata *string `json:"X-BMA-File-Metadata,omitempty"`
}

UploadFileParams defines parameters for UploadFile.

type UploadFileResponse 

type UploadFileResponse struct {
	Digest string `json:"digest"`
	Path   string `json:"path"`
}

UploadFileResponse Returns the uploaded file's path and digest.

type UploadSessionArtifactParams 

type UploadSessionArtifactParams struct {
	// Filename Bare file name (1-255 characters).
	Filename string `form:"filename" json:"filename"`
}

UploadSessionArtifactParams defines parameters for UploadSessionArtifact.

type UsageCostTotals 

type UsageCostTotals struct {
	ModelCallsWithReportedCost int64 `json:"model_calls_with_reported_cost"`

	// ProviderReportedUsd Exact decimal sum in USD of the costs the provider reported for the tallied model calls. Calls whose provider reported no cost contribute nothing; compare model_calls_with_reported_cost against model_calls to see how complete the figure is.
	ProviderReportedUsd string `json:"provider_reported_usd"`
}

UsageCostTotals defines model for UsageCostTotals.

type UsageExcludeProjectIDs 

type UsageExcludeProjectIDs = []ProjectID

UsageExcludeProjectIDs defines model for UsageExcludeProjectIDs.

type UsageIncludeProjectIDs 

type UsageIncludeProjectIDs = []ProjectID

UsageIncludeProjectIDs defines model for UsageIncludeProjectIDs.

type UsageModel 

type UsageModel struct {
	ConfiguredModelID     ConfiguredModelID     `json:"configured_model_id"`
	ModelProviderConfigID ModelProviderConfigID `json:"model_provider_config_id"`

	// ModelProviderConfigName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	ModelProviderConfigName ResourceName `json:"model_provider_config_name"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name              ResourceName `json:"name"`
	ProviderModelSlug string       `json:"provider_model_slug"`
}

UsageModel defines model for UsageModel.

type UsageReport 

type UsageReport struct {
	// ByModel Per-model rows ordered by provider config name, configured model name, provider model slug, then purpose. Models with distinct provider slugs across revisions appear once per slug, and once per purpose.
	ByModel []ModelUsageTotals `json:"by_model"`
	Totals  UsageTotals        `json:"totals"`
}

UsageReport defines model for UsageReport.

type UsageSince 

type UsageSince = time.Time

UsageSince defines model for UsageSince.

type UsageTimeseries 

type UsageTimeseries struct {
	// ActiveAgents Agents, not counting subagents, that made at least one model call in the window.
	ActiveAgents int64 `json:"active_agents"`

	// BucketStarts Start of each bucket in `timezone`, oldest first, including buckets without usage. The first bucket starts at the beginning of the interval containing `since`, but only usage at or after `since` counts.
	BucketStarts []Timestamp             `json:"bucket_starts"`
	GroupBy      *UsageTimeseriesGroupBy `json:"group_by,omitempty"`
	Interval     UsageTimeseriesInterval `json:"interval"`

	// Metric `sum_tokens` is input plus output tokens. `sum_cost` is provider-reported cost in USD. `count_model_calls` counts model calls that recorded usage.
	Metric UsageTimeseriesMetric `json:"metric"`

	// Series Without `group_by`, a single `all` series. With it, one series per ranked group, most first, then an `other` series when usage remains.
	Series []UsageTimeseriesSeries `json:"series"`

	// Timezone IANA time zone the buckets follow.
	Timezone string      `json:"timezone"`
	Totals   UsageTotals `json:"totals"`
	Until    Timestamp   `json:"until"`
}

UsageTimeseries defines model for UsageTimeseries.

type UsageTimeseriesGroupBy 

type UsageTimeseriesGroupBy string

UsageTimeseriesGroupBy defines model for UsageTimeseriesGroupBy. 

const (
	UsageTimeseriesGroupByModel   UsageTimeseriesGroupBy = "model"
	UsageTimeseriesGroupByProfile UsageTimeseriesGroupBy = "profile"
)

Defines values for UsageTimeseriesGroupBy.

func (UsageTimeseriesGroupBy) Valid 

func (e UsageTimeseriesGroupBy) Valid() bool

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

type UsageTimeseriesInterval 

type UsageTimeseriesInterval string

UsageTimeseriesInterval defines model for UsageTimeseriesInterval. 

const (
	UsageTimeseriesIntervalDay   UsageTimeseriesInterval = "day"
	UsageTimeseriesIntervalHour  UsageTimeseriesInterval = "hour"
	UsageTimeseriesIntervalMonth UsageTimeseriesInterval = "month"
	UsageTimeseriesIntervalWeek  UsageTimeseriesInterval = "week"
)

Defines values for UsageTimeseriesInterval.

func (UsageTimeseriesInterval) Valid 

func (e UsageTimeseriesInterval) Valid() bool

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

type UsageTimeseriesMetric 

type UsageTimeseriesMetric string

UsageTimeseriesMetric `sum_tokens` is input plus output tokens. `sum_cost` is provider-reported cost in USD. `count_model_calls` counts model calls that recorded usage. 

const (
	UsageTimeseriesMetricCountModelCalls UsageTimeseriesMetric = "count_model_calls"
	UsageTimeseriesMetricSumCost         UsageTimeseriesMetric = "sum_cost"
	UsageTimeseriesMetricSumInputTokens  UsageTimeseriesMetric = "sum_input_tokens"
	UsageTimeseriesMetricSumOutputTokens UsageTimeseriesMetric = "sum_output_tokens"
	UsageTimeseriesMetricSumTokens       UsageTimeseriesMetric = "sum_tokens"
)

Defines values for UsageTimeseriesMetric.

func (UsageTimeseriesMetric) Valid 

func (e UsageTimeseriesMetric) Valid() bool

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

type UsageTimeseriesSeries 

type UsageTimeseriesSeries struct {
	// ID Configured model ID for `model` series, agent profile ID for `profile` series.
	ID *string `json:"id,omitempty"`

	// Kind `no_profile` groups usage from agents launched without a profile; `other` folds together every group beyond `group_limit`.
	Kind UsageTimeseriesSeriesKind `json:"kind"`

	// ModelProviderConfigName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	ModelProviderConfigName *ResourceName `json:"model_provider_config_name,omitempty"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name *ResourceName `json:"name,omitempty"`

	// ProjectName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	ProjectName *ResourceName `json:"project_name,omitempty"`

	// Total Metric over the whole window.
	Total float64 `json:"total"`

	// Values Metric in each bucket, aligned with `bucket_starts`.
	Values []float64 `json:"values"`
}

UsageTimeseriesSeries defines model for UsageTimeseriesSeries.

type UsageTimeseriesSeriesKind 

type UsageTimeseriesSeriesKind string

UsageTimeseriesSeriesKind `no_profile` groups usage from agents launched without a profile; `other` folds together every group beyond `group_limit`. 

const (
	UsageTimeseriesSeriesKindAll       UsageTimeseriesSeriesKind = "all"
	UsageTimeseriesSeriesKindModel     UsageTimeseriesSeriesKind = "model"
	UsageTimeseriesSeriesKindNoProfile UsageTimeseriesSeriesKind = "no_profile"
	UsageTimeseriesSeriesKindOther     UsageTimeseriesSeriesKind = "other"
	UsageTimeseriesSeriesKindProfile   UsageTimeseriesSeriesKind = "profile"
)

Defines values for UsageTimeseriesSeriesKind.

func (UsageTimeseriesSeriesKind) Valid 

func (e UsageTimeseriesSeriesKind) Valid() bool

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

type UsageTokenTotals 

type UsageTokenTotals struct {
	CacheReadInputTokens  int64 `json:"cache_read_input_tokens"`
	CacheWriteInputTokens int64 `json:"cache_write_input_tokens"`
	InputTokensTotal      int64 `json:"input_tokens_total"`
	OutputTokensTotal     int64 `json:"output_tokens_total"`
	ReasoningOutputTokens int64 `json:"reasoning_output_tokens"`
	UncachedInputTokens   int64 `json:"uncached_input_tokens"`
}

UsageTokenTotals Summed token counts across the tallied model calls. Input totals are the sum of uncached, cache-read, and cache-write tokens; output totals include reasoning tokens.

type UsageTotals 

type UsageTotals struct {
	Cost UsageCostTotals `json:"cost"`

	// ModelCalls Model calls that recorded token usage or a provider-reported cost.
	ModelCalls int64 `json:"model_calls"`

	// Tokens Summed token counts across the tallied model calls. Input totals are the sum of uncached, cache-read, and cache-write tokens; output totals include reasoning tokens.
	Tokens UsageTokenTotals `json:"tokens"`
}

UsageTotals defines model for UsageTotals.

type UsageUntil 

type UsageUntil = time.Time

UsageUntil defines model for UsageUntil.

type UserID 

type UserID = string

UserID defines model for UserID.

type UserSecretOwner 

type UserSecretOwner struct {
	Kind   UserSecretOwnerKind `json:"kind"`
	UserID UserID              `json:"user_id"`
}

UserSecretOwner defines model for UserSecretOwner.

type UserSecretOwnerInput 

type UserSecretOwnerInput struct {
	Kind UserSecretOwnerInputKind `json:"kind"`
}

UserSecretOwnerInput defines model for UserSecretOwnerInput.

type UserSecretOwnerInputKind 

type UserSecretOwnerInputKind string

UserSecretOwnerInputKind defines model for UserSecretOwnerInput.Kind. 

const (
	UserSecretOwnerInputKindUser UserSecretOwnerInputKind = "user"
)

Defines values for UserSecretOwnerInputKind.

func (UserSecretOwnerInputKind) Valid 

func (e UserSecretOwnerInputKind) Valid() bool

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

type UserSecretOwnerKind 

type UserSecretOwnerKind string

UserSecretOwnerKind defines model for UserSecretOwner.Kind. 

const (
	UserSecretOwnerKindUser UserSecretOwnerKind = "user"
)

Defines values for UserSecretOwnerKind.

func (UserSecretOwnerKind) Valid 

func (e UserSecretOwnerKind) Valid() bool

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

type UserSkillOwner 

type UserSkillOwner struct {
	Kind   UserSkillOwnerKind `json:"kind"`
	UserID UserID             `json:"user_id"`
}

UserSkillOwner defines model for UserSkillOwner.

type UserSkillOwnerInput 

type UserSkillOwnerInput struct {
	Kind UserSkillOwnerInputKind `json:"kind"`
}

UserSkillOwnerInput defines model for UserSkillOwnerInput.

type UserSkillOwnerInputKind 

type UserSkillOwnerInputKind string

UserSkillOwnerInputKind defines model for UserSkillOwnerInput.Kind. 

const (
	UserSkillOwnerInputKindUser UserSkillOwnerInputKind = "user"
)

Defines values for UserSkillOwnerInputKind.

func (UserSkillOwnerInputKind) Valid 

func (e UserSkillOwnerInputKind) Valid() bool

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

type UserSkillOwnerKind 

type UserSkillOwnerKind string

UserSkillOwnerKind defines model for UserSkillOwner.Kind. 

const (
	UserSkillOwnerKindUser UserSkillOwnerKind = "user"
)

Defines values for UserSkillOwnerKind.

func (UserSkillOwnerKind) Valid 

func (e UserSkillOwnerKind) Valid() bool

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

type VisibleMachine 

type VisibleMachine struct {
	Access          MachineAccess          `json:"access"`
	ConnectionState MachineConnectionState `json:"connection_state"`
	CreatedAt       Timestamp              `json:"created_at"`
	DeletedAt       *Timestamp             `json:"deleted_at"`
	Description     string                 `json:"description"`

	// DisplayName Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	DisplayName ResourceName `json:"display_name"`

	// ID Machine ID (mch_...).
	ID             MachineID             `json:"id"`
	LastObservedAt *Timestamp            `json:"last_observed_at"`
	LifecycleState MachineLifecycleState `json:"lifecycle_state"`
	OrgID          OrganizationID        `json:"org_id"`
	Provider       string                `json:"provider"`
	SourceKind     MachineSourceKind     `json:"source_kind"`
	UpdatedAt      Timestamp             `json:"updated_at"`
}

VisibleMachine defines model for VisibleMachine.

type VisibleProject 

type VisibleProject struct {
	Access    ProjectAccess `json:"access"`
	CreatedAt Timestamp     `json:"created_at"`

	// ID Project ID (proj_...).
	ID ProjectID `json:"id"`

	// Name Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not.
	Name      ResourceName   `json:"name"`
	OrgID     OrganizationID `json:"org_id"`
	UpdatedAt Timestamp      `json:"updated_at"`
}

VisibleProject defines model for VisibleProject.

type WriteMemoryFileParams 

type WriteMemoryFileParams struct {
	// Path Literal path relative to the store root.
	Path string `form:"path" json:"path"`

	// ExpectedDigest Digest of the contents being replaced or deleted. Required to change an existing file.
	ExpectedDigest *string `form:"expected_digest,omitempty" json:"expected_digest,omitempty"`
}

WriteMemoryFileParams defines parameters for WriteMemoryFile.

Source Files

View all Source files

Directories

Path Synopsis
Package facade is the client of the BMA extensions to the Anthropic Managed Agents API.
 Package facade is the client of the BMA extensions to the Anthropic Managed Agents API.
internal
apicore
Package apicore is the request runtime shared by every generated resource method of package bma and package facade: scope defaults, request encoding, retries with idempotency keys, timeouts, error decoding, pagination and event streams.
 Package apicore is the request runtime shared by every generated resource method of package bma and package facade: scope defaults, request encoding, retries with idempotency keys, timeouts, error decoding, pagination and event streams.
contracttest
Package contracttest serves the recorded SDK contract fixtures in contracts/bma/fixtures/sdk-contract.json to package tests.
 Package contracttest serves the recorded SDK contract fixtures in contracts/bma/fixtures/sdk-contract.json to package tests.
requestconfig
Package requestconfig holds the settings that client options and per-request options change.
 Package requestconfig holds the settings that client options and per-request options change.
Package option configures a bma.Client, a facade.Client, or one request.
 Package option configures a bma.Client, a facade.Client, or one request.
tools
sdkgen/gofields command
Command gofields prints the struct fields and method names of the types in one Go file as JSON, so tools/sdkgen/sdkgen.py can build the Go resource layer on top of the oapi-codegen models without re-deriving their names.
 Command gofields prints the struct fields and method names of the types in one Go file as JSON, so tools/sdkgen/sdkgen.py can build the Go resource layer on top of the oapi-codegen models without re-deriving their names.

Jump to

Keyboard shortcuts

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