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
                        • GET
                          List artifacts
                        • GET
                          Get a artifact
                        • GET
                          List compute profiles
                        • GET
                          List deployment packages
                        • POST
                          Create a deployment package
                        • GET
                          Get a deployment package
                        • GET
                          List download sessions
                        • POST
                          Create a download session
                        • GET
                          Get a download session
                        • POST
                          Presigned GET URLs for CLI / scripts; auth = download sessionToken only.
                        • GET
                          List embodiment profiles
                        • GET
                          Get a embodiment profile
                        • GET
                          List gpu class profiles
                        • POST
                          Create a completion request
                        • GET
                          List inference deployments
                        • POST
                          Create a inference deployment
                        • GET
                          Get a inference deployment
                        • POST
                          Connection details for a robot client (ADR 0145 §4). Read-tier because it hands out a dial target and the deployment's own token, not because it is harmless — the token is the credential guarding both wires, so the response carries no internal Kubernetes identifier.
                        • POST
                          Create a control request
                        • POST
                          Create a invocation
                        • GET
                          List model image definitions
                        • POST
                          Create a model image definition
                        • GET
                          Get a model image definition
                        • GET
                          List revisions for a model image definition
                        • POST
                          Create a revision
                        • POST
                          Create a publication request
                        • POST
                          Human review (must not be the revision author). Publish is a separate step.
                        • POST
                          Create a revocation
                        • POST
                          Create a image ref validation
                        • GET
                          List model versions
                        • POST
                          Create a model version
                        • DELETE
                          Delete a model version
                        • GET
                          Get a model version
                        • POST
                          Create a archival
                        • POST
                          Queue a model bundle build (ADR 0145 §5). Idempotent per reason.
                        • POST
                          Edge inference package (ADR 0072) — openpi_client + embodiment fail-closed.
                        • POST
                          Create a promotion
                        • POST
                          Create a import
                        • POST
                          Create a imported checkpoint
                        • GET
                          List exports of a version
                        • POST
                          Create or reuse a cached version export
                        • GET
                          Get a version export
                        • POST
                          Create a download session of presigned version-export files
                        • GET
                          Preview what an export of a version contains, with the unreviewed AI episodes and the privacy warnings
                        • GET
                          Recommend a training policy for a version
                        • POST
                          Start training from a version
                        • DELETE
                          Delete a training checkpoint
                        • GET
                          Get a training checkpoint
                        • POST
                          Create a download
                        • GET
                          List training jobs
                        • POST
                          Create a training job
                        • GET
                          Get a training job
                        • GET
                          List attempts for a training job
                        • GET
                          Get a attempt
                        • GET
                          List checkpoints for a attempt
                        • GET
                          List logs for a attempt
                        • GET
                          List metrics for a attempt
                        • POST
                          Create a cancellation request
                        • GET
                          List reproducibility bundle for a training job
                        • POST
                          Create a retry request
                      • 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. Artifacts and export
                              4. Create a model image definition

                              Create a model image definition

                              POST
                              /v1/model-image-definitions
                              curl -X POST 'https://api.embodiflow.io/v1/model-image-definitions' \
                                -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
                                -H 'Content-Type: application/json' \
                                -d '{
                                  "projectId": "00000000-0000-0000-0000-000000000000",
                                  "code": "string",
                                  "name": "string",
                                  "description": "string",
                                  "imageKind": "training",
                                  "category": "string",
                                  "tags": [
                                    "string"
                                  ],
                                  "imageRef": "string",
                                  "runnerContractVersion": "string",
                                  "paramSchema": {},
                                  "outputSchema": {},
                                  "resourceDefaults": {},
                                  "minGpuMemoryGb": 0,
                                  "recommendedGpuMemoryGb": 0,
                                  "maxGpuCount": 0,
                                  "supportsMultiGpu": true,
                                  "frameworkTags": [
                                    "string"
                                  ],
                                  "registryServer": "string",
                                  "registryUsername": "string",
                                  "registryPassword": "string"
                                }'

                              Authorization

                              Send a personal access token with every request.

                              • Authorization: Bearer PAT
                              Authentication guide

                              Header parameters

                              • Idempotency-Keystring

                                Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.

                              Request body

                              Content-Typeapplication/json
                              • projectIdstring (uuid) | null
                              • codestring | null
                              • namestringrequired
                              • descriptionstring | null
                              • imageKindstringrequired
                                Allowed values
                                training
                                inference
                              • categorystring | null
                              • tagsarray<string>
                              • imageRefstring | null
                              • runnerContractVersionstring | null
                              • paramSchemaobject | null
                              • outputSchemaobject | null
                              • resourceDefaultsobject | null
                              • minGpuMemoryGbnumber | null
                              • recommendedGpuMemoryGbnumber | null
                              • maxGpuCountnumber | null
                              • supportsMultiGpuboolean
                              • frameworkTagsarray<string>
                              • registryServerstring | null
                              • registryUsernamestring | null
                              • registryPasswordstring | null

                              Responses

                              Success

                              • dataobjectrequired
                                • idstringrequired
                                • tenantIdstring | nullrequired
                                • projectIdstring | nullrequired
                                • codestringrequired
                                • namestringrequired
                                • descriptionstring | nullrequired
                                • imageKindstringrequired
                                  Allowed values
                                  training
                                  inference
                                • statusstringrequired
                                • ownerTypestringrequired
                                • systemSlugstring | nullrequired
                                • categorystring | nullrequired
                                • tagsarray<string>required
                                • thumbnailUrlstring | nullrequired
                                • documentationUrlstring | nullrequired
                                • latestRevisionIdstring | nullrequired
                                • createdAtstringrequired
                                • updatedAtstringrequired
                                • modelFamilystring | null
                                • frameworkstring | null
                                • frameworkKindstring | null
                                  Allowed values
                                  official
                                  convenience
                                • isOfficialDefaultone of | null
                              Response example
                              {
                                "data": {
                                  "id": "string",
                                  "tenantId": "string",
                                  "projectId": "string",
                                  "code": "string",
                                  "name": "string",
                                  "description": "string",
                                  "imageKind": "training",
                                  "status": "string",
                                  "ownerType": "string",
                                  "systemSlug": "string",
                                  "category": "string",
                                  "tags": [
                                    "string"
                                  ],
                                  "thumbnailUrl": "string",
                                  "documentationUrl": "string",
                                  "latestRevisionId": "string",
                                  "createdAt": "string",
                                  "updatedAt": "string",
                                  "modelFamily": "string",
                                  "framework": "string",
                                  "frameworkKind": "official",
                                  "isOfficialDefault": false
                                }
                              }
                              Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1
                              Previous

                              GET /model-image-definitions

                              Next

                              GET /model-image-definitions/{modelImageDefinitionId}

                              curl -X POST 'https://api.embodiflow.io/v1/model-image-definitions' \
                                -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
                                -H 'Content-Type: application/json' \
                                -d '{
                                  "projectId": "00000000-0000-0000-0000-000000000000",
                                  "code": "string",
                                  "name": "string",
                                  "description": "string",
                                  "imageKind": "training",
                                  "category": "string",
                                  "tags": [
                                    "string"
                                  ],
                                  "imageRef": "string",
                                  "runnerContractVersion": "string",
                                  "paramSchema": {},
                                  "outputSchema": {},
                                  "resourceDefaults": {},
                                  "minGpuMemoryGb": 0,
                                  "recommendedGpuMemoryGb": 0,
                                  "maxGpuCount": 0,
                                  "supportsMultiGpu": true,
                                  "frameworkTags": [
                                    "string"
                                  ],
                                  "registryServer": "string",
                                  "registryUsername": "string",
                                  "registryPassword": "string"
                                }'
                              Response example
                              Status code
                              201
                              ​
                              {
                                "data": {
                                  "id": "string",
                                  "tenantId": "string",
                                  "projectId": "string",
                                  "code": "string",
                                  "name": "string",
                                  "description": "string",
                                  "imageKind": "training",
                                  "status": "string",
                                  "ownerType": "string",
                                  "systemSlug": "string",
                                  "category": "string",
                                  "tags": [
                                    "string"
                                  ],
                                  "thumbnailUrl": "string",
                                  "documentationUrl": "string",
                                  "latestRevisionId": "string",
                                  "createdAt": "string",
                                  "updatedAt": "string",
                                  "modelFamily": "string",
                                  "framework": "string",
                                  "frameworkKind": "official",
                                  "isOfficialDefault": false
                                }
                              }