Retrieving Information via API

The information about incidents and performance degradation for each engine that can be checked on the Statuspage can also be retrieved via an API. This section explains the overview.

For details, please see the Statuspage documentation AmiVoice API Status API.

How to Use

By accessing the following endpoint, you can retrieve the current operational status and other information of AmiVoice API posted on the Statuspage in JSON format. Note that no authentication information such as an API key is required to use this API.

https://status.amivoice.com/api/v2/summary.json

The following is an example request using the curl command. Here, the jq command is used to make the response easier to read.

curl https://status.amivoice.com/api/v2/summary.json | jq

The components in the returned response contains information about "接続障害" (Connection Failure), "接続遅延" (Connection Delay), and the "レスポンス遅延" (Response Delay) of the WebSocket interface for each engine, respectively. You can also retrieve information such as the id of each engine.

For example, suppose the information for the "会話_汎用（16k）" engine of the Synchronous HTTP and WebSocket interfaces is described as follows.

{
      "id": "vh7cj7kf3fv6",
      "name": "同期HTTP・WebSocketインタフェース[会話_汎用(16k)]",
      "status": "operational",
      "created_at": "2025-04-30T12:05:15.030+09:00",
      "updated_at": "2025-10-27T10:43:00.343+09:00",
      "position": 4,
      "description": null,
      "showcase": false,
      "start_date": null,
      "group_id": null,
      "page_id": "z5s0f2662c1w",
      "group": true,
      "only_show_if_degraded": false,
      "components": [
        "78xz9y90wm4g",
        "mlmgglv3hvm2",
        "8xm4dyh31bjz"
      ]
}

In this case, among the components, those with the ids "78xz9y90wm4g", "mlmgglv3hvm2", and "8xm4dyh31bjz" are the information for "接続障害" (Connection Failure), "接続遅延" (Connection Delay), and the "レスポンス遅延" (Response Delay) of the WebSocket interface for the "会話_汎用（16k）" engine of the Synchronous HTTP and WebSocket interfaces.

Also, the id "vh7cj7kf3fv6" listed in the engine information corresponds to the group_id of the corresponding components.

For example, the "接続障害" (Connection Failure) of the "会話_汎用（16k）" engine of the Synchronous HTTP and WebSocket interfaces is described as follows.

{
      "id": "78xz9y90wm4g",
      "name": "接続障害",
      "status": "operational",
      "created_at": "2025-04-30T12:05:14.603+09:00",
      "updated_at": "2025-04-30T12:05:15.038+09:00",
      "position": 1,
      "description": "APIへの接続における障害状況",
      "showcase": true,
      "start_date": "2025-04-30",
      "group_id": "vh7cj7kf3fv6",
      "page_id": "z5s0f2662c1w",
      "group": false,
      "only_show_if_degraded": false
}

Of these, when status is "operational", it means that the component in question is currently normal.

For the meaning of the status values, please see Types of Service Statuses.