Create asset

Create an asset.

POST /v0/assets

Create asset

cURL

curl --request POST \
  --url https://api.tryarchitect.com/v0/assets \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "assetType": "<string>",
  "name": "<string>",
  "purpose": "",
  "fileId": "<string>",
  "parentAssetId": "<string>",
  "idempotencyKey": "<string>",
  "hidden": true
}
'

201

{
  "assetId": "<string>",
  "tenantId": "<string>",
  "name": "<string>",
  "purpose": "<string>",
  "tags": [
    "<string>"
  ],
  "aiDescription": "<string>",
  "parentAssetId": "<string>",
  "hidden": true,
  "data": {
    "type": "<string>",
    "fileId": "<string>"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "trashedAt": "<string>",
  "deletedAt": "<string>",
  "downloadUrl": "<string>",
  "previewDownloadUrl": "<string>"
}

Authorizations

x-api-key · string · header · required

API key authentication for the External Actor Gateway

Body

application/json

Option 1

Option 2

Option 3

Option 4

assetType · string · required

Allowed value: "image"

name · string · required

purpose · string · default: "" · required

fileId · string · required

parentAssetId · string

idempotencyKey · string

Required string length: 1 - 255

hidden · boolean

Response

201

application/json

Asset created successfully

assetId · string · required

tenantId · string · required

name · string · required

purpose · string · required

tags · string[] · required

aiDescription · string | null · required

parentAssetId · string | null · required

hidden · boolean · required

data · object · required

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

createdAt · string · required

Pattern: ^\+[1-9]\d{1,14}$

updatedAt · string · required

Pattern: ^\+[1-9]\d{1,14}$

trashedAt · string | null · required

Pattern: ^\+[1-9]\d{1,14}$

deletedAt · string | null · required

Pattern: ^\+[1-9]\d{1,14}$

lifecycleState · enum<string> · required

Available options: active, trashed, deleted

downloadUrl · string | null · required

previewDownloadUrl · string | null · required