Amigo · Schema
FormTemplateUpdateRequest
Replace all form templates.
CompanyArtificial IntelligenceHealthcareAI AgentsVoiceClinicalConversational AIFHIRElectronic Health RecordsHIPAA
Properties
| Name | Type | Description |
|---|---|---|
| templates | array |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amigo/main/json-schema/amigo-form-template-update-request-schema.json",
"title": "FormTemplateUpdateRequest",
"description": "Replace all form templates.",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/amigo-form-templates-api-openapi.yml#/components/schemas/FormTemplateUpdateRequest",
"properties": {
"templates": {
"items": {
"$ref": "#/$defs/FormTemplate-Input"
},
"type": "array",
"maxItems": 50,
"title": "Templates"
}
},
"type": "object",
"required": [
"templates"
],
"$defs": {
"BrandingConfig": {
"properties": {
"logo_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Logo Url"
},
"primary_color": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Primary Color"
},
"background_color": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Background Color"
},
"font_family": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
],
"title": "Font Family"
}
},
"type": "object",
"title": "BrandingConfig",
"description": "Visual branding for patient-facing surfaces."
},
"DescriptionString": {
"type": "string",
"maxLength": 2000
},
"FieldType": {
"type": "string",
"enum": [
"text",
"textarea",
"date",
"phone",
"email",
"number",
"select",
"multiselect",
"checkbox",
"photo",
"signature",
"file",
"heading",
"info"
],
"title": "FieldType",
"description": "Input field types for surface data collection."
},
"FormTemplate-Input": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"name": {
"$ref": "#/$defs/NameString"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/DescriptionString"
},
{
"type": "null"
}
]
},
"category": {
"type": "string",
"enum": [
"intake",
"update",
"consent",
"screening",
"survey",
"custom"
],
"title": "Category",
"default": "custom"
},
"patient_type": {
"type": "string",
"enum": [
"new",
"returning",
"any"
],
"title": "Patient Type",
"default": "any"
},
"fields": {
"items": {
"$ref": "#/$defs/FormTemplateField"
},
"type": "array",
"maxItems": 200,
"minItems": 1,
"title": "Fields"
},
"sections": {
"items": {
"$ref": "#/$defs/FormTemplateSection"
},
"type": "array",
"maxItems": 20,
"minItems": 1,
"title": "Sections"
},
"branding": {
"anyOf": [
{
"$ref": "#/$defs/BrandingConfig"
},
{
"type": "null"
}
]
},
"completion_title": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
],
"title": "Completion Title"
},
"completion_message": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
],
"title": "Completion Message"
},
"completion_action_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2048
},
{
"type": "null"
}
],
"title": "Completion Action Url"
},
"submit_button_text": {
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "null"
}
],
"title": "Submit Button Text"
},
"active": {
"type": "boolean",
"title": "Active",
"default": true
},
"version": {
"type": "integer",
"minimum": 1.0,
"title": "Version",
"default": 1
}
},
"type": "object",
"required": [
"name",
"fields",
"sections"
],
"title": "FormTemplate",
"description": "Reusable form template with sections, prefill, branding.\n\nExtends DataTemplate concept. Up to 200 fields, organized in sections.\nStored in workspace settings[\"form_templates\"] JSONB.\n\nExamples:\n- New patient intake (85 fields, 11 sections)\n- Returning patient update (27 fields, 5 sections)\n- Pre-surgery checklist (15 fields, 3 sections)\n- PHQ-9 screening (10 fields, 1 section)"
},
"FormTemplateField": {
"properties": {
"key": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"title": "Key"
},
"label": {
"$ref": "#/$defs/NameString"
},
"field_type": {
"$ref": "#/$defs/FieldType",
"default": "text"
},
"required": {
"type": "boolean",
"title": "Required",
"default": true
},
"options": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Options"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/DescriptionString"
},
{
"type": "null"
}
]
},
"placeholder": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
],
"title": "Placeholder"
},
"validation": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Validation"
},
"sensitive": {
"type": "boolean",
"title": "Sensitive",
"default": false
},
"condition": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Condition"
},
"consent_text": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"type": "null"
}
],
"title": "Consent Text"
},
"prefill_path": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
],
"title": "Prefill Path",
"description": "Dot-notation path into entity state for prefill (e.g. demographics.date_of_birth)"
},
"layout_group": {
"anyOf": [
{
"type": "string",
"maxLength": 64
},
{
"type": "null"
}
],
"title": "Layout Group",
"description": "Row grouping hint — fields with same layout_group render side-by-side"
}
},
"type": "object",
"required": [
"key",
"label"
],
"title": "FormTemplateField",
"description": "Extended field with prefill_path mapping to entity state.\n\nUnlike SurfaceField (agent-generated, dynamic), FormTemplateField is\na reusable definition that maps to FHIR/EHR data paths for auto-prefill."
},
"FormTemplateSection": {
"properties": {
"id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"title": "Id"
},
"title": {
"$ref": "#/$defs/NameString"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/DescriptionString"
},
{
"type": "null"
}
]
},
"field_keys": {
"items": {
"type": "string"
},
"type": "array",
"maxItems": 200,
"minItems": 1,
"title": "Field Keys"
},
"condition": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Condition"
}
},
"type": "object",
"required": [
"id",
"title",
"field_keys"
],
"title": "FormTemplateSection",
"description": "A section in a form template (maps to one wizard step)."
},
"NameString": {
"type": "string",
"maxLength": 256,
"minLength": 1
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amigo-form-template-update-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.