Amigo · Schema

TestInvokeResponse

Response shape for ``POST /v1/{ws}/functions/{name}/test``. Structural superset of :class:`InvokeResponse`. Adds ``status`` and ``error`` so the DC can render the executor's failure detail inline rather than a generic "Invocation failed." The underlying invoke uses the same path; ``status`` / ``error`` are filled in by ``service.test`` after catching any ``HTTPException`` (503) from the executor, so the route never bubbles a 5xx for a logical SQL failure — it's still a 200 with ``status=fail`` so the caller can show the message. Invariant (enforced by :func:`_check_error_when_fail`): ``status == "fail" → error is not None and len(error) > 0``.

CompanyArtificial IntelligenceHealthcareAI AgentsVoiceClinicalConversational AIFHIRElectronic Health RecordsHIPAA

Properties

Name Type Description
result object
duration_ms number
row_count integer
status string
error object
test_duration_ms object
View JSON Schema on GitHub

JSON Schema

amigo-test-invoke-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-test-invoke-response-schema.json",
  "title": "TestInvokeResponse",
  "description": "Response shape for ``POST /v1/{ws}/functions/{name}/test``.\n\nStructural superset of :class:`InvokeResponse`. Adds ``status`` and\n``error`` so the DC can render the executor's failure detail inline\nrather than a generic \"Invocation failed.\" The underlying invoke\nuses the same path; ``status`` / ``error`` are filled in by\n``service.test`` after catching any ``HTTPException`` (503) from the\nexecutor, so the route never bubbles a 5xx for a logical SQL\nfailure — it's still a 200 with ``status=fail`` so the caller can\nshow the message.\n\nInvariant (enforced by :func:`_check_error_when_fail`):\n``status == \"fail\" → error is not None and len(error) > 0``.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amigo-functions-api-openapi.yml#/components/schemas/TestInvokeResponse",
  "properties": {
    "result": {
      "title": "Result"
    },
    "duration_ms": {
      "type": "number",
      "title": "Duration Ms",
      "default": 0.0
    },
    "row_count": {
      "type": "integer",
      "title": "Row Count",
      "default": 0
    },
    "status": {
      "type": "string",
      "title": "Status",
      "default": "pass"
    },
    "error": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 2000
        },
        {
          "type": "null"
        }
      ],
      "title": "Error"
    },
    "test_duration_ms": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Test Duration Ms"
    }
  },
  "type": "object"
}

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-test-invoke-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.