EmbodiFlowDocs
Open console
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
      • POST
        Create a archive request
      • POST
        Create a revision
      • GET
        List checks for a dataset version
      • POST
        Create a contract check request
      • GET
        List deletion eligibility for a dataset version
      • GET
        List health for a dataset version
      • POST
        Create a health recompute request
      • GET
        List provenance summary for a dataset version
      • POST
        Create a repair task generation request
      • GET
        List reproducibility bundle for a dataset version
      • POST
        Create a split plan
      • GET
        List training jobs for a dataset version
      • GET
        List diff for a dataset version
      • POST
        Create a dataset
      • GET
        Get a dataset
      • PATCH
        Update a dataset
      • PUT
        Update a draft
      • POST
        ADR 0073: import QWen auto-annotate draft → writeback + optional search index rebuild.
      • GET
        List frame spatial annotations for a dataset
      • POST
        Create a frame spatial annotation
      • DELETE
        Delete a frame spatial annotation
      • PATCH
        Update a frame spatial annotation
      • GET
        List lineage for a dataset
      • GET
        List studio for a dataset
      • GET
        List time range annotations for a dataset
      • POST
        Create a time range annotation
      • DELETE
        Delete a time range annotation
      • PATCH
        Update a time range annotation
      • GET
        List versions for a dataset
      • GET
        List governance tags for a version
      • POST
        Create a governance tag
      • DELETE
        Delete a governance tag
      • PATCH
        Update a governance tag
      • GET
        List governance tags for a item
      • POST
        Create a governance tag
      • DELETE
        Delete a governance tag
      • PATCH
        Update a governance tag
      • GET
        Get a version
      • POST
        Create a derived version
      • GET
        List files for a version
      • GET
        List items for a version
      • GET
        List lineage for a version
      • GET
        List metadata for a version
      • GET
        List processing gate for a version
      • POST
        Create a publication request
      • POST
        Create a quality check job
      • GET
        List quality report for a version
      • GET
        List quality summary for a version
      • GET
        List signed files for a version
      • GET
        List topics for a version
      • POST
        Create a visibility restoration
      • GET
        List edges for a lineage
      • GET
        List downstream for a node
      • GET
        List upstream for a node
      • GET
        List capture sessions in a project
      • POST
        Create a capture session
      • GET
        List data contracts for a project
      • POST
        Create a data contract
      • GET
        List datasets for a project
      • GET
        List health for a project
      • GET
        List recordings in a project
      • POST
        Create a recording from an upload session or a one-way Hugging Face Hub import
      • DELETE
        Move a recording to trash
      • GET
        Get a recording
      • PATCH
        Patch recording name and tags
      • GET
        Get anonymization evidence and spot-check status for a recording
      • POST
        Create a consent-document upload for a human recording
      • POST
        Complete a consent-document upload after the object is stored
      • POST
        Confirm a privacy spot check for the latest processing result
      • GET
        What the latest processing result of a recording holds: cameras, columns, features, rate and duration
      • PUT
        Assign or clear a recording capture session
    • Upload
      • Episodes and versions
        • Annotation
          • Quality and tasks
            • Search
              • Workflows
                • Algorithms
                  • Models
                    • Artifacts and export
                      • Billing and usage
                        • Team and governance
                          • Account and notifications
                            • 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. Recordings

                              Recordings

                              Recordings, versions, retention, diffs, and health dimensions.

                              Endpoints

                              /data-contracts

                              POST

                              Create a archive request

                              /v1/data-contracts/{contractId}/archive-requests
                              POST

                              Create a revision

                              /v1/data-contracts/{contractId}/revisions

                              /dataset-versions

                              GET

                              List checks for a dataset version

                              /v1/dataset-versions/{versionId}/checks
                              POST

                              Create a contract check request

                              /v1/dataset-versions/{versionId}/contract-check-requests
                              GET

                              List deletion eligibility for a dataset version

                              /v1/dataset-versions/{versionId}/deletion-eligibility
                              GET

                              List health for a dataset version

                              /v1/dataset-versions/{versionId}/health
                              POST

                              Create a health recompute request

                              /v1/dataset-versions/{versionId}/health-recompute-requests
                              GET

                              List provenance summary for a dataset version

                              /v1/dataset-versions/{versionId}/provenance-summary
                              POST

                              Create a repair task generation request

                              /v1/dataset-versions/{versionId}/repair-task-generation-requests
                              GET

                              List reproducibility bundle for a dataset version

                              /v1/dataset-versions/{versionId}/reproducibility-bundle
                              POST

                              Create a split plan

                              /v1/dataset-versions/{versionId}/split-plans
                              GET

                              List training jobs for a dataset version

                              /v1/dataset-versions/{versionId}/training-jobs
                              GET

                              List diff for a dataset version

                              /v1/dataset-versions/diff

                              /datasets

                              POST

                              Create a dataset

                              /v1/datasets
                              GET

                              Get a dataset

                              /v1/datasets/{datasetId}
                              PATCH

                              Update a dataset

                              /v1/datasets/{datasetId}
                              PUT

                              Update a draft

                              /v1/datasets/{datasetId}/annotations/draft
                              POST

                              ADR 0073: import QWen auto-annotate draft → writeback + optional search index rebuild.

                              /v1/datasets/{datasetId}/auto-annotate-imports
                              GET

                              List frame spatial annotations for a dataset

                              /v1/datasets/{datasetId}/frame-spatial-annotations
                              POST

                              Create a frame spatial annotation

                              /v1/datasets/{datasetId}/frame-spatial-annotations
                              DELETE

                              Delete a frame spatial annotation

                              /v1/datasets/{datasetId}/frame-spatial-annotations/{annotationId}
                              PATCH

                              Update a frame spatial annotation

                              /v1/datasets/{datasetId}/frame-spatial-annotations/{annotationId}
                              GET

                              List lineage for a dataset

                              /v1/datasets/{datasetId}/lineage
                              GET

                              List studio for a dataset

                              /v1/datasets/{datasetId}/studio
                              GET

                              List time range annotations for a dataset

                              /v1/datasets/{datasetId}/time-range-annotations
                              POST

                              Create a time range annotation

                              /v1/datasets/{datasetId}/time-range-annotations
                              DELETE

                              Delete a time range annotation

                              /v1/datasets/{datasetId}/time-range-annotations/{annotationId}
                              PATCH

                              Update a time range annotation

                              /v1/datasets/{datasetId}/time-range-annotations/{annotationId}
                              GET

                              List versions for a dataset

                              /v1/datasets/{datasetId}/versions
                              GET

                              List governance tags for a version

                              /v1/datasets/{datasetId}/versions/{datasetVersionId}/governance-tags
                              POST

                              Create a governance tag

                              /v1/datasets/{datasetId}/versions/{datasetVersionId}/governance-tags
                              DELETE

                              Delete a governance tag

                              /v1/datasets/{datasetId}/versions/{datasetVersionId}/governance-tags/{tagId}
                              PATCH

                              Update a governance tag

                              /v1/datasets/{datasetId}/versions/{datasetVersionId}/governance-tags/{tagId}
                              GET

                              List governance tags for a item

                              /v1/datasets/{datasetId}/versions/{datasetVersionId}/items/{itemId}/governance-tags
                              POST

                              Create a governance tag

                              /v1/datasets/{datasetId}/versions/{datasetVersionId}/items/{itemId}/governance-tags
                              DELETE

                              Delete a governance tag

                              /v1/datasets/{datasetId}/versions/{datasetVersionId}/items/{itemId}/governance-tags/{tagId}
                              PATCH

                              Update a governance tag

                              /v1/datasets/{datasetId}/versions/{datasetVersionId}/items/{itemId}/governance-tags/{tagId}
                              GET

                              Get a version

                              /v1/datasets/{datasetId}/versions/{versionId}
                              POST

                              Create a derived version

                              /v1/datasets/{datasetId}/versions/{versionId}/derived-versions
                              GET

                              List files for a version

                              /v1/datasets/{datasetId}/versions/{versionId}/files
                              GET

                              List items for a version

                              /v1/datasets/{datasetId}/versions/{versionId}/items
                              GET

                              List lineage for a version

                              /v1/datasets/{datasetId}/versions/{versionId}/lineage
                              GET

                              List metadata for a version

                              /v1/datasets/{datasetId}/versions/{versionId}/metadata
                              GET

                              List processing gate for a version

                              /v1/datasets/{datasetId}/versions/{versionId}/processing-gate
                              POST

                              Create a publication request

                              /v1/datasets/{datasetId}/versions/{versionId}/publication-requests
                              POST

                              Create a quality check job

                              /v1/datasets/{datasetId}/versions/{versionId}/quality-check-jobs
                              GET

                              List quality report for a version

                              /v1/datasets/{datasetId}/versions/{versionId}/quality-report
                              GET

                              List quality summary for a version

                              /v1/datasets/{datasetId}/versions/{versionId}/quality-summary
                              GET

                              List signed files for a version

                              /v1/datasets/{datasetId}/versions/{versionId}/signed-files
                              GET

                              List topics for a version

                              /v1/datasets/{datasetId}/versions/{versionId}/topics
                              POST

                              Create a visibility restoration

                              /v1/datasets/{datasetId}/versions/{versionId}/visibility-restorations

                              /lineage

                              GET

                              List edges for a lineage

                              /v1/lineage/edges
                              GET

                              List downstream for a node

                              /v1/lineage/nodes/{type}/{id}/downstream
                              GET

                              List upstream for a node

                              /v1/lineage/nodes/{type}/{id}/upstream

                              /projects

                              GET

                              List capture sessions in a project

                              /v1/projects/{projectId}/capture-sessions
                              POST

                              Create a capture session

                              /v1/projects/{projectId}/capture-sessions
                              GET

                              List data contracts for a project

                              /v1/projects/{projectId}/data-contracts
                              POST

                              Create a data contract

                              /v1/projects/{projectId}/data-contracts
                              GET

                              List datasets for a project

                              /v1/projects/{projectId}/datasets
                              GET

                              List health for a project

                              /v1/projects/{projectId}/health
                              GET

                              List recordings in a project

                              /v1/projects/{projectId}/recordings
                              POST

                              Create a recording from an upload session or a one-way Hugging Face Hub import

                              /v1/projects/{projectId}/recordings
                              DELETE

                              Move a recording to trash

                              /v1/projects/{projectId}/recordings/{recordingId}
                              GET

                              Get a recording

                              /v1/projects/{projectId}/recordings/{recordingId}
                              PATCH

                              Patch recording name and tags

                              /v1/projects/{projectId}/recordings/{recordingId}
                              GET

                              Get anonymization evidence and spot-check status for a recording

                              /v1/projects/{projectId}/recordings/{recordingId}/privacy
                              POST

                              Create a consent-document upload for a human recording

                              /v1/projects/{projectId}/recordings/{recordingId}/privacy/consents
                              POST

                              Complete a consent-document upload after the object is stored

                              /v1/projects/{projectId}/recordings/{recordingId}/privacy/consents/{consentId}/completions
                              POST

                              Confirm a privacy spot check for the latest processing result

                              /v1/projects/{projectId}/recordings/{recordingId}/privacy/spot-checks
                              GET

                              What the latest processing result of a recording holds: cameras, columns, features, rate and duration

                              /v1/projects/{projectId}/recordings/{recordingId}/schema

                              /recordings

                              PUT

                              Assign or clear a recording capture session

                              /v1/recordings/{recordingId}/capture-session
                              Previous

                              Projects

                              Next

                              Upload