How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amigo Form Templates API

The Form Templates API from Amigo — 3 operation(s) for form templates.

Amigo Form Templates API is one of 72 APIs that Amigo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Form Templates. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 3 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 5 base URLs: https://api.amigo.ai, https://internal-api.amigo.ai, https://api-eu-central-1.amigo.ai, https://api-ap-southeast-2.amigo.ai, https://api-ca-central-1.amigo.ai.

4 operations 3 paths 18 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.amigo.ai
Authentication
HTTP Bearer, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 3

Amigo Form Templates API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer-Authorization). An API key is passed in the header as X-ORG-ID (Bearer-Authorization-Organization). It accepts HTTP basic authentication (Basic). By default, every request must be authenticated.

  • Bearer-Authorization — Amigo issued JWT token that identifies an user. It's issued either after logging in through the frontend, or manually through the [SignInWithAPIKey](sign-in-wi…
  • Bearer-Authorization-Organization — An optional organization identifier that indicates from which organization the token is issued. This is used in rare cases where the user to authenticate is ma…
  • Basic — The username should be set to {orgid}{userid}, and the password should be the Amigo issued JWT token that identifies the user.

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Form Templates 4
GET
/v1/{workspace_id}/settings/form-templates
List Form Templates
list-form-templates 3 params → 200422
PUT
/v1/{workspace_id}/settings/form-templates
Update Form Templates
update-form-templates 1 param body → 200422
GET
/v1/{workspace_id}/settings/form-templates/{template_id}
Get Form Template
get-form-template 2 params → 200422
POST
/v1/{workspace_id}/settings/form-templates/{template_id}/resolve
Resolve Form Template
resolve-form-template 2 params body → 200422

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are FormTemplate-Output (14 properties), FormTemplate-Input (14 properties), SurfaceSpec (14 properties), FormTemplateField (13 properties). Each schema is shown below with its type and property counts.

FormTemplateSection
object
A section in a form template (maps to one wizard step).
5 properties 3 required
FieldType
string
Input field types for surface data collection.
ResolveTemplateRequest
object
Resolve a form template for a specific entity.
1 property 1 required
NameString
string
SurfaceSection
object
A page/step in a multi-page surface form.
4 properties 2 required
HTTPValidationError
object
1 property
FormTemplateField
object
Extended field with prefillpath mapping to entity state. Unlike SurfaceField (agent-generated, dynamic), FormTemplateField is a reusable definition that maps t…
13 properties 2 required
DescriptionString
string
SurfaceSpec
object
A complete surface specification generated by an agent. The agent reads the HSM (entity state, relationships, confidence gaps) and produces this spec. The spec…
14 properties 3 required
BrandingConfig
object
Visual branding for patient-facing surfaces.
4 properties
ChannelType
string
Delivery channels for surfaces.
ValidationError
object
5 properties 3 required
SurfaceField
object
A single data collection field in a surface spec. Generated by agents from HSM analysis. Each field maps to a specific piece of data the world model needs.
12 properties 3 required
ResolveTemplateResponse
object
Resolved SurfaceSpec with prefill values.
3 properties 3 required
FormTemplateUpdateRequest
object
Replace all form templates.
1 property 1 required
FormTemplate-Input
object
Reusable form template with sections, prefill, branding. Extends DataTemplate concept. Up to 200 fields, organized in sections. Stored in workspace settings["f…
14 properties 3 required
FormTemplate-Output
object
Reusable form template with sections, prefill, branding. Extends DataTemplate concept. Up to 200 fields, organized in sections. Stored in workspace settings["f…
14 properties 3 required
FormTemplateListResponse
object
List of form templates for a workspace.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amigo-form-templates-api-openapi.yml Raw ↑

Other APIs Amigo publishes across the network.

Amigo Account API
Amigo Admin API
Amigo Agent Definitions API
Amigo Agent Runs API
Amigo Agents API
Amigo Analytics API
Amigo API Keys API
Amigo Audit API
Amigo Auth API
Amigo Billing API
Amigo Calls API
Amigo Command Center API
Where this information came from

This is an independent, third-party profile of Amigo Form Templates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.