Skip to main content
POST
/
v0
/
assets
Create asset
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
}
'
{
  "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
​
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

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
​
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