api

package

Go to main page

Versions in this module

v0

v0.10.15

Nov 11, 2026

Changes in this version

type Client

+ func (c *Client) Duplicate(ctx context.Context, avatarID string, in DuplicateInput) (*CreateResult, *Quota, error)

+ func (c *Client) ListPage(ctx context.Context, q ListQuery) (*ListPage, error)

+ type DuplicateInput struct

+ Engine string

+ Name string

+ type ListPage = avatarapi.AvatarListResponse

+ type ListQuery struct

+ Badge string

+ Before *time.Time

+ Engine string

+ Frame string

+ Limit int

+ Offset *int

+ Order string

+ Q string

+ Sort string

+ Sponsored *bool

+ Visibility string

+ func (q ListQuery) Paged() bool

v0.10.14

Nov 7, 2026

v0.10.13

Nov 6, 2026

v0.10.12

Nov 4, 2026

Changes in this version

+ const ClipExpired

+ const ClipReady

+ const ClipRendering

+ const ClipStalled

+ const EngineV2ProAlias

+ func CanonicalEngine(e string) string

+ func ParseClipRequestID(s string) (uuid.UUID, error)

+ func WireEngine(e string) string

type Client

+ func (c *Client) GetClip(ctx context.Context, requestID string) (*ClipStatus, error)

+ func (c *Client) WaitClip(ctx context.Context, requestID string, timeout, interval time.Duration, ...) (*ClipStatus, error)

+ type ClipStatus = avatarapi.ClipStatusResponse

+ type GeneratedClipBody = avatarapi.GeneratedClip

v0.10.11

Nov 3, 2026

Changes in this version

+ const EngineV1

+ const EngineV2

+ const EngineV2Pro

+ const MaxV2ProResolutionPixels

+ const V2AccessGranted

+ const V2AccessInviteRequired

+ const V2AccessUnavailable

+ func CheckOffered(acct *Account, engine string, r Resolution) error

+ func CheckResolutionFor(engine string, r Resolution) error

+ func IsV2Family(engine string) bool

type Client

+ func (c *Client) CheckSize(ctx context.Context, engine string, r Resolution) error

+ type EnhanceInput struct

+ AvatarID *uuid.UUID

+ Engine string

+ Image string

+ Prompt string

type Resolution

+ func OfferedResolutions(acct *Account, engine string) []Resolution

+ type V2ProSizeError struct

+ func (e *V2ProSizeError) Error() string

v0.10.10

Nov 3, 2026

Changes in this version

+ const DefaultBaseURL

+ const JoinWaitTimeout

+ const MaxCandidatesPerRequest

+ const MaxClipRenderPixels

+ const MaxClipSeconds

+ const MaxClipSide

+ const MaxConductorBodyBytes

+ const MaxPoolClipSeconds

+ const MaxPrimeTextChars

+ const MaxResolutionPixels

+ const MaxResolutionSide

+ const MaxRuntimeSeed

+ const MinClipSide

+ const MinResolutionSide

+ const ResolutionStep

+ var AspectRatioSizes = map[AspectRatio]Resolution

+ func CheckAspectOrResolution(aspect, resolution bool) error

+ func CheckClipResolution(r ClipResolution) error

+ func CheckPrimeText(engine, text string) error

+ func CheckResolution(r Resolution) error

+ func CheckRuntimeSeed(seed int) error

+ func ClipRenderSize(r ClipResolution) (w, h int)

+ func ConductorBody(raw []byte, speakAfterS *float64) ([]byte, error)

+ func IsRemote(s string) bool

+ func MaxClipSecondsAt(r ClipResolution) int

+ func NewIDs(before, after *CandidateList) []string

+ func ParseCandidateID(s string) (uuid.UUID, error)

+ func ParseID(s string) (uuid.UUID, error)

+ func ParseKeyID(s string) (uuid.UUID, error)

+ func ParseSpeechSettings(raw []byte) (map[string]json.RawMessage, error)

+ func Settled(a *Avatar) bool

+ type APIKey string

+ func (k APIKey) Authorize(_ context.Context, r *http.Request) error

+ type Account struct

+ SessionV2Reported bool

+ func (a *Account) UnmarshalJSON(b []byte) error

+ func (a Account) MarshalJSON() ([]byte, error)

+ type AspectRatio = avatarapi.AspectRatio

+ func ParseAspectRatio(s string) (AspectRatio, error)

+ type Avatar = avatarapi.AvatarDetail

+ type AvatarSession = avatarapi.AvatarSessionCreateResponse

+ type AvatarSessionInput struct

+ AgentIdentity string

+ LiveKitToken string

+ LiveKitURL string

+ MaxDurationSeconds *int

+ Metadata map[string]any

+ WaitJoined bool

+ type AvatarSummary = avatarapi.AvatarSummary

+ type Balance = avatarapi.AccountBalance

+ type BuildFailedError struct

+ Avatar *Avatar

+ func (e *BuildFailedError) Error() string

+ type BuildStage = avatarapi.BuildStage

+ type Candidate = avatarapi.Candidate

+ func Current(cl *CandidateList) []Candidate

+ func Previewable(cl *CandidateList) []Candidate

+ type CandidateList = avatarapi.CandidateListResponse

+ type CandidatesPage struct

+ Quota *Quota

+ type Client struct

+ BaseURL string

+ InProgressSleep time.Duration

+ JoinTimeout time.Duration

+ MockScenario string

+ OnWarming func(wait time.Duration)

+ Sleep func(time.Duration)

+ WarmingTimeout time.Duration

+ func New(baseURL string, cred Credential, timeout time.Duration) (*Client, error)

+ func (c *Client) APIKeys(ctx context.Context) ([]Key, error)

+ func (c *Client) Account(ctx context.Context) (*Account, error)

+ func (c *Client) AddCandidates(ctx context.Context, avatarID string, count int) (*CandidatesPage, error)

+ func (c *Client) AllCandidates(ctx context.Context, avatarID string) (*CandidatesPage, error)

+ func (c *Client) Appearance(ctx context.Context, avatarID string) (*SourceFile, error)

+ func (c *Client) AvatarSessionStatus(ctx context.Context, sessionID string) (*SessionStatus, error)

+ func (c *Client) Balance(ctx context.Context) (*Balance, error)

+ func (c *Client) Candidates(ctx context.Context, avatarID string) (*CandidatesPage, error)

+ func (c *Client) Create(ctx context.Context, in CreateInput) (*CreateResult, *Quota, error)

+ func (c *Client) CreateAPIKey(ctx context.Context, fields map[string]any) (*KeySecret, error)

+ func (c *Client) CurrentKey(ctx context.Context) (*CurrentUser, error)

+ func (c *Client) Delete(ctx context.Context, avatarID string) error

+ func (c *Client) DeleteConductor(ctx context.Context, avatarID string) error

+ func (c *Client) DeleteVersion(ctx context.Context, avatarID, versionID string) (*VersionDeleted, error)

+ func (c *Client) DesignVoice(ctx context.Context, in DesignVoiceInput, key string) (*DesignedVoices, error)

+ func (c *Client) Earnings(ctx context.Context) (*Earnings, error)

+ func (c *Client) EndAvatarSession(ctx context.Context, sessionID string) (*SessionEnd, error)

+ func (c *Client) EndSpeechSession(ctx context.Context, sessionID string) (*SpeechSessionEnd, error)

+ func (c *Client) EnhancePortrait(ctx context.Context, image, prompt, key string) (*GeneratedPortraits, error)

+ func (c *Client) GenerateClip(ctx context.Context, in ClipInput, key string) (*GeneratedClip, error)

+ func (c *Client) GeneratePortraits(ctx context.Context, description, key string) (*GeneratedPortraits, error)

+ func (c *Client) Get(ctx context.Context, avatarID string) (*Avatar, error)

+ func (c *Client) GetConductor(ctx context.Context, avatarID string) (*Conductor, error)

+ func (c *Client) GrantSponsor(ctx context.Context, avatarID string, microcredits int, key string) (*SponsorGrant, error)

+ func (c *Client) Knowledge(ctx context.Context, avatarID string) (*Knowledge, error)

+ func (c *Client) List(ctx context.Context, limit int, before *time.Time) ([]AvatarSummary, *time.Time, error)

+ func (c *Client) Monetization(ctx context.Context, avatarID string) (*Monetization, error)

+ func (c *Client) Redeem(ctx context.Context, code string) (*Redemption, error)

+ func (c *Client) RemoveThumbnail(ctx context.Context, avatarID string) (*Avatar, error)

+ func (c *Client) ReplaceAppearance(ctx context.Context, avatarID, path string) error

+ func (c *Client) ReplaceKnowledge(ctx context.Context, avatarID string, paths []string) error

+ func (c *Client) ReplaceVoice(ctx context.Context, avatarID, path string) error

+ func (c *Client) RevokeAPIKey(ctx context.Context, keyID string) (*Key, error)

+ func (c *Client) RotateAPIKey(ctx context.Context, keyID string) (*KeySecret, error)

+ func (c *Client) SelectCandidate(ctx context.Context, avatarID, candidateID string) (*Avatar, error)

+ func (c *Client) SetConductor(ctx context.Context, avatarID string, body []byte) (*Conductor, error)

+ func (c *Client) SetThumbnail(ctx context.Context, avatarID, path string) (*Avatar, error)

+ func (c *Client) SpeechSessionStatus(ctx context.Context, sessionID string) (*SpeechSessionStatus, error)

+ func (c *Client) Sponsor(ctx context.Context, avatarID string) (*Sponsor, error)

+ func (c *Client) StartAvatarSession(ctx context.Context, avatarID string, in AvatarSessionInput) (*AvatarSession, error)

+ func (c *Client) StartSession(ctx context.Context, avatarID string, in EmbedSessionInput) (*EmbedSession, error)

+ func (c *Client) StartSpeechSession(ctx context.Context, in SpeechSessionInput) (*SpeechSession, error)

+ func (c *Client) Update(ctx context.Context, avatarID string, fields map[string]any) (*Avatar, error)

+ func (c *Client) UpdateAPIKey(ctx context.Context, keyID string, fields map[string]any) (*Key, error)

+ func (c *Client) UpdateSponsor(ctx context.Context, avatarID string, settings map[string]any) (*Sponsor, error)

+ func (c *Client) UploadPortrait(ctx context.Context, path string) (string, error)

+ func (c *Client) UploadVoice(ctx context.Context, path string) (string, error)

+ func (c *Client) Voice(ctx context.Context, avatarID string) (*VoiceFile, error)

+ func (c *Client) Wait(ctx context.Context, avatarID string, timeout, interval time.Duration, ...) (*Avatar, error)

+ func (c *Client) WaitForCandidates(ctx context.Context, avatarID string, timeout, interval time.Duration, ...) (*CandidatesPage, error)

+ func (c *Client) WaitServing(ctx context.Context, avatarID, candidateID string, ...) (*Avatar, error)

+ func (c *Client) WithdrawSponsor(ctx context.Context, avatarID string, microcredits *int) (*SponsorWithdraw, error)

+ type ClipInput struct

+ AspectRatio string

+ Audio string

+ Duration int

+ Image string

+ Prompt string

+ Resolution *ClipResolution

+ Seed *int64

+ type ClipResolution = avatarapi.ClipResolution

+ func ParseClipResolution(s string) (ClipResolution, error)

+ type Conductor struct

+ AvatarID string

+ Edges int

+ Graph json.RawMessage

+ Nodes int

+ SpeakAfterS *float64

+ type CreateInput struct

+ AspectRatio string

+ Candidates int

+ Description string

+ Engine string

+ Facts string

+ Image string

+ Knowledge []string

+ Language string

+ Name string

+ Persona map[string]any

+ PreviewMessage string

+ Previews *bool

+ Resolution *Resolution

+ RuntimeSeed *int

+ SeedSelection string

+ SponsorMaxPerSession *int

+ SponsorMicrocredits *int

+ Visibility string

+ Voice string

+ func (in CreateInput) Manifest() (map[string]any, error)

+ type CreateResult = avatarapi.AvatarCreateResponse

+ type Credential interface

+ Authorize func(ctx context.Context, r *http.Request) error

+ type CurrentUser = avatarapi.CurrentCaller

+ type DesignVoiceInput struct

+ AvatarName string

+ Description string

+ Language string

+ SampleText string

+ type DesignedVoices = avatarapi.DesignedVoicesResponse

+ type Earnings = avatarapi.AccountEarnings

+ type EmbedSession = avatarapi.EmbedSessionStartResponse

+ type EmbedSessionInput struct

+ CheckInAfterS *float64

+ Instructions *string

+ Language string

+ Location map[string]any

+ MaxDurationSeconds *int

+ Metadata map[string]any

+ NoWelcome bool

+ Tools Tools

+ VisitorID string

+ type Error struct

+ Cap *int

+ Code string

+ Message string

+ Missing []string

+ ModerationState string

+ MonetizingAvatars *int

+ PayoutsStatus string

+ Reason string

+ RetryAfter int

+ SponsorPoolMicrocredits int64

+ Status int

+ func (e *Error) Error() string

+ type GeneratedClip = avatarapi.GeneratedClipResponse

+ type GeneratedPortraits = avatarapi.GeneratedPortraitsResponse

+ type Key = avatarapi.ApiKey

+ type KeySecret = avatarapi.ApiKeySecret

+ type Knowledge = avatarapi.AvatarKnowledge

+ type Monetization = avatarapi.AvatarMonetization

+ type Quota struct

+ Limit int

+ Remaining int

+ type Redemption = avatarapi.CodeRedemption

+ type Resolution = avatarapi.RenderResolution

+ func ParseResolution(s string) (Resolution, error)

+ type SessionEnd = avatarapi.AvatarSessionEndResponse

+ type SessionStatus = avatarapi.AvatarSessionStatusResponse

+ type SourceFile = avatarapi.AvatarSourceFile

+ type SpeechSession = avatarapi.SpeechSessionCreateResponse

+ type SpeechSessionEnd = avatarapi.SpeechSessionEndResponse

+ type SpeechSessionInput struct

+ AvatarID uuid.UUID

+ Language string

+ MaxDurationSeconds *int

+ Settings json.RawMessage

+ type SpeechSessionStatus = avatarapi.SpeechSessionStatusResponse

+ type Sponsor = avatarapi.AvatarSponsor

+ type SponsorGrant = avatarapi.SponsorGrantResponse

+ type SponsorWithdraw = avatarapi.SponsorWithdrawResponse

+ type Tools []json.RawMessage

+ func ParseTools(raw []byte) (Tools, error)

+ type VersionDeleted = avatarapi.VersionDeleteResponse

+ type VoiceFile = avatarapi.AvatarVoice

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