Patch version name, readme, and licence

PATCH

/v1/projects/{projectId}/versions/{versionNumber}

curl -X PATCH 'https://api.embodiflow.io/v1/projects/{projectId}/versions/{versionNumber}' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "readmeMd": "string",
    "licence": "string"
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

projectIdstringrequired
versionNumbernumberrequired

Header parameters

If-Matchstring
Optional precondition. A matching tag proceeds and returns the new ETag. A stale tag returns 412 PRECONDITION_FAILED with no write. Absent proceeds (opt-in this release). If-Match: * succeeds when the resource exists. Malformed values return 400 IF_MATCH_INVALID.

Request body

Content-Typeapplication/json

namestring
readmeMdstring | null
licencestring | null

Responses

Success

dataobjectrequired
- idstringrequired
- projectIdstringrequired
- numbernumberrequired
- namestringrequired
- readmeMdstring | nullrequired
- licencestring | nullrequired
- splitobjectrequired
- preprocessingobjectrequired
- featureSchemaobjectrequired
- conventionsobjectrequired
- labelPolicystringrequired
  Allowed values
  current
  approved_only
- episodeCountnumberrequired
- trainCountnumberrequired
- valCountnumberrequired
- testCountnumberrequired
- totalDurationNsnumberrequired
- digeststringrequired
- dataContractDigeststring | nullrequired
- refstringrequired
- urlstringrequired
- aliasesarray<string>required
- createdAtstringrequired
- createdByDisplayNamestring | nullrequired
- dataKindstringrequired
  Allowed values
  human
  robot
  video
- updatedAtstringrequired
- rowVersionnumberrequired
- excludedobjectrequired
- storageobjectrequired

Response example

{
  "data": {
    "id": "string",
    "projectId": "string",
    "number": 0,
    "name": "string",
    "readmeMd": "string",
    "licence": "string",
    "split": {
      "strategy": "recording",
      "ratios": {
        "train": 0,
        "val": 0,
        "test": 0
      },
      "seed": 0
    },
    "preprocessing": {
      "fps": 0,
      "cameraKeys": [
        "string"
      ],
      "trimIdle": false,
      "maxDurationS": 0,
      "padMs": 0
    },
    "featureSchema": {
      "fps": 0,
      "cameraKeys": [
        "string"
      ],
      "features": {}
    },
    "conventions": {
      "version": "embodiflow-data-conventions/v1",
      "frames": {},
      "features": {},
      "sourceClocks": {},
      "stereoPairs": [
        {
          "left": "string",
          "right": "string",
          "baselineM": 0,
          "source": "unknown"
        }
      ],
      "timeOffsets": {}
    },
    "labelPolicy": "current",
    "episodeCount": 0,
    "trainCount": 0,
    "valCount": 0,
    "testCount": 0,
    "totalDurationNs": 0,
    "digest": "string",
    "dataContractDigest": "string",
    "ref": "string",
    "url": "string",
    "aliases": [
      "string"
    ],
    "createdAt": "string",
    "createdByDisplayName": "string",
    "dataKind": "human",
    "updatedAt": "string",
    "rowVersion": 0,
    "excluded": {
      "failing": 0,
      "incomplete": 0,
      "deleted": 0,
      "notAnonymized": 0,
      "noApprovedRevision": 0,
      "excludedFlag": 0
    },
    "storage": {
      "logicalBytes": 0,
      "storedBytes": 0,
      "treeState": "none"
    }
  }
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1

curl -X PATCH 'https://api.embodiflow.io/v1/projects/{projectId}/versions/{versionNumber}' \ -H 'Authorization: Bearer $EMBODIFLOW_PAT' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "readmeMd": "string", "licence": "string" }'

{ "data": { "id": "string", "projectId": "string", "number": 0, "name": "string", "readmeMd": "string", "licence": "string", "split": { "strategy": "recording", "ratios": { "train": 0, "val": 0, "test": 0 }, "seed": 0 }, "preprocessing": { "fps": 0, "cameraKeys": [ "string" ], "trimIdle": false, "maxDurationS": 0, "padMs": 0 }, "featureSchema": { "fps": 0, "cameraKeys": [ "string" ], "features": {} }, "conventions": { "version": "embodiflow-data-conventions/v1", "frames": {}, "features": {}, "sourceClocks": {}, "stereoPairs": [ { "left": "string", "right": "string", "baselineM": 0, "source": "unknown" } ], "timeOffsets": {} }, "labelPolicy": "current", "episodeCount": 0, "trainCount": 0, "valCount": 0, "testCount": 0, "totalDurationNs": 0, "digest": "string", "dataContractDigest": "string", "ref": "string", "url": "string", "aliases": [ "string" ], "createdAt": "string", "createdByDisplayName": "string", "dataKind": "human", "updatedAt": "string", "rowVersion": 0, "excluded": { "failing": 0, "incomplete": 0, "deleted": 0, "notAnonymized": 0, "noApprovedRevision": 0, "excludedFlag": 0 }, "storage": { "logicalBytes": 0, "storedBytes": 0, "treeState": "none" } } }