Create a draft

Create a pinned draft, or import an exact canonical scenario document. An Idempotency-Key header makes it one draft per key in the workspace: a repeat with the same request answers that draft, and the key with another request, or whose draft was deleted, is 409 idempotency_conflict.

POST /api/v1/drafts

Create a draft

cURL

curl --request POST \
  --url https://dev.simforge.ai/api/v1/drafts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "mapId": "<string>",
  "mapReleaseDigest": "<string>",
  "datasetId": "<string>",
  "clipSeconds": 61.5,
  "createdAt": "<string>",
  "content": {},
  "contentDigest": "<string>",
  "provisional": true
}
'

200

{
  "documentId": "<string>",
  "workspaceId": "<string>",
  "datasetId": "<string>",
  "draftVersion": 1,
  "contentDigest": "<string>",
  "operationDigest": "<string>",
  "content": {},
  "mapPin": {
    "versionId": "<string>",
    "mapId": "<string>",
    "xodrSha256": "<string>",
    "closureSha256": "<string>",
    "assetCatalogVersionId": "<string>",
    "assetCatalogSha256": "<string>",
    "releaseDigest": "<string>"
  },
  "actorPins": [
    {
      "actorId": "<string>",
      "catalogId": "<string>",
      "class": "<string>",
      "catalogueDigest": "<string>"
    }
  ],
  "recordingPins": [
    {
      "id": "<string>",
      "sha256": "<string>"
    }
  ],
  "provisional": true,
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>",
      "subject": "<string>",
      "detail": {}
    }
  ],
  "upgradedFrom": {
    "scenarioVersion": 123,
    "contentDigest": "<string>"
  }
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Headers

Idempotency-Key · string

Required string length: 1 - 200

Body

application/json

name · string · required

Required string length: 1 - 256

mapId · string

Required string length: 1 - 256

mapReleaseDigest · string

Pattern: ^[a-f0-9]{64}$

datasetId · string

Required string length: 1 - 256

clipSeconds · number

Required range: 3 <= x <= 120

createdAt · string

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

content · object

Show child attributes

contentDigest · string

Pattern: ^[a-f0-9]{64}$

provisional · boolean

Response

200

application/json

The draft: created, or the one an earlier request with this Idempotency-Key made.

documentId · string · required

Required string length: 1 - 256

workspaceId · string · required

Required string length: 1 - 256

datasetId · string · required

Required string length: 1 - 256

draftVersion · integer · required

Required range: x >= 0

contentDigest · string · required

Pattern: ^[a-f0-9]{64}$

operationDigest · string · required

Pattern: ^[a-f0-9]{64}$

content · object · required

Show child attributes

mapPin · object · required

Show child attributes

actorPins · object[] · required

Show child attributes

recordingPins · object[] · required

Show child attributes

provisional · boolean · required

warnings · object[]

Show child attributes

upgradedFrom · object

Show child attributes

{key} · any