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
    • 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
  • 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
                            • 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. Projects

                              Projects

                              Create and manage projects, membership, and project metadata.

                              Endpoints

                              /data-formats

                              GET

                              List data formats

                              /v1/data-formats
                              POST

                              Create a data format

                              /v1/data-formats
                              GET

                              Get a data format

                              /v1/data-formats/{formatId}
                              PATCH

                              Update a data format

                              /v1/data-formats/{formatId}
                              POST

                              Publishes the draft as the next immutable revision. The path is the REST noun (`revisions`): the public contract refuses verb segments.

                              /v1/data-formats/{formatId}/revisions
                              POST

                              Create a sample run

                              /v1/data-formats/{formatId}/sample-runs
                              GET

                              Get a sample run

                              /v1/data-formats/{formatId}/sample-runs/{sampleRunId}
                              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.

                              /v1/data-formats/{formatId}/samples
                              GET

                              This team's own formats, drafts included. The route precedes `:formatId`.

                              /v1/data-formats/team

                              /first-value-state

                              GET

                              List first value state

                              /v1/first-value-state
                              PATCH

                              Update a first value state

                              /v1/first-value-state

                              /onboarding-samples

                              POST

                              Create a onboarding sample

                              /v1/onboarding-samples
                              DELETE

                              Delete a current

                              /v1/onboarding-samples/current
                              GET

                              List current for a onboarding sample

                              /v1/onboarding-samples/current

                              /project-import-jobs

                              POST

                              Create a project import job

                              /v1/project-import-jobs
                              GET

                              Get a project import job

                              /v1/project-import-jobs/{runId}
                              POST

                              Create a confirmation

                              /v1/project-import-jobs/{runId}/confirmations
                              POST

                              Create a resumption

                              /v1/project-import-jobs/{runId}/resumptions

                              /project-import-sources

                              POST

                              Create a project import source

                              /v1/project-import-sources
                              POST

                              Create a validation request

                              /v1/project-import-sources/{sourceId}/validation-requests

                              /project-memberships

                              PATCH

                              Update a project membership

                              /v1/project-memberships/{projectMembershipId}

                              /projects

                              GET

                              List projects

                              /v1/projects
                              POST

                              Create a project

                              /v1/projects
                              DELETE

                              Move a project to trash

                              /v1/projects/{projectId}
                              GET

                              Get a project

                              /v1/projects/{projectId}
                              PATCH

                              Update a project

                              /v1/projects/{projectId}
                              GET

                              List analytics for a project

                              /v1/projects/{projectId}/analytics
                              POST

                              Create a archive request

                              /v1/projects/{projectId}/archive-requests
                              POST

                              Move a project to trash

                              /v1/projects/{projectId}/deletion-requests
                              GET

                              List members for a project

                              /v1/projects/{projectId}/members
                              POST

                              Create a member

                              /v1/projects/{projectId}/members
                              PATCH

                              Update a membership

                              /v1/projects/{projectId}/memberships/{membershipId}
                              GET

                              List overview for a project

                              /v1/projects/{projectId}/overview
                              GET

                              List pii policy for a project

                              /v1/projects/{projectId}/pii-policy
                              PUT

                              Update a pii policy

                              /v1/projects/{projectId}/pii-policy
                              GET

                              List project import jobs for a project

                              /v1/projects/{projectId}/project-import-jobs
                              GET

                              List recording privacy for a project

                              /v1/projects/{projectId}/recording-privacy
                              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.

                              /v1/projects/{projectId}/recording-privacy
                              GET

                              List saved views in a project

                              /v1/projects/{projectId}/saved-views
                              POST

                              Create a saved episode filter view

                              /v1/projects/{projectId}/saved-views
                              DELETE

                              Delete a saved view

                              /v1/projects/{projectId}/saved-views/{savedViewId}
                              GET

                              Get a saved view

                              /v1/projects/{projectId}/saved-views/{savedViewId}
                              PATCH

                              Patch a saved view

                              /v1/projects/{projectId}/saved-views/{savedViewId}
                              GET

                              List project secrets

                              /v1/projects/{projectId}/secrets
                              POST

                              Create a secret

                              /v1/projects/{projectId}/secrets
                              DELETE

                              Delete a secret

                              /v1/projects/{projectId}/secrets/{secretId}
                              PUT

                              Update a secret

                              /v1/projects/{projectId}/secrets/{secretId}

                              /resolve

                              GET

                              Resolve a dataset reference or console path to ids

                              /v1/resolve

                              /rig-profiles

                              GET

                              List rig profiles

                              /v1/rig-profiles
                              POST

                              Create a rig profile

                              /v1/rig-profiles
                              GET

                              Get a rig profile

                              /v1/rig-profiles/{id}
                              PATCH

                              Update a draft

                              /v1/rig-profiles/{id}/draft
                              POST

                              Publishes the confirmed draft as the next immutable revision. The path is the REST noun (`revisions`): the public contract refuses verb segments.

                              /v1/rig-profiles/{id}/revisions
                              POST

                              Create a test

                              /v1/rig-profiles/{id}/test
                              POST

                              Analyses a recording and answers a draft; stores nothing.

                              /v1/rig-profiles/drafts

                              /secrets

                              GET

                              List team secrets

                              /v1/secrets
                              POST

                              Create a secret

                              /v1/secrets
                              DELETE

                              Delete a secret

                              /v1/secrets/{secretId}
                              PUT

                              Update a secret

                              /v1/secrets/{secretId}

                              /trash

                              GET

                              List items in trash

                              /v1/trash
                              DELETE

                              Permanently purge an item from trash

                              /v1/trash/{type}/{id}
                              POST

                              Restore an item from trash

                              /v1/trash/{type}/{id}/restorations

                              /users

                              GET

                              List recent projects for a me

                              /v1/users/me/recent-projects
                              Previous

                              All endpoints

                              Next

                              Recordings