client

package

Go to main page

Versions in this module

v1

v1.2.1

Jul 15, 2026

v1.2.0

Jul 15, 2026

Changes in this version

+ const KnowledgeSourceFileMaxBytes

type Client

+ func (c *Client) PostMultipart(ctx context.Context, path, contentType string, body []byte, result interface{}) error

+ type CritiqueClient struct

+ func NewCritiqueClient(client *Client) *CritiqueClient

+ func (c *CritiqueClient) Get(ctx context.Context, request *CritiqueRequest) (*CritiquePlan, error)

+ func (c *CritiqueClient) History(ctx context.Context, sessionID string) (*CritiqueHistoryResponse, error)

+ type CritiqueHistoryResponse struct

+ Items []CritiquePlan

+ type CritiquePlan struct

+ CreatedAt string

+ CritiqueID string

+ DocumentHash string

+ SessionID string

+ SourceVersionID string

+ StrategyNote string

+ Suggestions []CritiqueSuggestion

+ type CritiqueRequest struct

+ Categories []string

+ Context string

+ Document string

+ Intensity string

+ KnowledgeCardIDs []string

+ MaxSuggestions int

+ PersonaID string

+ Selection string

+ SelectionEnd *int

+ SelectionStart *int

+ SessionID string

+ SourceVersionID string

+ type CritiqueSuggestion struct

+ Anchor *SuggestionAnchor

+ Category string

+ ID string

+ Instruction string

+ Priority int

+ Rationale string

+ Replacement string

+ Scope string

+ Title string

+ Type string

+ type DraftAngle struct

+ Approach string

+ Avoid []string

+ Description string

+ ShortLabel string

+ Title string

+ VoiceEmphasis []string

+ type DraftAnglePlan struct

+ Angles []DraftAngle

+ StrategyNote string

+ type DraftVariant struct

+ Angle *DraftAngle

+ Content string

+ Index int

+ Temperature float64

type GenerateClient

+ func (g *GenerateClient) Humanize(ctx context.Context, text, personaID string, createSession bool) (*GenerateTextResponse, error)

+ func (g *GenerateClient) TextVariants(ctx context.Context, request *GenerateTextRequest) (*GenerateDraftsResponse, error)

+ type GenerateDraftsResponse struct

+ AnglePlan *DraftAnglePlan

+ ReviewURL string

+ SessionID string

+ Variants []DraftVariant

type GenerateTextRequest

+ CreateSession bool

+ Mode string

+ N int

+ Text string

type GenerateTextResponse

+ ReviewURL string

+ SessionID string

+ type KnowledgeCardIngestResponse struct

+ KnowledgeCard KnowledgeCard

+ Source KnowledgeCardSource

+ Synthesis KnowledgeCardSynthesis

+ type KnowledgeCardSource struct

+ ContentHash string

+ CreatedAt string

+ DisplayName string

+ ErrorMessage string

+ Extension string

+ ExtractedCharCount int

+ ExtractedTextPreview string

+ Filename string

+ KnowledgeCardID string

+ LastProcessedAt string

+ MimeType string

+ SizeBytes int64

+ SourceID string

+ Status string

+ Type string

+ URL string

+ UpdatedAt string

+ UserID string

+ type KnowledgeCardSynthesis struct

+ Instructions string

+ KeyFacts []string

+ Name string

+ Summary string

+ UsageNotes []string

+ Warnings []string

type KnowledgeClient

+ func (k *KnowledgeClient) CreateFromFile(ctx context.Context, filename string, content io.Reader, ...) (*KnowledgeCardIngestResponse, error)

+ func (k *KnowledgeClient) CreateFromURL(ctx context.Context, rawURL, instructionsHint string) (*KnowledgeCardIngestResponse, error)

+ func (k *KnowledgeClient) Sources(ctx context.Context, knowledgeCardID string) ([]KnowledgeCardSource, error)

+ type Quota struct

+ CanCreate struct{ ... }

+ CurrentUsage struct{ ... }

+ Entitlements struct{ ... }

+ PlanID string

+ PlanStatus string

+ UsagePeriod struct{ ... }

+ func (q *Quota) CritiquePassesRemaining() int

+ func (q *Quota) DraftsRemaining() int

+ type Recipe struct

+ AngleHints []string

+ Command string

+ CreatedAt string

+ DefaultDraftCount int

+ Description string

+ Instruction string

+ Name string

+ RecipeID string

+ Source string

+ UpdatedAt string

+ type RecipeRequest struct

+ AngleHints []string

+ Command string

+ DefaultDraftCount int

+ Description string

+ Instruction string

+ Name string

+ UpdatedAt string

+ type RecipeSuggestionRequest struct

+ Draft string

+ Prompt string

+ type RecipesClient struct

+ func NewRecipesClient(client *Client) *RecipesClient

+ func (r *RecipesClient) Create(ctx context.Context, request *RecipeRequest) (*Recipe, error)

+ func (r *RecipesClient) List(ctx context.Context) ([]Recipe, error)

+ func (r *RecipesClient) Suggest(ctx context.Context, request *RecipeSuggestionRequest) (*Recipe, error)

+ func (r *RecipesClient) Update(ctx context.Context, recipeID string, request *RecipeRequest) (*Recipe, error)

+ type SuggestionAnchor struct

+ After string

+ Before string

+ Occurrence int

+ Quote string

type ToneCloneClient

+ Critique *CritiqueClient

+ Recipes *RecipesClient

+ func (tc *ToneCloneClient) GetQuota(ctx context.Context) (*Quota, error)

v1.1.2

Feb 15, 2026

Changes in this version

+ type BundlePreviewResponse struct

+ Items []BundlePreviewItem

+ Type string

+ Version string

type BundleStatusResponse

+ ActiveCount int

+ Type string

+ Version string

+ WordsCount int

v1.1.1

Feb 15, 2026

v1.1.0

Feb 15, 2026

Changes in this version

+ type ApplyBundleRequest struct

+ BundleType string

+ PersonaID string

+ type BundlePreviewItem struct

+ Category string

+ CustomReplacement string

+ Mode string

+ Word string

+ type BundleStatusResponse struct

+ Applied bool

+ BundleType string

+ BundleVersion string

+ WordCount int

+ type CreateStyleGuardWordRequest struct

+ CustomReplacement string

+ Mode string

+ PersonaID string

+ Word string

+ type ImperfectionSettings struct

+ Enabled bool

+ MaxPerChunk int

+ ProtectedContexts []string

+ Rate float64

type Persona

+ Imperfections *ImperfectionSettings

+ type StyleGuardClient struct

+ func NewStyleGuardClient(client *Client) *StyleGuardClient

+ func (s *StyleGuardClient) BundleApply(ctx context.Context, req *ApplyBundleRequest) error

+ func (s *StyleGuardClient) BundlePreview(ctx context.Context, bundleType string) ([]BundlePreviewItem, error)

+ func (s *StyleGuardClient) BundleRemove(ctx context.Context, personaID string) error

+ func (s *StyleGuardClient) BundleStatus(ctx context.Context, personaID, bundleType string) (*BundleStatusResponse, error)

+ func (s *StyleGuardClient) Create(ctx context.Context, req *CreateStyleGuardWordRequest) (*StyleGuardWord, error)

+ func (s *StyleGuardClient) Delete(ctx context.Context, styleGuardID string) error

+ func (s *StyleGuardClient) List(ctx context.Context) ([]StyleGuardWord, error)

+ func (s *StyleGuardClient) ListForPersona(ctx context.Context, personaID string) ([]StyleGuardWord, error)

+ func (s *StyleGuardClient) Update(ctx context.Context, styleGuardID string, req *UpdateStyleGuardWordRequest) (*StyleGuardWord, error)

+ type StyleGuardWord struct

+ BundleVersion string

+ CreatedAt time.Time

+ CustomReplacement string

+ Mode string

+ PersonaID string

+ Source string

+ StyleGuardID string

+ UpdatedAt time.Time

+ Word string

type ToneCloneClient

+ StyleGuard *StyleGuardClient

+ type UpdateStyleGuardWordRequest struct

+ CustomReplacement string

+ Mode string

+ Word string

v1.0.8

Sep 30, 2025

v1.0.7

Sep 16, 2025

Changes in this version

type APIKeyScope

+ const ScopeKnowledgeRead

+ const ScopeKnowledgeWrite

type GenerateTextRequest

+ KnowledgeCardID string

+ KnowledgeCardIDs []string

type GenerateTextResponse

+ KnowledgeCardID string

+ type KnowledgeCard struct

+ CreatedAt time.Time

+ Instructions string

+ KnowledgeCardID string

+ Name string

+ PK string

+ SK string

+ UpdatedAt time.Time

+ UserID string

+ type KnowledgeCardListResponse struct

+ KnowledgeCards []KnowledgeCard

+ type KnowledgeClient struct

+ func NewKnowledgeClient(client *Client) *KnowledgeClient

+ func (k *KnowledgeClient) AssociateWithPersona(ctx context.Context, knowledgeCardID, personaID string) error

+ func (k *KnowledgeClient) Create(ctx context.Context, knowledge *KnowledgeCard) (*KnowledgeCard, error)

+ func (k *KnowledgeClient) Delete(ctx context.Context, knowledgeCardID string) error

+ func (k *KnowledgeClient) DisassociateFromPersona(ctx context.Context, knowledgeCardID, personaID string) error

+ func (k *KnowledgeClient) Get(ctx context.Context, knowledgeCardID string) (*KnowledgeCard, error)

+ func (k *KnowledgeClient) GetPersonaKnowledge(ctx context.Context, personaID string) ([]KnowledgeCard, error)

+ func (k *KnowledgeClient) List(ctx context.Context) ([]KnowledgeCard, error)

+ func (k *KnowledgeClient) Update(ctx context.Context, knowledgeCardID string, knowledge *KnowledgeCard) (*KnowledgeCard, error)

type Persona

+ IsBuiltIn bool

type PersonasClient

+ func (p *PersonasClient) ListBuiltIn(ctx context.Context) ([]Persona, error)

type ToneCloneClient

+ Knowledge *KnowledgeClient

type WritingSession

+ KnowledgeCardID string

v1.0.6

Sep 5, 2025

v1.0.5

Sep 5, 2025

v1.0.4

Sep 5, 2025

v1.0.3

Sep 5, 2025

v1.0.2

Sep 5, 2025

v1.0.1

Sep 4, 2025

Changes in this version

+ const APIVersion

+ const DefaultBaseURL

+ const DefaultTimeout

+ type APIKey struct

+ CreatedAt time.Time

+ ExpiresAt *time.Time

+ KeyID string

+ LastUsedAt *time.Time

+ Name string

+ Prefix string

+ Scopes []APIKeyScope

+ Status string

+ UsageCount int64

+ type APIKeyListResponse struct

+ Keys []APIKey

+ type APIKeyScope string

+ const ScopeAdmin

+ const ScopeAll

+ const ScopeFilesRead

+ const ScopeFilesWrite

+ const ScopePersonasRead

+ const ScopePersonasWrite

+ const ScopeProfilesRead

+ const ScopeProfilesWrite

+ const ScopeTextGenerate

+ const ScopeTrainingRead

+ const ScopeTrainingWrite

+ const ScopeUserRead

+ const ScopeUserWrite

+ const ScopeWritingRead

+ const ScopeWritingWrite

+ type APIResponse struct

+ Data T

+ Error string

+ Status int

+ type BatchFileResult struct

+ Associated bool

+ Error string

+ FileID string

+ Filename string

+ Size int64

+ Status string

+ type BatchUploadResponse struct

+ Files []BatchFileResult

+ PersonaID string

+ Summary struct{ ... }

+ type Client struct

+ func NewClient(apiKey string, options ...ClientOption) *Client

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

+ func (c *Client) Get(ctx context.Context, path string, result interface{}) error

+ func (c *Client) GetBaseURL() string

+ func (c *Client) GetUserAgent() string

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

+ func (c *Client) Patch(ctx context.Context, path string, body interface{}, result interface{}) error

+ func (c *Client) Post(ctx context.Context, path string, body interface{}, result interface{}) error

+ func (c *Client) Put(ctx context.Context, path string, body interface{}, result interface{}) error

+ func (c *Client) SetTimeout(timeout time.Duration)

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

+ func (c *Client) WithContext(ctx context.Context) context.Context

+ type ClientOption func(*Client)

+ func WithBaseURL(baseURL string) ClientOption

+ func WithHTTPClient(httpClient *http.Client) ClientOption

+ func WithTimeout(timeout time.Duration) ClientOption

+ func WithUserAgent(userAgent string) ClientOption

+ type ErrorResponse struct

+ Code string

+ ErrorMsg string

+ Message string

+ func (e ErrorResponse) Error() string

+ type FileUpload struct

+ Filename string

+ Reader io.Reader

+ type GenerateClient struct

+ func NewGenerateClient(client *Client) *GenerateClient

+ func (g *GenerateClient) SimpleText(ctx context.Context, prompt string, personaID ...string) (string, error)

+ func (g *GenerateClient) Text(ctx context.Context, request *GenerateTextRequest) (*GenerateTextResponse, error)

+ type GenerateTextRequest struct

+ Context string

+ Document string

+ Formality int

+ Length int

+ Model string

+ PersonaID string

+ ProfileID string

+ ProfileIDs []string

+ Prompt string

+ ReadingLevel int

+ Selection string

+ SessionID string

+ Streaming *bool

+ type GenerateTextResponse struct

+ Model string

+ PersonaID string

+ ProfileID string

+ Text string

+ Tokens int

+ type ListOptions struct

+ Filter string

+ Limit int

+ Offset int

+ Sort string

+ type PaginatedResponse struct

+ HasMore bool

+ Items []T

+ Limit int

+ NextOffset int

+ Offset int

+ Total int

+ type Persona struct

+ LastModifiedAt time.Time

+ LastUsedAt time.Time

+ Name string

+ PersonaID string

+ PersonaType string

+ PromptDescription string

+ Status string

+ TrainingStatus string

+ VoiceEvolution bool

+ type PersonaListResponse struct

+ Personas []Persona

+ type PersonasClient struct

+ func NewPersonasClient(client *Client) *PersonasClient

+ func (p *PersonasClient) AssociateFiles(ctx context.Context, personaID string, fileIDs []string) error

+ func (p *PersonasClient) Create(ctx context.Context, persona *Persona) (*Persona, error)

+ func (p *PersonasClient) Delete(ctx context.Context, personaID string) error

+ func (p *PersonasClient) DisassociateFiles(ctx context.Context, personaID string, fileIDs []string) error

+ func (p *PersonasClient) Get(ctx context.Context, personaID string) (*Persona, error)

+ func (p *PersonasClient) List(ctx context.Context) ([]Persona, error)

+ func (p *PersonasClient) ListFiles(ctx context.Context, personaID string) ([]TrainingFile, error)

+ func (p *PersonasClient) Update(ctx context.Context, personaID string, persona *Persona) (*Persona, error)

+ type Profile struct

+ CreatedAt time.Time

+ Instructions string

+ Name string

+ PK string

+ ProfileID string

+ SK string

+ UpdatedAt time.Time

+ UserID string

+ type ProfileListResponse struct

+ Profiles []Profile

+ type ProfilesClient struct

+ func NewProfilesClient(client *Client) *ProfilesClient

+ func (p *ProfilesClient) AssociateWithPersona(ctx context.Context, profileID, personaID string) error

+ func (p *ProfilesClient) Create(ctx context.Context, profile *Profile) (*Profile, error)

+ func (p *ProfilesClient) Delete(ctx context.Context, profileID string) error

+ func (p *ProfilesClient) DisassociateFromPersona(ctx context.Context, profileID, personaID string) error

+ func (p *ProfilesClient) Get(ctx context.Context, profileID string) (*Profile, error)

+ func (p *ProfilesClient) GetPersonaProfiles(ctx context.Context, personaID string) ([]Profile, error)

+ func (p *ProfilesClient) List(ctx context.Context) ([]Profile, error)

+ func (p *ProfilesClient) Update(ctx context.Context, profileID string, profile *Profile) (*Profile, error)

+ type RateLimitError struct

+ RemainingRequests int

+ ResetTime time.Time

+ RetryAfterSeconds int

+ func (e *RateLimitError) Error() string

+ type ToneCloneClient struct

+ Generate *GenerateClient

+ Personas *PersonasClient

+ Profiles *ProfilesClient

+ Training *TrainingClient

+ func NewToneCloneClient(apiKey string, options ...ClientOption) *ToneCloneClient

+ func NewToneCloneClientFromConfig(baseURL, apiKey string, timeout time.Duration) *ToneCloneClient

+ func (tc *ToneCloneClient) Ping(ctx context.Context) error

+ func (tc *ToneCloneClient) ValidateConnection(ctx context.Context) error

+ func (tc *ToneCloneClient) WhoAmI(ctx context.Context) (*User, error)

+ type TrainingClient struct

+ func NewTrainingClient(client *Client) *TrainingClient

+ func (t *TrainingClient) CreateJob(ctx context.Context, personaID string, fileIDs []string) (*TrainingJob, error)

+ func (t *TrainingClient) CreatePersonaTrainingJob(ctx context.Context, personaID string) (*TrainingJob, error)

+ func (t *TrainingClient) DeleteFile(ctx context.Context, fileID string) error

+ func (t *TrainingClient) GetFile(ctx context.Context, fileID string) (*TrainingFile, error)

+ func (t *TrainingClient) GetJob(ctx context.Context, jobID string) (*TrainingJob, error)

+ func (t *TrainingClient) ListFiles(ctx context.Context) ([]TrainingFile, error)

+ func (t *TrainingClient) ListJobs(ctx context.Context) ([]TrainingJob, error)

+ func (t *TrainingClient) UploadFile(ctx context.Context, file io.Reader, filename string) (*TrainingFile, error)

+ func (t *TrainingClient) UploadFileBatch(ctx context.Context, files []FileUpload, personaID, source string) (*BatchUploadResponse, error)

+ func (t *TrainingClient) UploadText(ctx context.Context, request *UploadTextRequest) (*TrainingFile, error)

+ type TrainingFile struct

+ ContentType string

+ CreatedAt time.Time

+ FileID string

+ FileName string

+ FileSize int64

+ FileType string

+ ModifiedAt time.Time

+ PK string

+ PersonaID string

+ S3Key string

+ SK string

+ Source string

+ UsedForTraining bool

+ UserID string

+ type TrainingFileListResponse struct

+ Files []TrainingFile

+ type TrainingJob struct

+ BaseModel string

+ CreatedAt time.Time

+ FileIDs []string

+ FilesProcessed int

+ JobID string

+ OpenAIJobID string

+ OpenAIJobStatus string

+ PersonaID string

+ Status string

+ TotalFiles int

+ UpdatedAt time.Time

+ type UploadTextRequest struct

+ Content string

+ Filename string

+ Source string

+ type User struct

+ CreatedAt time.Time

+ Email string

+ Name string

+ Plan string

+ UserID string

+ type WritingSession struct

+ Content string

+ CreatedAt time.Time

+ LastModifiedAt time.Time

+ PersonaID string

+ ProfileID string

+ SessionID string

+ Status string

+ Title string

+ type WritingSessionListResponse struct

+ Sessions []WritingSession

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