Help us shape the future of Go! Take the 2026 Go Developer Survey

Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

public

package

Go to main page

Versions in this module

v2

v2.19.3

Nov 3, 2026

Changes in this version

type Client

+ func (c *Client) ListAllWorkspaces(ctx context.Context) ([]oapi.LivekitPublicapiWorkspacesV1Workspace, error)

+ type KeyFilter struct

+ IncludeAgentKeys bool

+ OwnerID string

+ type MemberRemoval struct

+ LastKeyProjectNames []string

+ NumKeys uint32

+ NumPrivateLastKeyProjects uint32

+ func MemberRemovalNotConfirmed(err error) (*MemberRemoval, bool)

+ func (r *MemberRemoval) LeavesProjectWithoutKey() bool

+ type ProjectSettings struct

+ CustomDomain *string

+ DisableTokenEndpoint *bool

+ DiscoverableByDomain *bool

+ EnableAnalytics *bool

+ EnableAutoCreate *bool

+ EnableEgressAutoRetry *bool

+ EnableEgressBackupStorage *bool

+ EnableInferenceRegionRestriction *bool

+ EnablePiiRedaction *bool

+ EnableRemoteUnmute *bool

+ EnableUserDataRecording *bool

+ EnableUserDataTraining *bool

+ EnabledCodecs *[]string

+ IsPrivate *bool

+ JoinableByDomain *bool

+ Name *string

+ PiiRedactionCategories *[]oapi.CloudProtocolPIIRedactionCategory

+ PinnedRegions *[]string

+ RequireExplicitDispatch *bool

+ SfuAllowPause *bool

+ Subdomain *string

+ UserDataRegion *string

+ func (s ProjectSettings) IsZero() bool

v2.19.2

Oct 22, 2026

v2.19.1

Oct 20, 2026

Changes in this version

+ const RecordingAudio

+ const RecordingChatHistory

+ func DownloadRecording(ctx context.Context, signedURL string, w io.Writer) (int64, error)

+ func EventTypeName(apiType string) string

+ func EventTypeNames() []string

+ func IsNotFound(err error) bool

+ func ObservabilityDisabled(err error) (dashboardURL string, ok bool)

type Client

+ func (c *Client) CreateToken(ctx context.Context, projectID string, grants *auth.ClaimGrants, ...) (token string, expiresAt time.Time, err error)

+ func (c *Client) CreateWebhook(ctx context.Context, projectID string, ...) (*oapi.LivekitPublicapiProjectsV1Webhook, error)

+ func (c *Client) DeleteKey(ctx context.Context, projectID, apiKey string) error

+ func (c *Client) DeleteWebhook(ctx context.Context, projectID, webhookID string) error

+ func (c *Client) GenerateKey(ctx context.Context, projectID, description string, serviceAccount bool) (*oapi.LivekitPublicapiProjectsV1GenerateKeyResponse, error)

+ func (c *Client) GetSessionLogs(ctx context.Context, projectID, sessionID string, opts LogOptions) (*LogPage, error)

+ func (c *Client) GetSessionMetrics(ctx context.Context, projectID, sessionID string, opts MetricOptions) (*MetricPage, error)

+ func (c *Client) GetSessionRecordingURL(ctx context.Context, projectID, sessionID string, opts RecordingURLOptions) (*oapi.LivekitPublicapiObservabilityV1RecordingGetURLResponse, error)

+ func (c *Client) GetSessionTraces(ctx context.Context, projectID, sessionID string, opts PageOptions) (*TracePage, error)

+ func (c *Client) GetSessionTranscript(ctx context.Context, projectID, sessionID string, opts PageOptions) (*TranscriptPage, error)

+ func (c *Client) ListKeys(ctx context.Context, projectID string, includeAgentKeys bool) ([]oapi.LivekitPublicapiProjectsV1AccessKey, error)

+ func (c *Client) ListScopedKeys(ctx context.Context, projectID string) (personal, other []oapi.LivekitPublicapiProjectsV1AccessKey, err error)

+ func (c *Client) ListSessionEvents(ctx context.Context, projectID, sessionID string, opts EventOptions) (*EventPage, error)

+ func (c *Client) ListSessionParticipants(ctx context.Context, projectID, sessionID string, opts ParticipantListOptions) (participants []oapi.LivekitPublicapiAnalyticsV1ParticipantInfo, ...)

+ func (c *Client) ListWebhookEvents(ctx context.Context, projectID string) ([]string, error)

+ func (c *Client) ListWebhooks(ctx context.Context, projectID string) ([]oapi.LivekitPublicapiProjectsV1Webhook, error)

+ func (c *Client) SendTestWebhook(ctx context.Context, projectID, webhookID, event string) (*oapi.LivekitPublicapiProjectsV1SendTestWebhookResponse, error)

+ func (c *Client) UpdateWebhook(ctx context.Context, projectID, webhookID string, ...) (*oapi.LivekitPublicapiProjectsV1Webhook, error)

+ type EventOptions struct

+ ParticipantSessionID string

+ SortOrder string

+ Types []string

+ func (o EventOptions) Validate() error

+ type EventPage struct

+ Events []oapi.LivekitPublicapiAnalyticsV1SessionEvent

+ NextCursor string

+ type LogOptions struct

+ Levels []string

+ SortOrder string

+ func (o LogOptions) Validate() error

+ type LogPage struct

+ NextCursor string

+ Records []oapi.LivekitPublicapiObservabilityV1LogRecord

+ type MetricOptions struct

+ Names []string

+ func (o MetricOptions) Validate() error

+ type MetricPage struct

+ NextCursor string

+ Points []MetricPoint

+ type MetricPoint struct

+ Attributes map[string]*oapi.GoogleProtobufValue

+ EndTime *time.Time

+ Histogram *oapi.LivekitPublicapiObservabilityV1MetricHistogram

+ Kind oapi.LivekitPublicapiObservabilityV1MetricKind

+ Name string

+ StartTime *time.Time

+ Unit string

+ Value *float64

+ type PageOptions struct

+ Cursor string

+ Limit int32

+ func (o PageOptions) Validate() error

+ type ParticipantListOptions struct

+ SortBy string

+ SortOrder string

+ func (o ParticipantListOptions) Validate() error

+ type RecordingURLOptions struct

+ Recording string

+ func (o RecordingURLOptions) Validate() error

+ type SessionListOptions struct

+ Cursor string

+ End time.Time

+ Limit int32

+ RoomPrefix string

+ SortOrder string

+ Start time.Time

+ Statuses []string

+ Tags []string

+ func (o SessionListOptions) Validate() error

+ type TracePage struct

+ NextCursor string

+ Spans []oapi.LivekitPublicapiObservabilityV1Span

+ type TranscriptItem struct

+ AgentHandoff *oapi.LivekitPublicapiObservabilityV1TranscriptItemAgentHandoff

+ ConfigUpdate *oapi.LivekitPublicapiObservabilityV1TranscriptItemConfigUpdate

+ ID string

+ Message *oapi.LivekitPublicapiObservabilityV1TranscriptItemMessage

+ Timestamp *time.Time

+ ToolCall *oapi.LivekitPublicapiObservabilityV1TranscriptItemToolCall

+ ToolResult *oapi.LivekitPublicapiObservabilityV1TranscriptItemToolResult

+ type TranscriptPage struct

+ Items []TranscriptItem

+ NextCursor string

+ SkippedRecords int

v2.19.0

Oct 8, 2026

v2.18.8

Sep 22, 2026

v2.18.7

Sep 15, 2026

Changes in this version

+ const DefaultBaseURL

+ func IsPermissionDenied(err error) bool

+ func IsUnauthenticated(err error) bool

+ func RoleName(v *int32) string

+ type APIError struct

+ Message string

+ Status int

+ func (e *APIError) Error() string

+ type Client struct

+ func New(baseURL, token string, opts ...oapi.ClientOption) (*Client, error)

+ func (c *Client) AddWorkspaceMembersToProject(ctx context.Context, projectID string, userIDs []string, role Role) ([]oapi.LivekitPublicapiProjectsV1ProjectMember, error)

+ func (c *Client) AnswerProjectInvitation(ctx context.Context, inviteToken string, accept bool) (*oapi.LivekitPublicapiProjectsV1ProjectMember, error)

+ func (c *Client) AnswerWorkspaceInvite(ctx context.Context, inviteToken string, accept bool) (*oapi.LivekitPublicapiWorkspacesV1WorkspaceMember, error)

+ func (c *Client) CancelSimulationRun(ctx context.Context, projectID, runID string) error

+ func (c *Client) CreateProject(ctx context.Context, name string) (*oapi.LivekitPublicapiProjectsV1Project, error)

+ func (c *Client) CreateSimulationRun(ctx context.Context, projectID string, opts CreateSimulationOptions) (*oapi.LivekitSimulationRunCreateResponse, error)

+ func (c *Client) CreateWorkspace(ctx context.Context, name, organizationID string) (*oapi.LivekitPublicapiWorkspacesV1Workspace, error)

+ func (c *Client) CreateWorkspaceInvite(ctx context.Context, workspaceID, email string, role Role) (*oapi.LivekitPublicapiWorkspacesV1CreateInviteResponse, error)

+ func (c *Client) CreateWorkspaceProject(ctx context.Context, workspaceID, name string) (*oapi.LivekitPublicapiProjectsV1Project, error)

+ func (c *Client) DeleteProject(ctx context.Context, projectID string) error

+ func (c *Client) DeleteProjectInvite(ctx context.Context, projectID, email string) error

+ func (c *Client) DeleteWorkspace(ctx context.Context, workspaceID string) error

+ func (c *Client) DeleteWorkspaceInvite(ctx context.Context, workspaceID, email string) error

+ func (c *Client) DeleteWorkspaceMember(ctx context.Context, workspaceID, userID string) error

+ func (c *Client) DeleteWorkspaceProject(ctx context.Context, workspaceID, projectID string) error

+ func (c *Client) GetCurrentUser(ctx context.Context) (*oapi.LivekitPublicapiUsersV1User, error)

+ func (c *Client) GetProject(ctx context.Context, projectID string) (*oapi.LivekitPublicapiProjectsV1Project, error)

+ func (c *Client) GetProjectInvite(ctx context.Context, inviteToken string) (*oapi.LivekitPublicapiProjectsV1ProjectInvite, error)

+ func (c *Client) GetProjectMember(ctx context.Context, projectID, userID string) (*oapi.LivekitPublicapiProjectsV1ProjectMember, error)

+ func (c *Client) GetSession(ctx context.Context, projectID, sessionID string) (*oapi.LivekitPublicapiAnalyticsV1Session, error)

+ func (c *Client) GetSimulationRun(ctx context.Context, projectID, runID string) (*oapi.LivekitSimulationRun, error)

+ func (c *Client) GetUser(ctx context.Context, userID string) (*oapi.LivekitPublicapiUsersV1User, error)

+ func (c *Client) GetWorkspace(ctx context.Context, workspaceID string) (*oapi.LivekitPublicapiWorkspacesV1Workspace, error)

+ func (c *Client) GetWorkspaceInvite(ctx context.Context, inviteToken string) (*oapi.LivekitPublicapiWorkspacesV1WorkspaceInvite, error)

+ func (c *Client) GetWorkspaceMember(ctx context.Context, workspaceID, userID string) (*oapi.LivekitPublicapiWorkspacesV1WorkspaceMember, error)

+ func (c *Client) GetWorkspaceProject(ctx context.Context, workspaceID, projectID string) (*oapi.LivekitPublicapiProjectsV1Project, error)

+ func (c *Client) InviteProjectMember(ctx context.Context, projectID, email string, role Role) (*oapi.LivekitPublicapiProjectsV1InviteMemberResponse, error)

+ func (c *Client) ListProjectInvites(ctx context.Context, projectID string) ([]oapi.LivekitPublicapiProjectsV1ProjectInvite, error)

+ func (c *Client) ListProjectMembers(ctx context.Context, projectID string) ([]oapi.LivekitPublicapiProjectsV1ProjectMember, error)

+ func (c *Client) ListProjectSessions(ctx context.Context, projectID string, limit int32, cursor string) (sessions []oapi.LivekitPublicapiAnalyticsV1Session, nextCursor string, ...)

+ func (c *Client) ListProjects(ctx context.Context) ([]oapi.LivekitPublicapiProjectsV1Project, error)

+ func (c *Client) ListSimulationRuns(ctx context.Context, projectID, status, pageToken string) (runs []oapi.LivekitSimulationRun, nextToken string, err error)

+ func (c *Client) ListUsers(ctx context.Context, projectID, workspaceID string, limit int32, cursor string) (users []oapi.LivekitPublicapiUsersV1User, nextCursor string, err error)

+ func (c *Client) ListWorkspaceInvites(ctx context.Context, workspaceID string) ([]oapi.LivekitPublicapiWorkspacesV1WorkspaceInvite, error)

+ func (c *Client) ListWorkspaceMembers(ctx context.Context, workspaceID string) ([]oapi.LivekitPublicapiWorkspacesV1WorkspaceMember, error)

+ func (c *Client) ListWorkspaceProjects(ctx context.Context, workspaceID string, limit int32, cursor string) (projects []oapi.LivekitPublicapiProjectsV1Project, nextCursor string, ...)

+ func (c *Client) ListWorkspaces(ctx context.Context, limit int32, cursor string) (workspaces []oapi.LivekitPublicapiWorkspacesV1Workspace, nextCursor string, ...)

+ func (c *Client) RemoveProjectMember(ctx context.Context, projectID, userID string) error

+ func (c *Client) UpdateProject(ctx context.Context, projectID, name string) (*oapi.LivekitPublicapiProjectsV1Project, error)

+ func (c *Client) UpdateProjectInvite(ctx context.Context, projectID, email string, role Role) (*oapi.LivekitPublicapiProjectsV1ProjectInvite, error)

+ func (c *Client) UpdateProjectMember(ctx context.Context, projectID, userID string, role Role) (*oapi.LivekitPublicapiProjectsV1ProjectMember, error)

+ func (c *Client) UpdateWorkspace(ctx context.Context, workspaceID, name string) (*oapi.LivekitPublicapiWorkspacesV1Workspace, error)

+ func (c *Client) UpdateWorkspaceMember(ctx context.Context, workspaceID, userID string, role Role) (*oapi.LivekitPublicapiWorkspacesV1WorkspaceMember, error)

+ func (c *Client) UpdateWorkspaceProject(ctx context.Context, workspaceID, projectID, name string) (*oapi.LivekitPublicapiProjectsV1Project, error)

+ type CreateSimulationOptions struct

+ AgentName string

+ Concurrency int32

+ Mode string

+ NumSimulations int32

+ Region string

+ type Role int32

+ const RoleAdmin

+ const RoleInvited

+ const RoleRead

+ const RoleWrite

+ func ParseRole(s string) (Role, error)

+ func (r Role) String() string