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

认证

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

REST API

  • 使用 REST API
  • 全部端点
  • 项目
    • GET
      List data formats
    • POST
      Create a data format
    • GET
      Get a data format
    • PATCH
      Update a data format
    • POST
      Publishes the draft as the next immutable revision. The path is the REST noun (`revisions`): the public contract refuses verb segments.
    • POST
      Create a sample run
    • GET
      Get a sample run
    • DELETE
      Removes every sample uploaded for the DRAFT of a team format (FV-20c). The format stays. Repeating the call removes nothing and still succeeds.
    • GET
      This team's own formats, drafts included. The route precedes `:formatId`.
    • GET
      List first value state
    • PATCH
      Update a first value state
    • POST
      Create a onboarding sample
    • DELETE
      Delete a current
    • GET
      List current for a onboarding sample
    • POST
      Create a project import job
    • GET
      Get a project import job
    • POST
      Create a confirmation
    • POST
      Create a resumption
    • POST
      Create a project import source
    • POST
      Create a validation request
    • PATCH
      Update a project membership
    • GET
      List projects
    • POST
      Create a project
    • DELETE
      Move a project to trash
    • GET
      Get a project
    • PATCH
      Update a project
    • GET
      List analytics for a project
    • POST
      Create a archive request
    • POST
      Move a project to trash
    • GET
      List members for a project
    • POST
      Create a member
    • PATCH
      Update a membership
    • GET
      List overview for a project
    • GET
      List pii policy for a project
    • PUT
      Update a pii policy
    • GET
      List project import jobs for a project
    • GET
      List recording privacy for a project
    • PUT
      Owner only (checked in the service). Applies to new uploads; with `applyToExistingRecordings` (not_required only) it also moves the project's existing recordings, audited, in the same transaction.
    • GET
      List saved views in a project
    • POST
      Create a saved episode filter view
    • DELETE
      Delete a saved view
    • GET
      Get a saved view
    • PATCH
      Patch a saved view
    • GET
      List project secrets
    • POST
      Create a secret
    • DELETE
      Delete a secret
    • PUT
      Update a secret
    • GET
      Resolve a dataset reference or console path to ids
    • GET
      List rig profiles
    • POST
      Create a rig profile
    • GET
      Get a rig profile
    • PATCH
      Update a draft
    • POST
      Publishes the confirmed draft as the next immutable revision. The path is the REST noun (`revisions`): the public contract refuses verb segments.
    • POST
      Create a test
    • POST
      Analyses a recording and answers a draft; stores nothing.
    • GET
      List team secrets
    • POST
      Create a secret
    • DELETE
      Delete a secret
    • PUT
      Update a secret
    • GET
      List items in trash
    • DELETE
      Permanently purge an item from trash
    • POST
      Restore an item from trash
    • GET
      List recent projects for a me
  • 录制
    • 上传
      • 任务片段与版本
        • 标注
          • 质量与任务
            • 检索
              • 工作流
                • 算法
                  • 模型
                    • 产物与导出
                      • 计费与用量
                        • 团队与治理
                          • 账号与通知
                            • Webhook 端点

                              事件

                              • 出站事件
                              • 签名校验

                              工具

                              • 命令行
                              • SDK
                              • MCP

                              更新

                              • 更新日志

                              © 2026 EmbodiFlow

                              llms.txtOpenAPI JSON
                              1. 开发者参考
                              2. REST API
                              3. 项目
                              4. List overview for a project

                              List overview for a project

                              GET
                              /v1/projects/{projectId}/overview
                              curl -X GET 'https://api.embodiflow.io/v1/projects/{projectId}/overview' \
                                -H 'Authorization: Bearer $EMBODIFLOW_PAT'

                              认证

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

                              • Authorization: Bearer PAT
                              认证指南

                              路径参数

                              • projectIdstring必填

                              响应

                              Success

                              • dataobject必填
                                • projectobject必填
                                • metricsobject必填
                                • capabilitiesobject必填
                                • permissionsarray<string>必填
                                • currentMembershipobject | null必填
                              响应示例
                              {
                                "data": {
                                  "project": {
                                    "id": "string",
                                    "tenantId": "string",
                                    "slug": "string",
                                    "name": "string",
                                    "description": "string",
                                    "dataFormat": "string",
                                    "projectType": "string",
                                    "projectSubtype": "string",
                                    "visibility": "string",
                                    "status": "string",
                                    "isSample": false,
                                    "lastAccessedAt": "string",
                                    "createdAt": "string",
                                    "updatedAt": "string"
                                  },
                                  "metrics": {
                                    "datasetCount": 0,
                                    "fileCount": 0,
                                    "storageBytes": 0,
                                    "lastUploadAt": "string",
                                    "qualityIssueCount": 0
                                  },
                                  "capabilities": {
                                    "canViewProject": false,
                                    "canViewDatasets": false,
                                    "canViewProcessing": false,
                                    "canUploadData": false,
                                    "canSubmitUploadBatch": false,
                                    "canRunProcessing": false,
                                    "canViewAnalytics": false,
                                    "canEditProcessingTemplates": false,
                                    "canPublishProcessingTemplates": false,
                                    "canRollbackProcessingTemplates": false,
                                    "canSetDefaultProcessingTemplate": false,
                                    "canEditProjectSettings": false,
                                    "canManageMembers": false,
                                    "canArchiveProject": false,
                                    "canDeleteProject": false
                                  },
                                  "permissions": "project:read",
                                  "currentMembership": {
                                    "membershipId": "string",
                                    "roles": "owner",
                                    "roleSources": [
                                      "string"
                                    ]
                                  }
                                }
                              }
                              服务器https://api.embodiflow.io/v1https://api.embodiflow.dev/v1
                              上一页

                              PATCH /projects/{projectId}/memberships/{membershipId}

                              下一页

                              GET /projects/{projectId}/pii-policy

                              curl -X GET 'https://api.embodiflow.io/v1/projects/{projectId}/overview' \
                                -H 'Authorization: Bearer $EMBODIFLOW_PAT'
                              响应示例
                              状态码
                              200
                              ​
                              {
                                "data": {
                                  "project": {
                                    "id": "string",
                                    "tenantId": "string",
                                    "slug": "string",
                                    "name": "string",
                                    "description": "string",
                                    "dataFormat": "string",
                                    "projectType": "string",
                                    "projectSubtype": "string",
                                    "visibility": "string",
                                    "status": "string",
                                    "isSample": false,
                                    "lastAccessedAt": "string",
                                    "createdAt": "string",
                                    "updatedAt": "string"
                                  },
                                  "metrics": {
                                    "datasetCount": 0,
                                    "fileCount": 0,
                                    "storageBytes": 0,
                                    "lastUploadAt": "string",
                                    "qualityIssueCount": 0
                                  },
                                  "capabilities": {
                                    "canViewProject": false,
                                    "canViewDatasets": false,
                                    "canViewProcessing": false,
                                    "canUploadData": false,
                                    "canSubmitUploadBatch": false,
                                    "canRunProcessing": false,
                                    "canViewAnalytics": false,
                                    "canEditProcessingTemplates": false,
                                    "canPublishProcessingTemplates": false,
                                    "canRollbackProcessingTemplates": false,
                                    "canSetDefaultProcessingTemplate": false,
                                    "canEditProjectSettings": false,
                                    "canManageMembers": false,
                                    "canArchiveProject": false,
                                    "canDeleteProject": false
                                  },
                                  "permissions": "project:read",
                                  "currentMembership": {
                                    "membershipId": "string",
                                    "roles": "owner",
                                    "roleSources": [
                                      "string"
                                    ]
                                  }
                                }
                              }