Amigo · Schema

Response

CompanyArtificial IntelligenceHealthcareAI AgentsVoiceClinicalConversational AIFHIRElectronic Health RecordsHIPAA

Properties

Name Type Description
conversations array The conversations satisfying the filters.
has_more boolean Whether there are more conversations to retrieve.
continuation_token object A token to supply to the next request to retrieve the next page of conversations. Only populated if `has_more` is `True`.
View JSON Schema on GitHub

JSON Schema

amigo-src-app-endpoints-conversation-get-conversations-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-src-app-endpoints-conversation-get-conversations-response-schema.json",
  "title": "Response",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amigo-conversation-api-openapi.yml#/components/schemas/src__app__endpoints__conversation__get_conversations__Response",
  "properties": {
    "conversations": {
      "items": {
        "$ref": "#/$defs/ConversationInstance"
      },
      "type": "array",
      "title": "Conversations",
      "description": "The conversations satisfying the filters."
    },
    "has_more": {
      "type": "boolean",
      "title": "Has More",
      "description": "Whether there are more conversations to retrieve."
    },
    "continuation_token": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Continuation Token",
      "description": "A token to supply to the next request to retrieve the next page of conversations. Only populated if `has_more` is `True`."
    }
  },
  "type": "object",
  "required": [
    "conversations",
    "has_more",
    "continuation_token"
  ],
  "$defs": {
    "ConversationInstance": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "description": "The identifier of the conversation."
        },
        "user_id": {
          "type": "string",
          "title": "User Id",
          "description": "The identifier of the user who started this conversation."
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "title": "Created At",
          "description": "The timestamp at which this conversation was started."
        },
        "is_finished": {
          "type": "boolean",
          "title": "Is Finished",
          "description": "Whether the conversation is finished."
        },
        "is_analyzed": {
          "type": "boolean",
          "title": "Is Analyzed",
          "description": "Whether the conversation has gone through the post-conversation analysis after finishing."
        },
        "completed_post_processings": {
          "items": {
            "$ref": "#/$defs/PostAnalysisType"
          },
          "type": "array",
          "title": "Completed Post Processings",
          "description": "A list of post-processing types that have been completed for this conversation."
        },
        "final_message": {
          "type": "string",
          "title": "Final Message",
          "description": "The most recent message from the conversation.\n\nThis field is empty if the authenticated user has no `Conversation:GetMessage` permission on the final message."
        },
        "service_id": {
          "type": "string",
          "title": "Service Id",
          "description": "The ID of the service that this conversation uses."
        },
        "version_set_info": {
          "anyOf": [
            {
              "$ref": "#/$defs/VersionSetInfo"
            },
            {
              "type": "null"
            }
          ],
          "description": "Info of the service version set that this conversation uses. This field is only populated if the authenticated user has the `Service.GetVersionSet` permission on the version set."
        },
        "num_messages": {
          "type": "integer",
          "title": "Num Messages",
          "description": "The number of messages in this conversation."
        },
        "tags": {
          "additionalProperties": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "type": "object",
          "title": "Tags",
          "description": "The tags associated with this conversation."
        }
      },
      "type": "object",
      "required": [
        "id",
        "user_id",
        "created_at",
        "is_finished",
        "is_analyzed",
        "completed_post_processings",
        "final_message",
        "service_id",
        "version_set_info",
        "num_messages",
        "tags"
      ],
      "title": "ConversationInstance"
    },
    "LLMConfig-Output": {
      "properties": {
        "llm_name": {
          "type": "string",
          "title": "Llm Name",
          "description": "The name of the LLM to use."
        },
        "params": {
          "additionalProperties": true,
          "type": "object",
          "title": "Params",
          "description": "LLM-specific parameters to use.",
          "default": {}
        }
      },
      "type": "object",
      "required": [
        "llm_name"
      ],
      "title": "LLMConfig"
    },
    "PostAnalysisType": {
      "type": "string",
      "enum": [
        "generate-user-models",
        "extract-memories",
        "compute-metrics"
      ]
    },
    "VersionSetInfo": {
      "properties": {
        "name": {
          "type": "string",
          "title": "Name",
          "description": "The name of the version set. If the value is `unknown`, it means the conversation was created before this field was introduced and the version set name cannot be retroactively determined."
        },
        "agent_version_info": {
          "prefixItems": [
            {
              "type": "string"
            },
            {
              "type": "integer"
            }
          ],
          "type": "array",
          "maxItems": 2,
          "minItems": 2,
          "title": "Agent Version Info",
          "description": "The ID of the agent and version number used in this conversation."
        },
        "service_hierarchical_state_machine_version_info": {
          "prefixItems": [
            {
              "type": "string"
            },
            {
              "type": "integer"
            }
          ],
          "type": "array",
          "maxItems": 2,
          "minItems": 2,
          "title": "Service Hierarchical State Machine Version Info",
          "description": "The ID of the state machine and version number used in this conversation."
        },
        "llm_model_preferences": {
          "additionalProperties": {
            "$ref": "#/$defs/LLMConfig-Output"
          },
          "type": "object",
          "title": "Llm Model Preferences",
          "description": "The LLM model preferences for this version set."
        }
      },
      "type": "object",
      "required": [
        "name",
        "agent_version_info",
        "service_hierarchical_state_machine_version_info",
        "llm_model_preferences"
      ],
      "title": "VersionSetInfo"
    }
  }
}

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-src-app-endpoints-conversation-get-conversations-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.