GetV1ResearchesResearchidEmbedsTypeResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/hifrank-ai/json-schema/hifrank-ai-get-v1-researches-researchid-embeds-type-response-schema.json",
  "title": "GetV1ResearchesResearchidEmbedsTypeResponse",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/hifrank-ai-openapi-generated.yml#/components/schemas/GetV1ResearchesResearchidEmbedsTypeResponse",
  "type": "object",
  "properties": {
    "embedId": {
      "type": "string",
      "description": "This format's key; it only works with this format's snippet."
    },
    "settings": {
      "type": "object",
      "description": "Intro copy, button labels, launcher position (floating only), identity mode and fields, consent options and appearance."
    },
    "snippet": {
      "type": "string",
      "description": "The install snippet."
    },
    "install": {
      "type": "object",
      "description": "Where the snippet goes, what the page needs, what single-page apps must do, the identity placeholders to replace, and a link to the setup guide."
    },
    "runnable": {
      "type": "boolean",
      "description": "Whether participants can take an interview once it's installed."
    },
    "blockers": {
      "type": "array",
      "description": "What stops them: research_draft, research_stopped, embed_revoked, widget_off, no_protected_domain, out_of_credits."
    }
  }
}