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

client

package

Go to main page

Versions in this module

v1

v1.0.3

Jul 29, 2026

Changes in this version

+ type DebugInfo struct

+ Elapsed time.Duration

+ Method string

+ RateLimitLimit string

+ RateLimitRemaining string

+ RateLimitReset time.Time

+ Status int

+ TraceID string

+ URL string

type Option

+ func WithDebug(sink func(DebugInfo)) Option

v1.0.2

Jul 28, 2026

v1.0.1

Jul 14, 2026

v1.0.0

Jun 16, 2026

Changes in this version

+ func ParseSSE(r io.Reader, fn func(Event) error) error

+ type APIError struct

+ Message string

+ StatusCode int

+ func (e *APIError) Error() string

+ type AutomateInputFieldValue struct

+ Ref string

+ Value any

+ type AutomateInputRequest struct

+ Cancelled bool

+ Fields []AutomateInputFieldValue

+ type AutomateRequest struct

+ Data any

+ GeoTarget *GeoTarget

+ Guardrails string

+ Interactive bool

+ MaxIterations int

+ MaxValidationAttempts int

+ Task string

+ URL string

+ type Citation struct

+ Number int

+ Title string

+ URL string

+ type Client struct

+ func New(apiKey, baseURL string, opts ...Option) *Client

+ func (c *Client) Automate(ctx context.Context, req AutomateRequest, fn func(Event) error) error

+ func (c *Client) AutomateInput(ctx context.Context, requestID string, req AutomateInputRequest) error

+ func (c *Client) ExtractJSON(ctx context.Context, req ExtractJSONRequest) (json.RawMessage, error)

+ func (c *Client) ExtractMarkdown(ctx context.Context, req ExtractMarkdownRequest) (ExtractMarkdownResponse, error)

+ func (c *Client) GenerateJSON(ctx context.Context, req GenerateJSONRequest) (json.RawMessage, error)

+ func (c *Client) Research(ctx context.Context, req ResearchRequest, fn func(Event) error) error

+ type Effort string

+ const EffortMax

+ const EffortMin

+ const EffortStandard

+ type Event struct

+ Data json.RawMessage

+ Name string

+ func (e Event) DataString() string

+ func (e Event) Decode(v any) error

+ type ExtractJSONRequest struct

+ Effort Effort

+ GeoTarget *GeoTarget

+ JSONSchema json.RawMessage

+ NoCache bool

+ URL string

+ type ExtractMarkdownRequest struct

+ Effort Effort

+ GeoTarget *GeoTarget

+ Metadata bool

+ NoCache bool

+ URL string

+ type ExtractMarkdownResponse struct

+ Content string

+ Metadata *Metadata

+ URL string

+ type GenerateJSONRequest struct

+ Effort Effort

+ GeoTarget *GeoTarget

+ Instructions string

+ JSONSchema json.RawMessage

+ NoCache bool

+ URL string

+ type GeoTarget struct

+ Country string

+ type Metadata struct

+ Author string

+ CreatedAt string

+ Creator string

+ Description string

+ Image string

+ Keywords []string

+ ModifiedAt string

+ PDFVersion string

+ PageCount int

+ Producer string

+ Publisher string

+ SiteName string

+ Subject string

+ Title string

+ Type string

+ URL string

+ type Option func(*Client)

+ func WithHTTPClient(h *http.Client) Option

+ func WithTimeout(d time.Duration) Option

+ type ResearchMode string

+ const ResearchBalanced

+ const ResearchFast

+ type ResearchRequest struct

+ FetchTimeout int

+ Mode ResearchMode

+ NoCache bool

+ Query string