Get the project annotation schema

GET

/v1/projects/{projectId}/annotation-schema

curl -X GET 'https://api.embodiflow.io/v1/projects/{projectId}/annotation-schema' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

projectIdstringrequired

Responses

Success

dataobjectrequired
- versionnumberrequired
  Allowed values
  1
- languagesarray<string>required
- fieldsobjectrequired
- subtaskLabelsarray<object>required
- attributesarray<object>required
- requireReviewone ofrequired
- allowEpisodeOverlapone ofrequired
- taskListarray<object>required

Response example

{
  "data": {
    "version": 1,
    "languages": "en",
    "fields": {
      "task": {
        "enabled": false
      },
      "outcome": {
        "enabled": false
      },
      "subtasks": {
        "enabled": false
      },
      "subtaskOutcome": {
        "enabled": false
      },
      "relevance": {
        "enabled": false
      },
      "keyframeBoxes": {
        "enabled": false
      }
    },
    "subtaskLabels": [
      {
        "en": "string",
        "zh": "string"
      }
    ],
    "attributes": [
      {
        "key": "string",
        "type": "number",
        "options": [
          "string"
        ]
      }
    ],
    "requireReview": false,
    "allowEpisodeOverlap": false,
    "taskList": [
      {
        "en": "string",
        "zh": "string"
      }
    ]
  }
}

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

{ "data": { "version": 1, "languages": "en", "fields": { "task": { "enabled": false }, "outcome": { "enabled": false }, "subtasks": { "enabled": false }, "subtaskOutcome": { "enabled": false }, "relevance": { "enabled": false }, "keyframeBoxes": { "enabled": false } }, "subtaskLabels": [ { "en": "string", "zh": "string" } ], "attributes": [ { "key": "string", "type": "number", "options": [ "string" ] } ], "requireReview": false, "allowEpisodeOverlap": false, "taskList": [ { "en": "string", "zh": "string" } ] } }