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

认证

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

REST API

  • 使用 REST API
  • 全部端点
  • 项目
    • 录制
      • 上传
        • GET
          List collection delivery batches
        • POST
          Create a collection delivery batche
        • GET
          Get a collection delivery batche
        • PATCH
          Update a collection delivery batche
        • POST
          Create a submission
        • POST
          Create a upload batche
        • GET
          List collection orders for a project
        • POST
          Create a collection order
        • DELETE
          Delete a collection order
        • GET
          Get a collection order
        • PATCH
          Update a collection order
        • GET
          List assignments for a collection order
        • POST
          Create a assignment
        • DELETE
          Delete a assignment
        • POST
          Create a invitation
        • POST
          Create a cancellation
        • POST
          Create a closure
        • GET
          List consents for a collection order
        • POST
          Create a consent
        • DELETE
          Delete a consent
        • GET
          Get a consent
        • PATCH
          Update a consent
        • GET
          List delivery batches for a collection order
        • GET
          Get a delivery batche
        • POST
          Create a duplicate
        • POST
          Create a opening
        • GET
          List progress for a collection order
        • GET
          List quotas for a collection order
        • POST
          Create a quota
        • DELETE
          Delete a quota
        • PATCH
          Update a quota
        • POST
          Create a report
        • GET
          List scenes for a collection order
        • POST
          Create a scene
        • DELETE
          Delete a scene
        • PATCH
          Update a scene
        • POST
          Create a photo
        • GET
          List submissions for a collection order
        • GET
          Get a submission
        • POST
          Create a review
        • GET
          List tasks for a collection order
        • POST
          Create a task
        • DELETE
          Delete a task
        • PATCH
          Update a task
        • POST
          Create a demo media
        • GET
          List upload batches for a project
        • POST
          Create an upload batch from a path+size manifest. JSON body ceiling is 4 MiB on this route only (global public JSON stays 100kb). Exceeding it returns 413 PAYLOAD_TOO_LARGE. File bytes are not accepted here; clients upload objects directly to storage. With `sampleForFormatId` the batch carries a test sample for the draft of a team data format (FV-20c): it needs `algorithm:write`, `sourceType` `team-format` and files with an extension the draft card declares, and the sample is used only for that format's sample runs.
        • GET
          Get a upload batche
        • POST
          Heartbeat of the uploader: the uploading page calls this about every minute while it hashes or sends bytes, so the batch is told apart from an abandoned one. 409 UPLOAD_BATCH_NOT_DISCARDABLE once the batch is no longer in progress.
        • POST
          Discard an unfinished upload: aborts its open sessions and settles the batch as failed (`UPLOAD_BATCH_DISCARDED`). 409 UPLOAD_BATCH_ACTIVE while the uploader is alive; 409 UPLOAD_BATCH_NOT_DISCARDABLE when a file already completed or the batch was submitted.
        • GET
          List dataset plan for a upload batche
        • POST
          Create a submission request
        • POST
          Create a upload session
        • GET
          Get a upload session
        • POST
          Create a cancellation request
        • POST
          Create a completion request
        • POST
          Create a part url
      • 任务片段与版本
        • 标注
          • 质量与任务
            • 检索
              • 工作流
                • 算法
                  • 模型
                    • 产物与导出
                      • 计费与用量
                        • 团队与治理
                          • 账号与通知
                            • Webhook 端点

                              事件

                              • 出站事件
                              • 签名校验

                              工具

                              • 命令行
                              • SDK
                              • MCP

                              更新

                              • 更新日志

                              © 2026 EmbodiFlow

                              llms.txtOpenAPI JSON
                              1. 开发者参考
                              2. REST API
                              3. 上传
                              4. Create a upload session

                              Create a upload session

                              POST
                              /v1/upload-sessions
                              curl -X POST 'https://api.embodiflow.io/v1/upload-sessions' \
                                -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
                                -H 'Content-Type: application/json' \
                                -d '{
                                  "uploadBatchId": "00000000-0000-0000-0000-000000000000",
                                  "storageBucketId": "00000000-0000-0000-0000-000000000000",
                                  "files": [
                                    {
                                      "role": "calibration",
                                      "deviceMeta": {},
                                      "originalFilename": "string",
                                      "relativePath": "string",
                                      "contentType": "string",
                                      "sizeBytes": 0,
                                      "checksumExpected": "string"
                                    }
                                  ]
                                }'

                              认证

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

                              • Authorization: Bearer PAT
                              认证指南

                              请求头参数

                              • x-embodiflow-clientstring

                                Optional CLI hint (`cli`). Write STS is issued only to PAT principals; cookie sessions keep putUrl / part-urls even if this header is sent.

                              • Idempotency-Keystring

                                Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.

                              请求体

                              Content-Typeapplication/json
                              • uploadBatchIdstring (uuid)必填
                              • storageBucketIdstring (uuid) | null
                              • filesarray<CreateUploadSessionFileBodyDto>必填
                                • rolestring | null
                                  可选值
                                  calibration
                                  mapping
                                  media
                                • deviceMetaobject | null
                                • originalFilenamestring必填
                                • relativePathstring必填
                                • contentTypestring | null
                                • sizeBytesnumber必填
                                • checksumExpectedstring | null

                              响应

                              Success

                              • dataobject必填
                                • sessionsarray<UploadSessionSummarySwaggerDto>必填
                              响应示例
                              {
                                "data": {
                                  "sessions": [
                                    {
                                      "id": "00000000-0000-0000-0000-000000000000",
                                      "uploadBatchId": "00000000-0000-0000-0000-000000000000",
                                      "storageBucketId": "00000000-0000-0000-0000-000000000000",
                                      "objectKey": "string",
                                      "originalFilename": "string",
                                      "uploadMode": "single",
                                      "status": "string",
                                      "expiresAt": "2026-01-01T00:00:00Z",
                                      "putUrl": "string",
                                      "providerUploadId": "string",
                                      "writeCredentials": {
                                        "accessKeyId": "string",
                                        "secretAccessKey": "string",
                                        "sessionToken": "string",
                                        "expiresAt": "2026-01-01T00:00:00Z",
                                        "bucketName": "string",
                                        "region": "string",
                                        "provider": "string",
                                        "endpoint": "string",
                                        "objectKey": "string",
                                        "prefix": "string",
                                        "forcePathStyle": true
                                      },
                                      "partSizeBytes": 0
                                    }
                                  ]
                                }
                              }
                              服务器https://api.embodiflow.io/v1https://api.embodiflow.dev/v1
                              上一页

                              POST /upload-batches/{batchId}/submission-requests

                              下一页

                              GET /upload-sessions/{sessionId}

                              curl -X POST 'https://api.embodiflow.io/v1/upload-sessions' \
                                -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
                                -H 'Content-Type: application/json' \
                                -d '{
                                  "uploadBatchId": "00000000-0000-0000-0000-000000000000",
                                  "storageBucketId": "00000000-0000-0000-0000-000000000000",
                                  "files": [
                                    {
                                      "role": "calibration",
                                      "deviceMeta": {},
                                      "originalFilename": "string",
                                      "relativePath": "string",
                                      "contentType": "string",
                                      "sizeBytes": 0,
                                      "checksumExpected": "string"
                                    }
                                  ]
                                }'
                              响应示例
                              状态码
                              201
                              ​
                              {
                                "data": {
                                  "sessions": [
                                    {
                                      "id": "00000000-0000-0000-0000-000000000000",
                                      "uploadBatchId": "00000000-0000-0000-0000-000000000000",
                                      "storageBucketId": "00000000-0000-0000-0000-000000000000",
                                      "objectKey": "string",
                                      "originalFilename": "string",
                                      "uploadMode": "single",
                                      "status": "string",
                                      "expiresAt": "2026-01-01T00:00:00Z",
                                      "putUrl": "string",
                                      "providerUploadId": "string",
                                      "writeCredentials": {
                                        "accessKeyId": "string",
                                        "secretAccessKey": "string",
                                        "sessionToken": "string",
                                        "expiresAt": "2026-01-01T00:00:00Z",
                                        "bucketName": "string",
                                        "region": "string",
                                        "provider": "string",
                                        "endpoint": "string",
                                        "objectKey": "string",
                                        "prefix": "string",
                                        "forcePathStyle": true
                                      },
                                      "partSizeBytes": 0
                                    }
                                  ]
                                }
                              }