Create Clipform
clipform_create_form
Create a new Clipform (interactive video-style form). Returns a viewer URL and form ID. When connected via an authenticated MCP client (e.g. claude.ai), the form lands directly in the user's workspace. Anonymous sessions build into a temporary account of their own: guests connected through a chat app (ChatGPT, Claude) get a form that goes live, takes up to 3 responses and goes offline after 7 days unless the user signs up, with steps that need an account (such as payments and uploads) switched off until sign-up; other anonymous channels stay private previews. Some results also include a one-time claim URL that signs the user into that account; relay it when present.
If the user hasn't said what to build yet, offer to build their first form and suggest starting points: quiz, survey, interview, testimonial, application, booking, client intake, lead capture, or something else.
Node types (omit config to use defaults where shown):
- choice: Single or multiple choice node with predefined options (supports options array). Config: choice ({enable_branching, show_answer_feedback, record_scores}), selection_mode ("single"|"multiple", default: "single"), allow_text_response (boolean, default: false), randomise_options (boolean, default: false), show_option_count (boolean, default: false), option_display ("list"|"letters", default: "list"). Defaults: {"selection_mode":"single","choice":{"enable_branching":false},"randomise_options":false,"show_option_count":false,"option_display":"list"}
- open: Free-form text responses from users. Config: formats (array of {format, order}), max_recording_seconds (number, default: 120). Defaults: {"formats":[{"order":0,"format":"text"},{"order":1,"format":"audio"},{"order":2,"format":"video"}]}
- booking: Let respondents book a meeting on a connected Calendly account without leaving the form. Config: provider ("calendly"), workspace_integration_id (string), title (string), description (string), calendly ({event_type_uri, event_name, scheduling_url, duration})
- details: Collect several fields on one screen - name, email, phone, address, date, and more. Config: title (string), fields (array of {id, type, label, order, required, is_custom}), description (string), consent_items (array of {id, name, label, order, type, document, require_scroll_to_accept}), Available field IDs: first_name, last_name, email, phone. Standard fields keep their names (no label needed); for other wording or a non-English form, add a custom field ({ id, is_custom: true, label, type }). consent_items[].type is "consent" (required agreement) or "opt_in" (optional). Defaults: {"fields":[{"id":"first_name","required":true},{"id":"email","required":true}],"consent_items":[]}
- draw: Drawing canvas; respondents draw and it is saved as a PNG image. Config: title (string), description (string), paper_color (string, default: "#FAF9F6"), diagram ({opacity, scale, preset}). Defaults: {"paper_color":"#FAF9F6","stroke_colors":["#1F2937","#EF4444","#3B82F6","#22C55E","#FACC15"],"stroke_widths":[3,6,12],"diagram":{"opacity":1,"scale":1}}
- camera: Capture a photo or video from the device camera. Config: title (string), description (string), camera_facing ("user"|"environment", default: "user"), allowed_capture (array of "photo"|"video"), camera_capture (array of "photo"|"video"), allow_library_upload (boolean, default: true), capture_order (array of "photo"|"video"|"library"), max_files (number, default: 1), min_files (number, default: 1)
- payment: Collect a payment from respondents inline, charged to a connected Stripe account. Config: amount (number), currency ("usd"|"eur"|"gbp"|"cad"|"aud", default: "usd"), provider ("stripe"|"paddle", default: "stripe"), workspace_integration_id (string), title (string), description (string). Defaults: {"amount":null,"currency":"usd","provider":"stripe"}
- button: Simple button for acknowledgment or navigation (supports options array). Config: button_text (string, default: "Continue"), button_style ("primary"|"secondary"|"outline", default: "primary")
- redirect: Redirect users to an external URL. Config: url (string), auto_redirect (boolean, default: true). Defaults: {"url":"","auto_redirect":true}
- file_download: Provide a file for respondents to download. Config: files (array of {file_name, display_name, file_path, file_size, mime_type}), button_text (string, default: "Continue"), description (string)
- end_screen: Final screen shown when form is completed. Config: title (string, default: "Thank you!"), message (string, default: "Your response has been submitted."), icon ("tick"|"trophy"|"star"|"crown"|"party"|"none", default: "tick"), show_share_button (boolean, default: false), cta_type ("none"|"restart"|"external_link", default: "none"), cta_text (string, default: "Continue"), cta_url (string). Defaults: {"title":"Thank you!","message":"Your response has been submitted."}
All type definitions and config schemas are derived from @vid-master/config (node-types). Refer to the config descriptions above for the correct keys and shapes. AI-PROTECTED parameters have restrictions noted in their descriptions.
Example: A form that asks a question, collects contact info, then finishes:
{
title: "Quick Survey",
nodes: [
{ type: "open", prompt: "What's your biggest challenge?" },
{ type: "details", prompt: "Leave your details", config: { fields: [{ id: "first_name", required: true }, { id: "email", required: true }] } },
{ type: "end_screen", prompt: "Thanks for your response!" }
]
}
Schema valid · SHA-256 7ac424b4cae0…
View input schema
{
"type": "object",
"properties": {
"workspace_id": {
"description": "Workspace to act in (id from clipform_whoami workspaces). Omit to use the connection's default workspace.",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"title": {
"type": "string",
"description": "Form title"
},
"nodes": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"choice",
"open",
"booking",
"details",
"draw",
"camera",
"payment",
"button",
"redirect",
"file_download",
"end_screen"
]
},
"prompt": {
"type": "string",
"description": "The text shown to the respondent"
},
"label": {
"description": "Short label for the node (used in logic builder). Defaults to the prompt text.",
"type": "string"
},
"required": {
"default": true,
"type": "boolean"
},
"config": {
"description": "Type-specific configuration keyed by node type. Omit to use defaults. Per-type keys, shapes, and defaults are listed in the clipform_create_form description; craft guidance via clipform_get_guide.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"options": {
"description": "Answer options. choice: required, min 1, max 12, max 6 when option_display is \"letters\", content max 80 chars button: required, min 1, max 1, content max 28 chars",
"type": "array",
"items": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "Option text"
},
"is_correct": {
"description": "Mark this option as a correct answer for a quiz. Stored as the answer key; when score is not given it also sets score 1 (or 0 on the others).",
"type": "boolean"
},
"score": {
"description": "Score value for this option (for scored quizzes). Use 1 for correct, 0 for wrong. Scored options automatically enable correct-answer marking (record_scores) and correct/incorrect answer feedback on the node; set config.choice.show_answer_feedback: false to hide the feedback.",
"type": "integer",
"minimum": 0,
"maximum": 999
}
},
"required": [
"content"
]
}
}
},
"required": [
"type",
"prompt"
]
},
"description": "Ordered list of nodes/steps for the form"
},
"show_step_counter": {
"description": "Show step counter (e.g. '1/5'). Set true for quizzes.",
"type": "boolean"
},
"disable_back_navigation": {
"description": "Prevent going back. Set true for quizzes.",
"type": "boolean"
},
"primary_color": {
"description": "Primary/brand color as 6-digit hex (e.g. '#FF5500'). Used for buttons and accents.",
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$"
},
"background_color": {
"description": "Background color as 6-digit hex (e.g. '#1A1A2E').",
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$"
},
"font_family": {
"description": "AI-PROTECTED: Only set when the user explicitly requests a specific font.",
"type": "string"
},
"tags": {
"description": "Tags for indexing (e.g. ['quiz', 'trivia', 'arsenal']). Include format, genre, and topics.",
"type": "array",
"items": {
"type": "string"
}
},
"context": {
"type": "string",
"description": "Describe the user's underlying goal in one sentence - not the tool you're calling."
}
},
"required": [
"title",
"nodes",
"context"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}