EmbodiFlowDocs
Get startedDataWorkflows and algorithmsTraining and deploymentDeveloper reference
  • Developer reference

Authentication

  • Authentication overview
  • API keys
  • Personal access tokens
  • Browser sessions

REST API

  • Using the REST API
  • All endpoints
  • Projects
    • Recordings
      • Upload
        • Episodes and versions
          • Annotation
            • Quality and tasks
              • Search
                • Workflows
                  • Algorithms
                    • Models
                      • Artifacts and export
                        • Billing and usage
                          • Team and governance
                            • Account and notifications
                              • GET
                                List the current user activity tray for this team
                              • GET
                                Get the current user handle profile
                              • PATCH
                                Update the current user handle
                              • GET
                                List annotation assignments for a me
                              • GET
                                List collection tasks for a me
                              • GET
                                Get a collection task
                              • POST
                                Create a consent acceptance
                              • GET
                                List delivery batches for a me
                              • POST
                                Create a closure
                              • GET
                                Get the current user notification channel preferences for this team
                              • PUT
                                Replace the current user notification channel preferences for this team
                              • GET
                                List workflow runs for a me
                              • GET
                                List notifications
                              • POST
                                Create a read receipt
                              • POST
                                Create a read receipt
                              • GET
                                List unread count for a notification
                            • Webhook endpoints

                              Events

                              • Outbound events
                              • Signature verification

                              Tools

                              • CLI
                              • SDK
                              • MCP

                              Updates

                              • Changelog

                              © 2026 EmbodiFlow

                              llms.txtOpenAPI JSON
                              1. Developer reference
                              2. REST API
                              3. Account and notifications
                              4. Get a collection task

                              Get a collection task

                              GET
                              /v1/me/collection-tasks/{taskId}
                              curl -X GET 'https://api.embodiflow.io/v1/me/collection-tasks/{taskId}' \
                                -H 'Authorization: Bearer $EMBODIFLOW_PAT'

                              Authorization

                              Send a personal access token with every request.

                              • Authorization: Bearer PAT
                              Authentication guide

                              Path parameters

                              • taskIdstringrequired

                              Responses

                              Success

                              • dataobjectrequired
                                • idstringrequired
                                • orderIdstringrequired
                                • projectIdstringrequired
                                • orderTitlestringrequired
                                • namestringrequired
                                • instructionJsonobjectrequired
                                • demoMediaKeysarray<string>required
                                • startConditionstringrequired
                                • endConditionstringrequired
                                • allowedVariationstring | nullrequired
                                • durationMinSnumber | nullrequired
                                • durationMaxSnumber | nullrequired
                                • requiredCamerasarray<string>required
                                • requiredModalitiesarray<string>required
                                • minHandsVisiblenumber | nullrequired
                                • recordingModestringrequired
                                • orderIndexnumberrequired
                                • consentRequiredone ofrequired
                                • latestConsentobject | nullrequired
                                • consentAcceptedone ofrequired
                                • quotaobjectrequired
                                • submissionsarray<CollectionWorkspaceSubmissionDto>required
                              Response example
                              {
                                "data": {
                                  "id": "string",
                                  "orderId": "string",
                                  "projectId": "string",
                                  "orderTitle": "string",
                                  "name": "string",
                                  "instructionJson": {
                                    "en": "string",
                                    "zh": "string"
                                  },
                                  "demoMediaKeys": [
                                    "string"
                                  ],
                                  "startCondition": "string",
                                  "endCondition": "string",
                                  "allowedVariation": "string",
                                  "durationMinS": 0,
                                  "durationMaxS": 0,
                                  "requiredCameras": [
                                    "string"
                                  ],
                                  "requiredModalities": [
                                    "string"
                                  ],
                                  "minHandsVisible": 0,
                                  "recordingMode": "string",
                                  "orderIndex": 0,
                                  "consentRequired": false,
                                  "latestConsent": {
                                    "id": "string",
                                    "version": 0,
                                    "textMd": "string"
                                  },
                                  "consentAccepted": false,
                                  "quota": {
                                    "remainingForMe": 0,
                                    "remainingOverall": 0,
                                    "perCollectorCap": 0,
                                    "mySubmissionCount": 0,
                                    "overallSubmissionCount": 0
                                  },
                                  "submissions": [
                                    {
                                      "id": "string",
                                      "recordingId": "string",
                                      "taskId": "string",
                                      "sceneId": "string",
                                      "decision": "pending",
                                      "displayStatus": "accepted",
                                      "reasonCode": "string",
                                      "reasonDetail": "string",
                                      "createdAt": "string"
                                    }
                                  ]
                                }
                              }
                              Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1
                              Previous

                              GET /me/collection-tasks

                              Next

                              POST /me/collection-tasks/{taskId}/consent-acceptances

                              curl -X GET 'https://api.embodiflow.io/v1/me/collection-tasks/{taskId}' \
                                -H 'Authorization: Bearer $EMBODIFLOW_PAT'
                              Response example
                              Status code
                              200
                              ​
                              {
                                "data": {
                                  "id": "string",
                                  "orderId": "string",
                                  "projectId": "string",
                                  "orderTitle": "string",
                                  "name": "string",
                                  "instructionJson": {
                                    "en": "string",
                                    "zh": "string"
                                  },
                                  "demoMediaKeys": [
                                    "string"
                                  ],
                                  "startCondition": "string",
                                  "endCondition": "string",
                                  "allowedVariation": "string",
                                  "durationMinS": 0,
                                  "durationMaxS": 0,
                                  "requiredCameras": [
                                    "string"
                                  ],
                                  "requiredModalities": [
                                    "string"
                                  ],
                                  "minHandsVisible": 0,
                                  "recordingMode": "string",
                                  "orderIndex": 0,
                                  "consentRequired": false,
                                  "latestConsent": {
                                    "id": "string",
                                    "version": 0,
                                    "textMd": "string"
                                  },
                                  "consentAccepted": false,
                                  "quota": {
                                    "remainingForMe": 0,
                                    "remainingOverall": 0,
                                    "perCollectorCap": 0,
                                    "mySubmissionCount": 0,
                                    "overallSubmissionCount": 0
                                  },
                                  "submissions": [
                                    {
                                      "id": "string",
                                      "recordingId": "string",
                                      "taskId": "string",
                                      "sceneId": "string",
                                      "decision": "pending",
                                      "displayStatus": "accepted",
                                      "reasonCode": "string",
                                      "reasonDetail": "string",
                                      "createdAt": "string"
                                    }
                                  ]
                                }
                              }