EmbodiFlow文档
开始使用数据工作流与算法训练与部署开发者参考
  • 开发者参考

认证

  • 认证概览
  • API 密钥
  • 个人访问令牌
  • 浏览器会话

REST API

  • 使用 REST API
  • 全部端点
  • 项目
    • 录制
      • 上传
        • 任务片段与版本
          • GET
            Get a dataset version composition profile
          • GET
            List quality findings for a dataset version composition profile
          • POST
            Create a composition profile request
          • GET
            List composition profiles for a dataset version
          • GET
            Count episodes matching a filter
          • POST
            Apply label and segment operations to a selection of episodes
          • GET
            Semantic search availability and index coverage for the project
          • GET
            List episodes in a project
          • GET
            Get an episode
          • GET
            List revisions of an episode
          • POST
            Append one episode revision (never If-Match)
          • GET
            Find similar episodes in the same project
          • GET
            List version aliases in a project
          • DELETE
            Delete a version alias
          • PUT
            Create or move a version alias
          • GET
            List versions in a project
          • POST
            Create a version from a selection of episodes
          • DELETE
            Move a version to trash
          • GET
            Get a version
          • PATCH
            Patch version name, readme, and licence
          • GET
            Get a version citation
          • GET
            List episodes in a version
          • POST
            Preview a version selection without writing
        • 标注
          • 质量与任务
            • 检索
              • 工作流
                • 算法
                  • 模型
                    • 产物与导出
                      • 计费与用量
                        • 团队与治理
                          • 账号与通知
                            • Webhook 端点

                              事件

                              • 出站事件
                              • 签名校验

                              工具

                              • 命令行
                              • SDK
                              • MCP

                              更新

                              • 更新日志

                              © 2026 EmbodiFlow

                              llms.txtOpenAPI JSON
                              1. 开发者参考
                              2. REST API
                              3. 任务片段与版本
                              4. Preview a version selection without writing

                              Preview a version selection without writing

                              POST
                              /v1/projects/{projectId}/versions/previews
                              curl -X POST 'https://api.embodiflow.io/v1/projects/{projectId}/versions/previews' \
                                -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
                                -H 'Content-Type: application/json' \
                                -d '{
                                  "selection": {
                                    "filter": {},
                                    "savedViewId": "00000000-0000-0000-0000-000000000000",
                                    "episodeIds": [
                                      "00000000-0000-0000-0000-000000000000"
                                    ],
                                    "selectionRunId": "00000000-0000-0000-0000-000000000000"
                                  },
                                  "name": "string",
                                  "split": {
                                    "strategy": "episode",
                                    "ratios": {
                                      "train": 0,
                                      "val": 0,
                                      "test": 0
                                    },
                                    "seed": 0
                                  },
                                  "labelPolicy": "current",
                                  "includeFailing": true,
                                  "includeIncomplete": true,
                                  "preprocessing": {
                                    "fps": 0,
                                    "cameraKeys": [
                                      "string"
                                    ],
                                    "trimIdle": true,
                                    "maxDurationS": 0,
                                    "padMs": 0
                                  },
                                  "readmeMd": "string",
                                  "licence": "string"
                                }'

                              认证

                              每个请求都需要携带个人访问令牌(PAT)。

                              • Authorization: Bearer PAT
                              认证指南

                              路径参数

                              • projectIdstring必填

                              请求体

                              Content-Typeapplication/json
                              • selectionobject必填
                                • filterobject
                                • savedViewIdstring (uuid)
                                • episodeIdsarray<string (uuid)>
                                • selectionRunIdstring (uuid)

                                  The episodes a workflow run was asked about (an upload run: every episode of its recordings).

                              • namestring必填
                              • splitobject
                                • strategystring必填
                                  可选值
                                  episode
                                  recording
                                  collector
                                  stratified_task
                                  manual
                                • ratiosobject必填
                                • seednumber
                              • labelPolicystring
                                可选值
                                current
                                approved_only
                              • includeFailingboolean
                              • includeIncompleteboolean
                              • preprocessingobject
                                • fpsnumber | null
                                • cameraKeysarray<string> | null
                                • trimIdleboolean
                                • maxDurationSnumber | null
                                • padMsnumber
                              • readmeMdstring | null
                              • licencestring | null

                              响应

                              Success

                              • dataobject必填
                                • episodeCountnumber必填
                                • unreviewedAiEpisodeCountnumber必填
                                • warningEpisodeCountnumber必填
                                • unfinishedEpisodeCountnumber必填
                                • trainCountnumber必填
                                • valCountnumber必填
                                • testCountnumber必填
                                • totalDurationNsnumber必填
                                • schemaGroupsarray<VersionDataContractGroup>必填
                                • featuresarray<ProjectVersionFeatureCoverageDto>必填
                                • excludedobject必填
                                • blockedarray<ProjectVersionBlockedEpisodeDto>必填
                                • warningsarray<string>必填
                              响应示例
                              {
                                "data": {
                                  "episodeCount": 0,
                                  "unreviewedAiEpisodeCount": 0,
                                  "warningEpisodeCount": 0,
                                  "unfinishedEpisodeCount": 0,
                                  "trainCount": 0,
                                  "valCount": 0,
                                  "testCount": 0,
                                  "totalDurationNs": 0,
                                  "schemaGroups": [
                                    {
                                      "key": "string",
                                      "dataContractDigest": "string",
                                      "episodeCount": 0,
                                      "schema": {
                                        "fps": 0,
                                        "cameraKeys": [
                                          "string"
                                        ],
                                        "features": {}
                                      },
                                      "cameraOrder": [
                                        {
                                          "key": "string",
                                          "role": "string"
                                        }
                                      ],
                                      "sourceFormats": [
                                        "string"
                                      ],
                                      "actionSemantics": {
                                        "space": "none",
                                        "dimensionNames": [
                                          "string"
                                        ],
                                        "units": [
                                          "string"
                                        ],
                                        "coordinateFrames": [
                                          "string"
                                        ],
                                        "representation": "absolute",
                                        "embodimentId": "string",
                                        "controlRateHz": 0
                                      },
                                      "conventions": {
                                        "version": "embodiflow-data-conventions/v1",
                                        "frames": {},
                                        "features": {},
                                        "sourceClocks": {},
                                        "stereoPairs": [
                                          {}
                                        ],
                                        "timeOffsets": {}
                                      }
                                    }
                                  ],
                                  "features": [
                                    {
                                      "feature": "string",
                                      "presentCount": 0,
                                      "missingCount": 0,
                                      "missingRecordingIds": [
                                        "string"
                                      ]
                                    }
                                  ],
                                  "excluded": {
                                    "failing": 0,
                                    "incomplete": 0,
                                    "deleted": 0,
                                    "notAnonymized": 0,
                                    "noApprovedRevision": 0,
                                    "excludedFlag": 0
                                  },
                                  "blocked": [
                                    {
                                      "episodeId": "string",
                                      "recordingId": "string",
                                      "recordingName": "string",
                                      "startNs": 0,
                                      "endNs": 0,
                                      "reason": "incomplete",
                                      "checkIds": [
                                        "string"
                                      ],
                                      "privacyState": "pending",
                                      "privacyBlocker": "consent_missing"
                                    }
                                  ],
                                  "warnings": [
                                    "string"
                                  ]
                                }
                              }
                              服务器https://api.embodiflow.io/v1https://api.embodiflow.dev/v1
                              上一页

                              GET /projects/{projectId}/versions/{versionNumber}/episodes

                              curl -X POST 'https://api.embodiflow.io/v1/projects/{projectId}/versions/previews' \
                                -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
                                -H 'Content-Type: application/json' \
                                -d '{
                                  "selection": {
                                    "filter": {},
                                    "savedViewId": "00000000-0000-0000-0000-000000000000",
                                    "episodeIds": [
                                      "00000000-0000-0000-0000-000000000000"
                                    ],
                                    "selectionRunId": "00000000-0000-0000-0000-000000000000"
                                  },
                                  "name": "string",
                                  "split": {
                                    "strategy": "episode",
                                    "ratios": {
                                      "train": 0,
                                      "val": 0,
                                      "test": 0
                                    },
                                    "seed": 0
                                  },
                                  "labelPolicy": "current",
                                  "includeFailing": true,
                                  "includeIncomplete": true,
                                  "preprocessing": {
                                    "fps": 0,
                                    "cameraKeys": [
                                      "string"
                                    ],
                                    "trimIdle": true,
                                    "maxDurationS": 0,
                                    "padMs": 0
                                  },
                                  "readmeMd": "string",
                                  "licence": "string"
                                }'
                              响应示例
                              状态码
                              200
                              ​
                              {
                                "data": {
                                  "episodeCount": 0,
                                  "unreviewedAiEpisodeCount": 0,
                                  "warningEpisodeCount": 0,
                                  "unfinishedEpisodeCount": 0,
                                  "trainCount": 0,
                                  "valCount": 0,
                                  "testCount": 0,
                                  "totalDurationNs": 0,
                                  "schemaGroups": [
                                    {
                                      "key": "string",
                                      "dataContractDigest": "string",
                                      "episodeCount": 0,
                                      "schema": {
                                        "fps": 0,
                                        "cameraKeys": [
                                          "string"
                                        ],
                                        "features": {}
                                      },
                                      "cameraOrder": [
                                        {
                                          "key": "string",
                                          "role": "string"
                                        }
                                      ],
                                      "sourceFormats": [
                                        "string"
                                      ],
                                      "actionSemantics": {
                                        "space": "none",
                                        "dimensionNames": [
                                          "string"
                                        ],
                                        "units": [
                                          "string"
                                        ],
                                        "coordinateFrames": [
                                          "string"
                                        ],
                                        "representation": "absolute",
                                        "embodimentId": "string",
                                        "controlRateHz": 0
                                      },
                                      "conventions": {
                                        "version": "embodiflow-data-conventions/v1",
                                        "frames": {},
                                        "features": {},
                                        "sourceClocks": {},
                                        "stereoPairs": [
                                          {}
                                        ],
                                        "timeOffsets": {}
                                      }
                                    }
                                  ],
                                  "features": [
                                    {
                                      "feature": "string",
                                      "presentCount": 0,
                                      "missingCount": 0,
                                      "missingRecordingIds": [
                                        "string"
                                      ]
                                    }
                                  ],
                                  "excluded": {
                                    "failing": 0,
                                    "incomplete": 0,
                                    "deleted": 0,
                                    "notAnonymized": 0,
                                    "noApprovedRevision": 0,
                                    "excludedFlag": 0
                                  },
                                  "blocked": [
                                    {
                                      "episodeId": "string",
                                      "recordingId": "string",
                                      "recordingName": "string",
                                      "startNs": 0,
                                      "endNs": 0,
                                      "reason": "incomplete",
                                      "checkIds": [
                                        "string"
                                      ],
                                      "privacyState": "pending",
                                      "privacyBlocker": "consent_missing"
                                    }
                                  ],
                                  "warnings": [
                                    "string"
                                  ]
                                }
                              }