コンテンツにスキップ

keypoints

keypoints/では、キーポイント抽出処理の実行や処理結果の取得ができます。

エンドポイント 説明
GET /keypoints 実行したキーポイント抽出の処理一覧の取得
GET /keypoints/:id 指定した id に該当するキーポイント抽出情報の取得
POST /keypoints アップロードした動画像に対するキーポイント抽出の実行

Important

APIをリクエストする際には各種エンドポイントの末尾に / を付与してリクエストしてください。 具体的には /keypoints/123 というURLに対するリクエストは /keypoints/123/ としてリクエストをします。

GET /keypoints

これまでに実行したキーポイント抽出の処理一覧を取得します。

リクエスト

HTTPリクエスト

1
GET https://api.customer.jp/anymotion/v1/keypoints/

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer <アクセストークン>

リクエストパラメータ

パラメータ 説明 必須
page ページ番号 -
size ページサイズ -

レスポンス

レスポンスボディ

プロパティ タイプ 説明
next String 次ページのURL
previous String 前ページのURL
maxPage Integer 最大ページ番号
data String データ一覧
data[].id Integer キーポイントID
data[].image Integer 参照画像ID
data[].movie Integer 参照動画ID
data[].execStatus String 実行ステータス
UNPROCESSED, SUCCESS, PROCESSING, FAILURE
data[].createdAt String 作成時刻
data[].updatedAt String 更新時刻

サンプルレスポンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
    "next": "https://api.customer.jp/anymotion/v1/keypoints/?page=3&size=2",
    "previous": "https://api.customer.jp/anymotion/v1/keypoints/?page=1&size=2",
    "maxPage": 10,
    "data": [
      {
        "id": 18,
        "image": null,
        "movie": 34,
        "execStatus": "SUCCESS",
        "createdAt": "2019-06-16T09:22:48.008212Z",
        "updatedAt": "2019-06-17T09:29:11.712656Z"
      },
      {
        "id": 17,
        "image": 44,
        "movie": null,
        "execStatus": "SUCCESS",
        "createdAt": "2019-06-16T09:33:48.008212Z",
        "updatedAt": "2019-06-17T09:39:11.712656Z"
      },
      ...
    ]
}

GET /keypoints/:id

キーポイント抽出処理の実行結果情報を取得します。

リクエスト

HTTPリクエスト

1
GET https://api.customer.jp/anymotion/v1/keypoints/:id/

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer <アクセストークン>

レスポンス

レスポンスボディ

プロパティ タイプ 説明
id Integer キーポイントID
movie Integer 抽出対象の動画ID
image Integer 抽出対象の画像ID
keypoint String 抽出キーポイント
execStatus String 実行ステータス
UNPROCESSED, SUCCESS, PROCESSING, FAILURE
failureDetail String Failureの詳細
createdAt String 作成時刻
updatedAt String 更新時刻

サンプルレスポンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    "id": 60,
    "movie": 34,
    "image": null,
    "keypoint": [{"leftEye": [12, 34], "rightEye": [34, 56]},
                 {"leftEye": [33, 11], "rightEye": [9, 9]}],
    "execStatus": "SUCCESS",
    "failureDetail": null,
    "createdAt": "2019-06-18T00:51:21.732916Z",
    "updatedAt": "2019-06-18T00:51:21.732951Z"
}

failureDetailのメッセージ

  • failureDetailプロパティに含まれる、主なエラーメッセージは以下の通りです。
メッセージ 説明
The image format is not supported. 拡張子が不適切です。拡張子については、こちらを参照ください。
The video format is not supported. 拡張子が不適切です。拡張子については、こちらを参照ください。
The total number of pixels in the image file has to be less than 12.2 million. 画像サイズが制限を超えています。画像サイズについては、こちらを参照ください。
The total number of pixels in a single frame of the video file has to be less than 2.1 million. 動画サイズが制限を超えています。動画サイズについては、こちらを参照ください。
The total number of frames in the video file has to be less than 1800. 動画の長さが制限を超えています。動画の長さについては、こちらを参照ください。
There is a problem on AnyMotion. AnyMotionのエラーです。こちらよりお問い合わせください。

POST /keypoints

アップロード済みの動画像に対してキーポイント抽出処理を実行します。 動画像に対してのキーポイント抽出は処理が大きいため非同期APIとなります。実行結果は execStatus に格納されます。

リクエスト

HTTPリクエスト

1
POST https://api.customer.jp/anymotion/v1/keypoints/

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer <アクセストークン>

リクエストパラメータ

パラメータ 説明 必須
movieId 抽出対象の動画ID 1
imageId 抽出対象の画像ID 1

Important

movieIdimageIdは指定しない場合や両方指定した場合はエラーレスポンスとなります。

レスポンス

レスポンスボディ

プロパティ タイプ 説明
id Integer キーポイントID
movie Integer 抽出対象の動画ID
image Integer 抽出対象の画像ID
keypoint String 抽出キーポイント
execStatus String 実行ステータス
UNPROCESSED, SUCCESS, PROCESSING, FAILURE
createdAt String 作成時刻
updatedAt String 更新時刻

サンプルレスポンス

1
2
3
4
5
6
7
8
9
{
    "id": 1,
    "movie": 34,
    "image": null,
    "keypoint": null,
    "execStatus": "UNPROCESSED",
    "createdAt": "2019-06-18T00:51:21.732916Z",
    "updatedAt": "2019-06-18T00:51:21.732951Z"
}

  1. movieIdimageIdは指定しない場合や両方指定した場合はエラーレスポンスとなります。