AI アプリのインスタンスの一覧を取得する

カメラに追加した AI アプリを新しい順に返します。1 件が 1 台のカメラの映像を読み、結果を metricKeys の計測項目に記録します。最新の結果はインスタンスの詳細、結果の履歴はインスタンスの計測値で取得してください。スコープは data か data:write が要ります。

GET/ai-app-instances

Authorization

AuthorizationBearer token · headerrequired

組織設定の「API・MCP」タブで発行した API トークン（tcn_ で始まる）。

Query parameters

edgePcIdstring

このエッジPC のインスタンスだけに絞る

appIdstring

この AI アプリのインスタンスだけに絞る

Allowed:license-platemeter-readingobject-detection

pageinteger

ページ番号（1 から。既定 1）

min 1 · default: 1

pageSizeinteger

1 ページの件数（1〜100。既定 50）

min 1 · max 100 · default: 50

Responses

200

インスタンスの一覧

instancesAiAppInstance[]required

Show properties

Array of AiAppInstance

idstringrequired

appIdstringrequired

AI アプリの ID（license-plate、object-detection など）

namestringrequired

notestring | nullrequired

edgePcIdstringrequired

edgePcNamestringrequired

cameraIdstring | nullrequired

映像を読むカメラのデバイス ID

cameraNamestring | nullrequired

そのカメラの名前

metricKeysstring[]required

結果を記録する計測項目のキー（object_count など）

createdAtstring<date-time>required

totalintegerrequired

絞り込み後の総件数

pageintegerrequired

pageSizeintegerrequired

400

入力の検証エラー、または対象の種類が合わない

errorstringrequired

人が読めるエラーメッセージ

401

トークンが無い、または無効

errorstringrequired

人が読めるエラーメッセージ

403

スコープが足りない、または操作が許可されていない

errorstringrequired

人が読めるエラーメッセージ

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

edgePcIdqueryこのエッジPC のインスタンスだけに絞るappIdqueryこの AI アプリのインスタンスだけに絞るpagequeryページ番号（1 から。既定 1）pageSizequery1 ページの件数（1〜100。既定 50）

Request

curl -X GET 'https://api.thingsconnect.app/api/v1/ai-app-instances' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.thingsconnect.app/api/v1/ai-app-instances", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.thingsconnect.app/api/v1/ai-app-instances",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "instances": [
    {
      "id": "string",
      "appId": "string",
      "name": "string",
      "note": "string",
      "edgePcId": "string",
      "edgePcName": "string",
      "cameraId": "string",
      "cameraName": "string",
      "metricKeys": [
        "string"
      ],
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "page": 0,
  "pageSize": 0
}

{
  "error": "string"
}

{
  "error": "Unauthorized"
}

{
  "error": "data スコープが必要です"
}