{"openapi":"3.1.0","info":{"title":"Vyavsay API","description":"Build and manage websites for Indian businesses from their Google reviews, and check schemes and filing dates. Authenticate with an `Api-Key` header (make keys at vyavsay.ai/developers).","version":"1"},"servers":[{"url":"https://vyavsay.ai/api"}],"paths":{"/v1/account":{"get":{"tags":["v1"],"summary":"Account","description":"Your account id, plan, what is left of it this period, and what can\nbe bought. An agency gives `account_id` to Vyavsay to be allowlisted.","operationId":"account_v1_account_get","parameters":[{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Account V1 Account Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/checkout":{"post":{"tags":["v1"],"summary":"Checkout","description":"A link for the account's owner to open and pay in the browser. No\npayment is started here: paying needs the person, not the agent.","operationId":"checkout_v1_checkout_post","parameters":[{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"},"title":"Response Checkout V1 Checkout Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/capabilities":{"get":{"tags":["v1"],"summary":"Capabilities","description":"What Vyavsay can build and what you have left, so a client never\nhard-codes it: site tiers, themes, pages, languages, templates, every\nsection's content shape (`sections`, for `POST /businesses/{id}/sites`),\nwhich features are live, your plan and remaining allowances, and the\nper-hour/per-day limits on agency actions. Works on any plan.","operationId":"capabilities_v1_capabilities_get","parameters":[{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Capabilities V1 Capabilities Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clients":{"post":{"tags":["v1"],"summary":"Create Client","description":"For agencies: a business for a client who has not signed up yet. You\nown it until they claim it. Pass `external_ref` (your own id for the\nclient) or an `Idempotency-Key` header: a retry returns the same client\n(200) instead of a second one (201).","operationId":"create_client_v1_clients_post","parameters":[{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["v1"],"summary":"List Clients","description":"For agencies: your clients, oldest first, with status (unclaimed,\nclaimed, verified, live) and their latest site and generation. Page\nwith `after` = the previous response's `next`.","operationId":"list_clients_v1_clients_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clients/{business_id}/claim-invites":{"post":{"tags":["v1"],"summary":"Create Claim Invite","description":"For agencies: a one-time link (valid 14 days) for the client to claim\nthe business you made for them. Send it yourself; it replaces any\nearlier link. The client sees `agency_name` before accepting.","operationId":"create_claim_invite_v1_clients__business_id__claim_invites_post","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteBody"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/claim-invites/{invite_id}":{"delete":{"tags":["v1"],"summary":"Revoke Claim Invite","operationId":"revoke_claim_invite_v1_claim_invites__invite_id__delete","parameters":[{"name":"invite_id","in":"path","required":true,"schema":{"type":"string","title":"Invite Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clients/{business_id}/manager":{"delete":{"tags":["v1"],"summary":"Leave Client","description":"For agencies: stop managing a claimed client. Access ends at once.","operationId":"leave_client_v1_clients__business_id__manager_delete","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clients/{business_id}":{"delete":{"tags":["v1"],"summary":"Delete Client","description":"For agencies: delete a client nobody has claimed, with its drafts and\nphotos (e.g. after `preview.removed_by_business`). A claimed client is\nits owner's to delete: leave it with `DELETE /clients/{id}/manager`.","operationId":"delete_client_v1_clients__business_id__delete","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clients/{business_id}/page":{"get":{"tags":["v1"],"summary":"Get Client Page","description":"The client's free page (`vyavsay.ai/b/<slug>`) as saved, or a draft\nto start from (`saved: false`).","operationId":"get_client_page_v1_clients__business_id__page_get","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["v1"],"summary":"Put Client Page","description":"Save the free page as a draft. `published` must stay false: only\nthe owner publishes it, after claiming, and once it is live only the\nowner edits it.","operationId":"put_client_page_v1_clients__business_id__page_put","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessPageBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/clients/{business_id}/plan-link":{"get":{"tags":["v1"],"summary":"Plan Link","description":"A link for the client to buy their own plan, which is what keeps the\nwebsite you built online. It grants nothing by itself: the client opens\nit signed in as themselves and pays. `ready` is false until they have\nclaimed the business (until then they have no account to pay from).","operationId":"plan_link_v1_clients__business_id__plan_link_get","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"plan","in":"query","required":false,"schema":{"type":"string","default":"pro","title":"Plan"}},{"name":"period","in":"query","required":false,"schema":{"enum":["monthly","yearly"],"type":"string","default":"monthly","title":"Period"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Plan Link V1 Clients  Business Id  Plan Link Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/events":{"get":{"tags":["v1"],"summary":"Events","description":"For agencies: what happened to your clients, oldest first, after the\ncursor `after` (the previous response's `next`). Poll it. Delivered at\nleast once: dedupe on `id`. Types: client.created, client.deleted,\ngeneration.ready, generation.failed, preview.viewed, preview.expired,\npreview.removed_by_business (treat as a no), claim.invite_opened,\nclaim.accepted, claim.declined, listing.verified, site.published,\nsite.unpublished, coverage.changed (the client's plan), manager.removed.\nKept 90 days.","operationId":"events_v1_events_get","parameters":[{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sites/{slug}/preview-shares":{"post":{"tags":["v1"],"summary":"Create Preview Share","description":"A private link (`url`, shown once) to a draft website, for the\nbusiness to see before it is published: `vyavsay.ai/p/<token>`, valid\n`days` (default 14, at most 30). Only for a site made with\n`POST /businesses/{id}/sites` (written, not built from Google). The page\nnames the business and `made_by`, says it is not published, has no\nforms, and lets the business remove it without signing in.","operationId":"create_preview_share_v1_sites__slug__preview_shares_post","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewShareBody"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["v1"],"summary":"List Preview Shares","operationId":"list_preview_shares_v1_sites__slug__preview_shares_get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/preview-shares/{share_id}":{"get":{"tags":["v1"],"summary":"Get Preview Share","description":"`views` (people, once a day each), `status` (live, expired, revoked,\nor removed: the business ended it, treat that as a no).","operationId":"get_preview_share_v1_preview_shares__share_id__get","parameters":[{"name":"share_id","in":"path","required":true,"schema":{"type":"string","title":"Share Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["v1"],"summary":"Revoke Preview Share","operationId":"revoke_preview_share_v1_preview_shares__share_id__delete","parameters":[{"name":"share_id","in":"path","required":true,"schema":{"type":"string","title":"Share Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/businesses":{"get":{"tags":["v1"],"summary":"List Businesses","operationId":"list_businesses_v1_businesses_get","parameters":[{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["v1"],"summary":"Create Business","operationId":"create_business_v1_businesses_post","parameters":[{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/businesses/{business_id}":{"get":{"tags":["v1"],"summary":"Get Business","operationId":"get_business_v1_businesses__business_id__get","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["v1"],"summary":"Update Business","operationId":"update_business_v1_businesses__business_id__patch","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/businesses/{business_id}/insights":{"get":{"tags":["v1"],"summary":"Review Insights","description":"The latest review analysis for the business's site: what customers\npraise and complain about, each line with the reviews behind it.","operationId":"review_insights_v1_businesses__business_id__insights_get","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/businesses/{business_id}/generations":{"post":{"tags":["v1"],"summary":"Generate Site","description":"Build a site from the business's Google Maps link. Returns at once;\npoll `GET /v1/generations/{id}` until `status` is `ready` or `failed`.","operationId":"generate_site_v1_businesses__business_id__generations_post","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationBody"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/businesses/{business_id}/sites":{"post":{"tags":["v1"],"summary":"Compose Site","description":"Create a publishable draft site from content you supply (sections:\nhero, about, offerings, location, faq, ...), for a business with no\nreviews to build from. No testimonials, ratings or claims of rank.\nPass the listing's Google place_id so the owner can verify and publish.","operationId":"compose_site_v1_businesses__business_id__sites_post","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComposeBody"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/generations/{generation_id}":{"get":{"tags":["v1"],"summary":"Get Generation","operationId":"get_generation_v1_generations__generation_id__get","parameters":[{"name":"generation_id","in":"path","required":true,"schema":{"type":"string","title":"Generation Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sites":{"get":{"tags":["v1"],"summary":"List Sites","operationId":"list_sites_v1_sites_get","parameters":[{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response List Sites V1 Sites Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sites/{slug}":{"get":{"tags":["v1"],"summary":"Get Site","description":"The site as it would be published: settings and visible sections.","operationId":"get_site_v1_sites__slug__get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Site V1 Sites  Slug  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["v1"],"summary":"Delete Site","operationId":"delete_site_v1_sites__slug__delete","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sites/{slug}/export":{"get":{"tags":["v1"],"summary":"Export Site","operationId":"export_site_v1_sites__slug__export_get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"format","in":"query","required":false,"schema":{"enum":["html","md","json"],"type":"string","default":"html","title":"Format"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sites/{slug}/sections":{"get":{"tags":["v1"],"summary":"List Sections","operationId":"list_sections_v1_sites__slug__sections_get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sites/{slug}/sections/{section_id}":{"get":{"tags":["v1"],"summary":"Get Section","operationId":"get_section_v1_sites__slug__sections__section_id__get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"section_id","in":"path","required":true,"schema":{"type":"integer","title":"Section Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["v1"],"summary":"Update Section","description":"Replace a section's content, show or hide it, set its photos\n(upload ids, in order) or its `layout` (`GET /v1/capabilities` →\n`section_layouts`). Content is cleaned to the section's shape.","operationId":"update_section_v1_sites__slug__sections__section_id__patch","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"section_id","in":"path","required":true,"schema":{"type":"integer","title":"Section Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SectionPatch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sites/{slug}/settings":{"patch":{"tags":["v1"],"summary":"Update Site Settings","description":"The site's style (`theme`, from `GET /v1/capabilities` → `site.themes`\nfor its tier), its layout choices (`design`: any of `site.design`'s\nkeys; the ones left out keep their value), and on Premium the brand\ncolour (`brand_color`, #rrggbb) and logo (`logo_upload_id`, or\n`clear_logo`).","operationId":"update_site_settings_v1_sites__slug__settings_patch","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteSettings"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sites/{slug}/uploads":{"post":{"tags":["v1"],"summary":"Upload Image","description":"A JPEG, PNG or WebP. Re-encoded from its pixels, so location data\nand other metadata never survive.","operationId":"upload_image_v1_sites__slug__uploads_post","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_image_v1_sites__slug__uploads_post"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["v1"],"summary":"List Uploads","operationId":"list_uploads_v1_sites__slug__uploads_get","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/uploads/{upload_id}":{"delete":{"tags":["v1"],"summary":"Delete Upload","operationId":"delete_upload_v1_uploads__upload_id__delete","parameters":[{"name":"upload_id","in":"path","required":true,"schema":{"type":"string","title":"Upload Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/businesses/{business_id}/domain":{"get":{"tags":["v1"],"summary":"Get Domain","operationId":"get_domain_v1_businesses__business_id__domain_get","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["v1"],"summary":"Add Domain","description":"Connect `www.yourdomain.in`; the answer says which DNS record to add.","operationId":"add_domain_v1_businesses__business_id__domain_post","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainBody"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["v1"],"summary":"Remove Domain","operationId":"remove_domain_v1_businesses__business_id__domain_delete","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/businesses/{business_id}/domain/check":{"post":{"tags":["v1"],"summary":"Verify Domain","operationId":"verify_domain_v1_businesses__business_id__domain_check_post","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/schemes/check":{"post":{"tags":["v1"],"summary":"Check Schemes","description":"MUDRA, PMEGP and CGTMSE eligibility, from rules in code with the\ndate they were last checked against the official source. Stand-Up\nIndia is answered too, as closed to new loans since 31 March 2025.","operationId":"check_schemes_v1_schemes_check_post","parameters":[{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemeCheckBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/calendar":{"post":{"tags":["v1"],"summary":"Filing Calendar","description":"GST, TDS, PF, ESI, advance tax and ITR due dates for this profile.","operationId":"filing_calendar_v1_calendar_post","parameters":[{"name":"x-vyavsay-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Vyavsay-Api-Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_upload_image_v1_sites__slug__uploads_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_image_v1_sites__slug__uploads_post"},"BusinessCreate":{"properties":{"state":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"State"},"city":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"City"},"entity_type":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Entity Type"},"sector":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Sector"},"industry":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Industry"},"business_stage":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Business Stage"},"years_operating":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Years Operating"},"annual_turnover":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Annual Turnover"},"employee_count":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Employee Count"},"collateral_available":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Collateral Available"},"credit_score_band":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Credit Score Band"},"founder_category":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Founder Category"},"gst_registered":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Gst Registered"},"udyam_registered":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Udyam Registered"},"current_registrations":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Current Registrations"},"sells_interstate":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Sells Interstate"},"sells_online":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Sells Online"},"exports":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Exports"},"name":{"type":"string","maxLength":120,"minLength":1,"title":"Name"}},"type":"object","required":["name"],"title":"BusinessCreate"},"BusinessPageBody":{"properties":{"slug":{"type":"string","maxLength":200,"title":"Slug"},"published":{"type":"boolean","title":"Published","default":false},"display_name":{"type":"string","maxLength":200,"title":"Display Name"},"tagline":{"anyOf":[{"type":"string","maxLength":400},{"type":"null"}],"title":"Tagline"},"description":{"anyOf":[{"type":"string","maxLength":4000},{"type":"null"}],"title":"Description"},"area":{"anyOf":[{"type":"string","maxLength":400},{"type":"null"}],"title":"Area"},"whatsapp":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Whatsapp"},"phone":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Email"},"hours":{"anyOf":[{"type":"string","maxLength":400},{"type":"null"}],"title":"Hours"},"offerings":{"items":{"additionalProperties":true,"type":"object"},"type":"array","maxItems":50,"title":"Offerings"},"theme":{"type":"string","maxLength":20,"title":"Theme","default":"clean"},"address":{"anyOf":[{"type":"string","maxLength":600},{"type":"null"}],"title":"Address"},"social":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array","maxItems":20},{"type":"null"}],"title":"Social"}},"type":"object","required":["slug","display_name"],"title":"BusinessPageBody","description":"The owner's page, as the editor submits it. Lengths are capped again\nin `business_pages`; these bounds just refuse an absurd body early."},"BusinessUpdate":{"properties":{"state":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"State"},"city":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"City"},"entity_type":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Entity Type"},"sector":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Sector"},"industry":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Industry"},"business_stage":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Business Stage"},"years_operating":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Years Operating"},"annual_turnover":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Annual Turnover"},"employee_count":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Employee Count"},"collateral_available":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Collateral Available"},"credit_score_band":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Credit Score Band"},"founder_category":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Founder Category"},"gst_registered":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Gst Registered"},"udyam_registered":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Udyam Registered"},"current_registrations":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Current Registrations"},"sells_interstate":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Sells Interstate"},"sells_online":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Sells Online"},"exports":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Exports"},"name":{"anyOf":[{"type":"string","maxLength":120,"minLength":1},{"type":"null"}],"title":"Name"}},"type":"object","title":"BusinessUpdate"},"CalendarBody":{"properties":{"gst":{"type":"string","maxLength":16,"title":"Gst","default":"none"},"state":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"State"},"itr":{"type":"string","maxLength":16,"title":"Itr","default":"business"},"advance_tax":{"type":"boolean","title":"Advance Tax","default":false},"deducts_tds":{"type":"boolean","title":"Deducts Tds","default":false},"pays_pf":{"type":"boolean","title":"Pays Pf","default":false},"pays_esi":{"type":"boolean","title":"Pays Esi","default":false},"deducts_pt":{"type":"boolean","title":"Deducts Pt","default":false},"pays_own_pt":{"type":"boolean","title":"Pays Own Pt","default":false},"pt_monthly":{"type":"boolean","title":"Pt Monthly","default":false},"months":{"type":"integer","maximum":12,"minimum":1,"title":"Months","default":3}},"type":"object","title":"CalendarBody"},"CheckoutBody":{"properties":{"plan":{"type":"string","maxLength":20,"title":"Plan"},"period":{"type":"string","enum":["monthly","yearly"],"title":"Period","default":"monthly"}},"type":"object","required":["plan"],"title":"CheckoutBody"},"ClientBody":{"properties":{"name":{"type":"string","maxLength":120,"minLength":1,"title":"Name"},"city":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"State"},"category":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"title":"Category"},"place_id":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}],"title":"Place Id"},"external_ref":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"External Ref"}},"type":"object","required":["name"],"title":"ClientBody"},"ComposeBody":{"properties":{"tier":{"type":"string","maxLength":20,"title":"Tier","default":"medium"},"template":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Template"},"theme":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Theme"},"language":{"type":"string","maxLength":20,"title":"Language","default":"en"},"display_name":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Display Name"},"place_id":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}],"title":"Place Id"},"whatsapp":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Whatsapp"},"phone":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Phone"},"email":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Email"},"sections":{"items":{"additionalProperties":true,"type":"object"},"type":"array","maxItems":40,"title":"Sections"}},"type":"object","required":["sections"],"title":"ComposeBody","description":"A site from supplied content (`site_compose.py`)."},"DomainBody":{"properties":{"hostname":{"type":"string","maxLength":260,"minLength":4,"title":"Hostname"}},"type":"object","required":["hostname"],"title":"DomainBody"},"GenerationBody":{"properties":{"link":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Link"},"source":{"type":"string","enum":["google_places","google_business_profile"],"title":"Source","default":"google_places"},"tier":{"type":"string","title":"Tier","default":"medium"},"template":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Template"},"language":{"type":"string","maxLength":20,"title":"Language","default":"en"}},"type":"object","title":"GenerationBody","description":"`link` is a Google Maps link (a preview that cannot be published), or\nleave it out with `source: \"google_business_profile\"` to build from the\nconnected Business Profile (`gbp.py`)."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InviteBody":{"properties":{"agency_name":{"type":"string","maxLength":80,"minLength":2,"title":"Agency Name"}},"type":"object","required":["agency_name"],"title":"InviteBody"},"PreviewShareBody":{"properties":{"made_by":{"type":"string","maxLength":80,"minLength":2,"title":"Made By"},"days":{"anyOf":[{"type":"integer","maximum":30,"minimum":1},{"type":"null"}],"title":"Days"}},"type":"object","required":["made_by"],"title":"PreviewShareBody"},"SchemeCheckBody":{"properties":{"amount":{"type":"string","maxLength":40,"minLength":1,"title":"Amount"},"sector":{"type":"string","maxLength":32,"title":"Sector"},"is_new":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is New"},"categories":{"items":{"type":"string"},"type":"array","maxItems":8,"title":"Categories"},"rural":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rural"},"passed_class_8":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Passed Class 8"},"repaid_tarun":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Repaid Tarun"},"in_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"In Default"},"had_other_subsidy":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Had Other Subsidy"},"annual_turnover":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Annual Turnover"}},"type":"object","required":["amount","sector"],"title":"SchemeCheckBody"},"SectionPatch":{"properties":{"content":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Content"},"visible":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Visible"},"images":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":24},{"type":"null"}],"title":"Images"},"layout":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Layout"}},"type":"object","title":"SectionPatch"},"SiteSettings":{"properties":{"theme":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Theme"},"brand_color":{"anyOf":[{"type":"string","maxLength":7},{"type":"null"}],"title":"Brand Color"},"logo_upload_id":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Logo Upload Id"},"clear_logo":{"type":"boolean","title":"Clear Logo","default":false},"design":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object","maxProperties":20},{"type":"null"}],"title":"Design"}},"type":"object","title":"SiteSettings"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}