What the Website Agent does and its plan
The Website Agent plan, one for each website. The price is on the plans page.
New to the API? Start with Getting started: the key, the address, the errors and the limits.
Getting started with this agent
These are done in the Fly app, signed in, because the API cannot do them.
- Choose the Website Agent plan. In the app: Billing.
- To work on the business's own site, connect it on the Website page, or with
web_cms_connect(a CMS) orweb_code_connect(a repository). The toolfly_connect_linkswithkindsset to["web"]gives the web connect page, which opens without signing in, for whoever manages the site. In the app: Website (/app/l/{location_id}/website). - Make a key on the AI assistants page and give it the Website Agent. In the app: AI assistants.
- Switch it on for the location with the
settingsop on the account page:changes.enabled_checks.web_agentset to true.
The working loop
- Find the location:
GET /v1/workspaceslists each location with itslocation_id;agents_onholds"web"where the Website Agent is switched on. - Read the agent's home:
POST /v1/tools/fly_homewithlocation_idandagent"web"answers the Website Agent's cards that need the owner (cards.needs_you), the ones in flight, its recent activity, rank and health. - Decide each card:
POST /v1/locations/{location_id}/ops/respondwith the card'sidasaction_idand adecision(approve,reject,done,dismiss,submit,changeorundo_dismiss). The toolfly_cardgives one card whole first. - Read its report:
POST /v1/tools/fly_reportwithagent"web"andfromandtodates (YYYY-MM-DD) answers the headline numbers, each section and the first rows of each table; the opweb_reporton the account page answers the report whole.
curl -X POST https://www.fly-social.com/api/v1/tools/fly_home \
-H "Authorization: Bearer fmk_your_key" \
-H "Content-Type: application/json" \
-d '{"location_id":"3f6c2b1e-8d4a-4c7e-9b2f-1a5d7e9c0b84","agent":"web"}'The Fly website
Ask for a Fly site, preview it, pick its look, send it photos, and read or put back its kept versions.
| Operation | Kind | What it does | Params |
|---|---|---|---|
website_build | Write | Ask for a Fly website. | {} |
website_preview_start | Write | Start that preview. | {} |
website_preview_get | Read | The private preview of a free site on the Web plan. | {} |
website_looks | Read | The looks a Web plan site may wear. | {} |
website_look_set | Write | Change the look. | { look: front-page | marquee | workshop | lantern | signboard } |
website_photos | Write | Send photos for the website. | { photos: [{ url }] } |
website_versions_list | Read | The website's kept versions. | {} |
website_version_preview | Read | One version's HTML. | { version_id } |
website_version_restore | Write | Put a version back. | { version_id } |
site_preview | Read | A screenshot of a page. | { url } |
Example: The site's kept versions
curl -X POST https://www.fly-social.com/api/v1/locations/3f6c2b1e-8d4a-4c7e-9b2f-1a5d7e9c0b84/ops/website_versions_list \
-H "Authorization: Bearer fmk_your_key" \
-H "Content-Type: application/json" \
-d '{}'The answer. kept, can_restore, site and versions, newest first: when, what changed in plain words, the pages it touched and who asked.
The website check and changes
The latest website check and its recommendations, a change asked for on the Fly site and how it is going, and the developer handover email.
| Operation | Kind | What it does | Params |
|---|---|---|---|
website_check | Read | The latest website check and its recommendations. | {} |
website_change | Write | Ask for a change on the Fly website (counts on the trial). | { instruction } |
website_change_status | Read | How a website change is going. | { action_id? } |
website_developer_get | Read | The developer handover email. | {} |
website_developer_send | Write | Send the developer handover email (the website check card's id), or an Ads tracking tag card's tags to the web developer (ads_pixel_install, ads_conversion_tag; ADS-DEVMAIL-1). | { action_id, emails: string[], note?, auto_send?: boolean } |
Example: The latest website check
curl -X POST https://www.fly-social.com/api/v1/locations/3f6c2b1e-8d4a-4c7e-9b2f-1a5d7e9c0b84/ops/website_check \
-H "Authorization: Bearer fmk_your_key" \
-H "Content-Type: application/json" \
-d '{}'The answer. check (the score, each part, the title, the summary lines and the site health), or null when no check has run yet, the open card and the recommendations.
Domains
The domains of the business: whether a name is free, the names proposed, and pointing the owner's own domain at the site through its provider or by DNS steps.
| Operation | Kind | What it does | Params |
|---|---|---|---|
domain_state | Read | Domains: the site, the plan, the names held. | {} |
domain_propose | Read | Domain names proposed for the business. | { page? } |
domain_check | Read | Is a domain available. | { name } |
domain_contact | Read | The contact fields a domain order needs. | { name } |
domain_transfer_code | Write | The transfer code of a domain Fly bought. | { domain } |
website_domain_setup | Write | The steps page for the owner's own domain. | { domain? } |
website_domain_connect | Write | Connect a domain through its provider. | { domain, method: domain_connect | entri, return_path } |
website_domain_instructions | Write | Email the DNS steps for a domain. | { domain, emails: string[] } |
website_domain_watch | Write | Watch a domain until it points at the site. | { domain, method?: domain_connect | entri } |
Example: Is a domain free
curl -X POST https://www.fly-social.com/api/v1/locations/3f6c2b1e-8d4a-4c7e-9b2f-1a5d7e9c0b84/ops/domain_check \
-H "Authorization: Bearer fmk_your_key" \
-H "Content-Type: application/json" \
-d '{"name":"yourbusinessname.com"}'The answer. state (available, taken or unsupported) and domain, with up to five close names that are free when it is taken.
The owner's own site
Connect the owner's own site (a CMS such as WordPress, or a custom-built site's repository), read its pages, and ask for a change: the agent reads the page, makes only the change asked, writes it back and keeps Undo.
| Operation | Kind | What it does | Params |
|---|---|---|---|
web_cms_kinds | Read | The CMS kinds the Website Agent can connect. | {} |
web_cms_connect | Write | Connect the owner's own site (a CMS; Blogger signs in through Google in the app). | { kind: wordpress | shopify | wix | webflow | joomla | drupal | hubspot | ghost | duda | bigcommerce | magento | prestashop | contentful | strapi, fields: { site_url, login?, secret, ... } } |
web_cms_status | Read | The owner's own site connection. | {} |
web_cms_disconnect | Write | Disconnect the owner's own site. | {} |
web_cms_pages | Read | The pages of the owner's own connected site (its own pages, not its posts), with their ids and addresses; unsupported where the kind lists none. | {} |
web_cms_page_get | Read | One page of the owner's own connected site as the site keeps it: its HTML (cut at 60 KB), title, excerpt and search title. | { remote_id? | url? } |
web_cms_change | Write | Change content on the owner's own connected site (WordPress, Ghost, Drupal, Magento, PrestaShop): the agent reads the page, makes only the change asked, writes it back and keeps Undo. | { instruction, page?: { remote_id? | url? } } |
web_cms_change_status | Read | How the changes asked for on the owner's own site are going: the newest 10, or one, with what was done and whether Undo is offered. | { action_id? } |
web_code_connect | Write | Connect a custom-built site's repository. | { repo, access_token } |
web_code_status | Read | A custom-built site's GitHub connection. | {} |
web_code_disconnect | Write | Disconnect the repository. | {} |
Example: The own site's connection
curl -X POST https://www.fly-social.com/api/v1/locations/3f6c2b1e-8d4a-4c7e-9b2f-1a5d7e9c0b84/ops/web_cms_status \
-H "Authorization: Bearer fmk_your_key" \
-H "Content-Type: application/json" \
-d '{}'The answer. connected, kind, name, site_url, status, verified_at and last_error, the connection as it stands.
Articles
The articles on the Fly site and the owner's own: topics and articles the agent writes, the owner's own article prepared and published, and the questions the agent asks when an article is short of material.
| Operation | Kind | What it does | Params |
|---|---|---|---|
blogs_list | Read | The Fly site's articles: published, scheduled, drafts. | {} |
blog_topics | Write | Article topics for the business (AI). | {} |
blog_write | Write | Write an article on a topic (AI). | { topic } |
blog_save | Write | Save an article, now or for a day. | { id?, title, body, at?, ai? } |
blog_unschedule | Write | Take an article off its day. | { id } |
article_another | Write | Suggest another article on an article card. | { action_id } |
web_articles_list | Read | The articles the Website Agent published, and the ones scheduled. | {} |
web_article_prepare | Write | Prepare the owner's own article for publishing. | { title, body, search?, picture_url?: url | none, seo_title?, description?, target?: fly | cms, polish?: boolean } |
web_article_publish | Write | Publish it, now or at a time: send the same words and choices again (the prepared answer is not read back). | { title, body, search?, seo_title?, description?, picture_url?: url | none, target?: fly | cms, kind?: own | polished, source?: written | upload, file_name?, when?: ISO | now } |
web_article_cancel | Write | Cancel a scheduled article. | { action_id } |
web_interview_get | Read | The questions for an article short of material. | { interview_id? } |
web_interview_answer | Write | Answer them (no interview_id: the newest open one). | { interview_id?, answers: [{ question_id, text, via?: typed | voice }], photos?: url[], allow_quote?: boolean, allow_name?: boolean, owner_name? } |
Example: The Fly site's articles
curl -X POST https://www.fly-social.com/api/v1/locations/3f6c2b1e-8d4a-4c7e-9b2f-1a5d7e9c0b84/ops/blogs_list \
-H "Authorization: Bearer fmk_your_key" \
-H "Content-Type: application/json" \
-d '{}'The answer. site (the Fly site, or null), articles newest first (live, drafts waiting, scheduled, and the ones that could not go live in the last 30 days) and next_article_at.
Search Console and Google Analytics
The owner's own Google Search Console and Google Analytics: connecting them, picking the property, and the readings of each source.
| Operation | Kind | What it does | Params |
|---|---|---|---|
web_google_state | Read | The owner's own Google (Search Console, Analytics) connection. | {} |
web_google_connect_start | Write | Start connecting the owner's Google. | { kind: gsc | ga4 } |
web_google_connect_status | Read | Where that connection stands; with_resources lists the properties web_google_pick takes. | { kind: gsc | ga4, with_resources?: boolean } |
web_google_pick | Write | Pick the property or stream. | { kind: gsc | ga4, resource_ref } |
web_google_disconnect | Write | Disconnect the owner's Google. | { kind: gsc | ga4 } |
web_insights_get | Read | Search Console and GA4 readings for the sites. | {} |
web_insights_source_add | Write | Add a Search Console or GA4 source. | { kind: gsc | ga4, property, site? } |
web_insights_source_test | Write | Test a source. | { source_id } |
web_insights_source_remove | Write | Remove a source. | { source_id } |
Example: What is connected
curl -X POST https://www.fly-social.com/api/v1/locations/3f6c2b1e-8d4a-4c7e-9b2f-1a5d7e9c0b84/ops/web_google_state \
-H "Authorization: Bearer fmk_your_key" \
-H "Content-Type: application/json" \
-d '{}'The answer. signed_in, site and connections with gsc and ga4: what is connected and which property each reads.
Search rank and what the agent did
Where the website ranks on Google week by week, the searches tracked, what the agent changed for search and the result 28 days on, the visitors and the market.
| Operation | Kind | What it does | Params |
|---|---|---|---|
web_rank_get | Read | Where the website ranks on Google, by week. | {} |
web_rank_keywords_set | Write | Add searches to track for the website (ten at a time at most) or remove them by their ids from web_rank_get. | { add?: string[], remove?: keyword_id[] } |
web_search_work | Read | What the agent did with the weekly search read. | {} |
web_seo_changes | Read | What the agent changed for search and the 28-day result. | {} |
web_visitors_get | Read | The Visitors report (Fly's own analytics). | { range?: 7 | 28 | 90 } |
web_market_get | Read | The market and the data the agent uses. | { month?: YYYY-MM } |
Example: Where the site ranks
curl -X POST https://www.fly-social.com/api/v1/locations/3f6c2b1e-8d4a-4c7e-9b2f-1a5d7e9c0b84/ops/web_rank_get \
-H "Authorization: Bearer fmk_your_key" \
-H "Content-Type: application/json" \
-d '{}'The answer. keywords (each search with its ranks week by week for the Fly site and the own site), suggestions, the week and the plan.
AI search visibility
How often AI answers name the business: the overview, the prompts tracked and their answers over time, who AI answers name beside the business, the sources they cite and the month's plan.
| Operation | Kind | What it does | Params |
|---|---|---|---|
web_ai_overview | Read | AI search visibility: the overview. | { range?: 4w | 12w | 26w | 52w } |
web_ai_prompts | Read | The AI prompts tracked. | { status?: tracked | paused | retired | all, source?: proposed | owner | import | discovered, engine?: chatgpt | perplexity | gemini | google_ai | copilot, q?, sort?: volume | share | newest | az } |
web_ai_prompt_get | Read | One prompt's answers over time. | { prompt_id, range?: 4w | 12w | 26w | 52w } |
web_ai_prompt_save | Write | Add, change, pin or remove a prompt. | { prompt: { id?, text?, active?, pinned?, remove? } } |
web_ai_prompts_import | Write | Import prompts (a preview unless dry_run is false). | { items: string[], dry_run?: boolean } |
web_ai_competitors | Read | Who AI answers name beside the business. | { range?: 4w | 12w | 26w | 52w } |
web_ai_sources | Read | The sources AI answers cite. | { range?: 4w | 12w | 26w | 52w } |
web_ai_plan | Read | The month's AI visibility plan. | { month?: YYYY-MM } |
web_ai_todo_section_done | Write | Mark a plan section done. | { action_id, plan_id } |
web_ai_discovery_get | Read | The month's AI search read. | { month?: YYYY-MM } |
ai_visibility_results | Read | The week's answers on four AI engines. | { week? } |
ai_visibility_propose | Write | Propose AI questions to track (AI). | {} |
ai_visibility_save | Write | Save the questions tracked. | { prompts: [{ id?, text, active }] } |
Example: The AI search overview
curl -X POST https://www.fly-social.com/api/v1/locations/3f6c2b1e-8d4a-4c7e-9b2f-1a5d7e9c0b84/ops/web_ai_overview \
-H "Authorization: Bearer fmk_your_key" \
-H "Content-Type: application/json" \
-d '{"range":"12w"}'The answer. range, engines, weeks (how many answers, how many named the business and the share, per engine), headline and competitors.