firecrawl

Documentation

Index

• type Client
  • func NewClient() (ret *Client)
  • func (c *Client) IsConfigured() bool
  • func (c *Client) Search(query string) (ret string, err error)

Types

type Client

type Client struct {
	*plugins.PluginBase
	ApiKey *plugins.SetupQuestion
}

func NewClient

func NewClient() (ret *Client)

func (*Client) IsConfigured

func (c *Client) IsConfigured() bool

IsConfigured reports whether an API key is set; the key is optional during setup.

func (*Client) Search

func (c *Client) Search(query string) (ret string, err error)

Search returns the top web results for query as markdown, one section per result, with the page content of each result when Firecrawl could scrape it.