Amigo · Schema

EndpointResponse

Per-endpoint response (V186 flat shape).

CompanyArtificial IntelligenceHealthcareAI AgentsVoiceClinicalConversational AIFHIRElectronic Health RecordsHIPAA

Properties

Name Type Description
id string Endpoint ID — stable, used in subsequent GET/PATCH/DELETE/test URLs.
name string Slug-like identifier. Unique per integration; immutable post-create.
description string LLM-facing description.
method string HTTP method.
path string URL path appended to the integration's base_url.
input_schema object JSON Schema for the tool's input arguments.
headers object Static request headers.
static_body_fields object Static body fields merged into every request. Keys are RFC 6901 JSON Pointers (e.g. ``/meta/tool_name`` for nested, ``/foo`` for a root-level field).
body_format string Outbound body encoding.
response_template object Jinja template rendered against the parsed JSON response.
max_response_length integer Truncate the final rendered string to this many chars.
timeout_seconds number Per-request timeout.
max_retries integer Retry attempts on transient failures.
retry_on_status array HTTP status codes that trigger a retry.
View JSON Schema on GitHub

JSON Schema

amigo-endpoint-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amigo/main/json-schema/amigo-endpoint-response-schema.json",
  "title": "EndpointResponse",
  "description": "Per-endpoint response (V186 flat shape).",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amigo-integrations-api-openapi.yml#/components/schemas/EndpointResponse",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "title": "Id",
      "description": "Endpoint ID — stable, used in subsequent GET/PATCH/DELETE/test URLs."
    },
    "name": {
      "type": "string",
      "title": "Name",
      "description": "Slug-like identifier. Unique per integration; immutable post-create."
    },
    "description": {
      "type": "string",
      "title": "Description",
      "description": "LLM-facing description."
    },
    "method": {
      "type": "string",
      "enum": [
        "GET",
        "POST",
        "PUT",
        "PATCH",
        "DELETE"
      ],
      "title": "Method",
      "description": "HTTP method."
    },
    "path": {
      "type": "string",
      "title": "Path",
      "description": "URL path appended to the integration's base_url."
    },
    "input_schema": {
      "additionalProperties": true,
      "type": "object",
      "title": "Input Schema",
      "description": "JSON Schema for the tool's input arguments."
    },
    "headers": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object",
      "title": "Headers",
      "description": "Static request headers."
    },
    "static_body_fields": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object",
      "title": "Static Body Fields",
      "description": "Static body fields merged into every request. Keys are RFC 6901 JSON Pointers\n(e.g. ``/meta/tool_name`` for nested, ``/foo`` for a root-level field)."
    },
    "body_format": {
      "type": "string",
      "enum": [
        "json",
        "form"
      ],
      "title": "Body Format",
      "description": "Outbound body encoding.",
      "default": "json"
    },
    "response_template": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Response Template",
      "description": "Jinja template rendered against the parsed JSON response."
    },
    "max_response_length": {
      "type": "integer",
      "title": "Max Response Length",
      "description": "Truncate the final rendered string to this many chars.",
      "default": 0
    },
    "timeout_seconds": {
      "type": "number",
      "title": "Timeout Seconds",
      "description": "Per-request timeout.",
      "default": 30.0
    },
    "max_retries": {
      "type": "integer",
      "title": "Max Retries",
      "description": "Retry attempts on transient failures.",
      "default": 2
    },
    "retry_on_status": {
      "items": {
        "type": "integer"
      },
      "type": "array",
      "uniqueItems": true,
      "title": "Retry On Status",
      "description": "HTTP status codes that trigger a retry."
    }
  },
  "type": "object",
  "required": [
    "id",
    "name",
    "description",
    "method",
    "path"
  ]
}

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.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amigo-endpoint-response"
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.