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
                              • Webhook endpoints

                                Events

                                • Outbound events
                                • Signature verification

                                Tools

                                • CLI
                                • SDK
                                • MCP

                                Updates

                                • Changelog

                                © 2026 EmbodiFlow

                                llms.txtOpenAPI JSON

                                Developer reference

                                Developer reference

                                Authenticate, call the REST API, receive webhooks, and script EmbodiFlow from the CLI and SDK.

                                Authentication

                                Authentication overview

                                Which credential to use where: browser sessions, personal access tokens and API keys.

                                API keys

                                Team API keys for shared automation: scoped when you create them, always expiring, and revocable by admins.

                                Personal access tokens

                                Personal access tokens: your own credential for the CLI and your integrations, scoped and expiring.

                                Browser sessions

                                How console sign-in works, and how to sign out a device you no longer use.

                                REST API

                                Using the REST API

                                An HTTPS JSON API with bearer-token auth. Here are the conventions every endpoint follows.

                                All endpoints

                                Browse every public operation from the generated OpenAPI spec.

                                Projects

                                Public REST operations tagged for Projects.

                                Recordings

                                Public REST operations tagged for Recordings.

                                Upload

                                Public REST operations tagged for Upload.

                                Episodes and versions

                                Public REST operations tagged for Episodes and versions.

                                Annotation

                                Public REST operations tagged for Annotation.

                                Quality and tasks

                                Public REST operations tagged for Quality and tasks.

                                Search

                                Public REST operations tagged for Search.

                                Workflows

                                Public REST operations tagged for Workflows.

                                Algorithms

                                Public REST operations tagged for Algorithms.

                                Models

                                Public REST operations tagged for Models.

                                Artifacts and export

                                Public REST operations tagged for Artifacts and export.

                                Billing and usage

                                Public REST operations tagged for Billing and usage.

                                Team and governance

                                Public REST operations tagged for Team and governance.

                                Account and notifications

                                Public REST operations tagged for Account and notifications.

                                Webhook endpoints

                                Public REST operations tagged for Webhook endpoints.

                                Events

                                Outbound events

                                Get an HTTP call the moment work finishes: add a webhook endpoint, choose its events, and watch deliveries in the console.

                                Signature verification

                                Make sure a webhook really came from EmbodiFlow: the HMAC-SHA256 recipe, the headers, the time window and a worked example.

                                Tools

                                CLI

                                The embodiflow command (alias ef): sign in, upload, run exports, and download versions.

                                SDK

                                TypeScript and Python clients, generated from the public OpenAPI document.

                                Updates

                                Changelog

                                User-visible changes to EmbodiFlow.

                                Anything you can do in the console, you can also script. The console, the CLI and the SDKs all talk to the same public REST API, so pick whichever fits the job: the CLI for bulk uploads and downloads from a terminal, an SDK inside your own code, or plain HTTP when you want full control.

                                If you want to…Start here
                                Get a credential for a scriptAuthentication
                                Call the API directlyREST API, then browse all endpoints
                                Upload, export and download from a terminalCLI
                                Call the API from TypeScript or PythonSDK
                                Get notified when work finishesOutbound events and Signature verification
                                Write your own algorithmCustom algorithms
                                See what changedChangelog