# Assets

## Create an asset upload

**post** `/assets`

Creates an asset from a source string. Pass source="signed-url" to reserve a direct upload URL, or pass an allowlisted HTTPS URL for server-side fetch. Mutating public API requests support an optional Idempotency-Key header for client retries; duplicate keys within two hours return idempotency_duplicate.

### Body Parameters

- `source: string`

  Asset source as a string: either "signed-url" to reserve a direct upload URL, or an allowlisted HTTPS URL for server-side fetch.

- `workspace_id: string`

  Workspace identifier. Use the public API ID returned by list workspaces; it must start with ws_.

- `content_type: optional string`

  Asset content type

- `file_name: optional string`

  Asset file name

- `folder: optional string`

  Destination folder

### Returns

- `asset_id: string`

  Asset identifier

- `status: "pending_upload" or "ready" or "failed"`

  - `"pending_upload"`

  - `"ready"`

  - `"failed"`

- `uploaded_via: "url" or "signed_url"`

  Asset source

  - `"url"`

  - `"signed_url"`

- `url: string`

  Asset URL

- `visibility: "workspace"`

  - `"workspace"`

- `workspace_id: string`

  Workspace identifier

- `expires_at: optional string`

  Expiration time for the upload URL

- `upload: optional object { content_type, file_field, form_fields, 2 more }`

  - `content_type: "multipart/form-data"`

    - `"multipart/form-data"`

  - `file_field: "file"`

    - `"file"`

  - `form_fields: map[string]`

    Upload form fields

  - `method: "POST"`

    - `"POST"`

  - `url: string`

    Upload URL

- `upload_url: optional string`

  Upload URL (serialized)

### Example

```http
curl https://app.flora.ai/api/v1/assets \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $FLORA_API_KEY" \
    -d '{
          "source": "signed-url",
          "workspace_id": "ws_abc123"
        }'
```

#### Response

```json
{
  "asset_id": "asset_abc123",
  "status": "pending_upload",
  "uploaded_via": "url",
  "url": "https://example.com",
  "visibility": "workspace",
  "workspace_id": "ws_abc123",
  "expires_at": "2019-12-27T18:11:19.117Z",
  "upload": {
    "content_type": "multipart/form-data",
    "file_field": "file",
    "form_fields": {
      "foo": "string"
    },
    "method": "POST",
    "url": "https://example.com"
  },
  "upload_url": "https://upload.imagekit.io/api/v1/files/upload"
}
```

## Complete a signed asset upload

**post** `/assets/{assetId}/complete`

Marks a signed asset upload as complete after the file has been uploaded. Mutating public API requests support an optional Idempotency-Key header for client retries; duplicate keys within two hours return idempotency_duplicate.

### Path Parameters

- `assetId: string`

  Asset identifier

### Returns

- `asset_id: string`

  Asset identifier

- `status: "pending_upload" or "ready" or "failed"`

  - `"pending_upload"`

  - `"ready"`

  - `"failed"`

- `url: string`

  Asset URL

- `visibility: "workspace"`

  - `"workspace"`

- `workspace_id: string`

  Workspace identifier

- `expires_at: optional string`

  Expiration time for the upload URL

- `failure_message: optional string`

  Failure message when the asset is in failed status

- `upload: optional object { content_type, file_field, form_fields, 2 more }`

  - `content_type: "multipart/form-data"`

    - `"multipart/form-data"`

  - `file_field: "file"`

    - `"file"`

  - `form_fields: map[string]`

    Upload form fields

  - `method: "POST"`

    - `"POST"`

  - `url: string`

    Upload URL

- `upload_url: optional string`

  Upload URL (serialized)

### Example

```http
curl https://app.flora.ai/api/v1/assets/$ASSET_ID/complete \
    -X POST \
    -H "Authorization: Bearer $FLORA_API_KEY"
```

#### Response

```json
{
  "asset_id": "asset_abc123",
  "status": "pending_upload",
  "url": "https://example.com",
  "visibility": "workspace",
  "workspace_id": "ws_abc123",
  "expires_at": "2019-12-27T18:11:19.117Z",
  "failure_message": "failure_message",
  "upload": {
    "content_type": "multipart/form-data",
    "file_field": "file",
    "form_fields": {
      "foo": "string"
    },
    "method": "POST",
    "url": "https://example.com"
  },
  "upload_url": "https://upload.imagekit.io/api/v1/files/upload"
}
```

## Retry a signed asset upload

**post** `/assets/{assetId}/retry`

Creates a fresh signed upload reservation for a failed or expired asset upload. Mutating public API requests support an optional Idempotency-Key header for client retries; duplicate keys within two hours return idempotency_duplicate.

### Path Parameters

- `assetId: string`

  Asset identifier

### Returns

- `asset_id: string`

  Asset identifier

- `status: "pending_upload" or "ready" or "failed"`

  - `"pending_upload"`

  - `"ready"`

  - `"failed"`

- `url: string`

  Asset URL

- `visibility: "workspace"`

  - `"workspace"`

- `workspace_id: string`

  Workspace identifier

- `expires_at: optional string`

  Expiration time for the upload URL

- `failure_message: optional string`

  Failure message when the asset is in failed status

- `upload: optional object { content_type, file_field, form_fields, 2 more }`

  - `content_type: "multipart/form-data"`

    - `"multipart/form-data"`

  - `file_field: "file"`

    - `"file"`

  - `form_fields: map[string]`

    Upload form fields

  - `method: "POST"`

    - `"POST"`

  - `url: string`

    Upload URL

- `upload_url: optional string`

  Upload URL (serialized)

### Example

```http
curl https://app.flora.ai/api/v1/assets/$ASSET_ID/retry \
    -X POST \
    -H "Authorization: Bearer $FLORA_API_KEY"
```

#### Response

```json
{
  "asset_id": "asset_abc123",
  "status": "pending_upload",
  "url": "https://example.com",
  "visibility": "workspace",
  "workspace_id": "ws_abc123",
  "expires_at": "2019-12-27T18:11:19.117Z",
  "failure_message": "failure_message",
  "upload": {
    "content_type": "multipart/form-data",
    "file_field": "file",
    "form_fields": {
      "foo": "string"
    },
    "method": "POST",
    "url": "https://example.com"
  },
  "upload_url": "https://upload.imagekit.io/api/v1/files/upload"
}
```

## List assets

**get** `/assets`

Returns assets visible to the authenticated public API key. Filter by workspace, project canvas, search query, cursor, and limit without exposing raw file bytes or internal graph data.

### Query Parameters

- `cursor: optional string`

  Opaque cursor for fetching the next page

- `limit: optional number`

  Maximum number of results to return

- `project_id: optional string`

  Project identifier

- `query: optional string`

  Search query

- `workspace_id: optional string`

  Workspace identifier

### Returns

- `assets: array of object { asset_id, content_type, created_at, 12 more }`

  - `asset_id: string`

    Asset identifier

  - `content_type: string`

    Asset content type

  - `created_at: number`

  - `description: string`

    Asset description

  - `height: number`

  - `name: string`

    Asset name

  - `size_bytes: number`

  - `status: "pending_upload" or "ready" or "failed"`

    - `"pending_upload"`

    - `"ready"`

    - `"failed"`

  - `upload_content_type: string`

    Content type provided at upload time

  - `uploaded_via: string`

    Asset source

  - `url: string`

    Asset URL

  - `width: number`

  - `workspace_id: string`

    Workspace identifier

  - `node_id: optional string`

    Associated node identifier

  - `project_id: optional string`

    Project identifier

- `meta: object { next_cursor, total_estimate }`

  - `next_cursor: string`

    Opaque cursor for fetching the next page

  - `total_estimate: optional number`

    Estimated total matching items

### Example

```http
curl https://app.flora.ai/api/v1/assets \
    -H "Authorization: Bearer $FLORA_API_KEY"
```

#### Response

```json
{
  "assets": [
    {
      "asset_id": "asset_abc123",
      "content_type": "content_type",
      "created_at": 0,
      "description": "description",
      "height": 0,
      "name": "name",
      "size_bytes": 0,
      "status": "pending_upload",
      "upload_content_type": "upload_content_type",
      "uploaded_via": "uploaded_via",
      "url": "url",
      "width": 0,
      "workspace_id": "ws_abc123",
      "node_id": "node_abc123",
      "project_id": "prj_abc123"
    }
  ],
  "meta": {
    "next_cursor": "eyJvZmZzZXQiOjIwfQ",
    "total_estimate": 0
  }
}
```

## Get an asset

**get** `/assets/{assetId}`

Returns metadata for one asset when it is accessible to the authenticated public API key. Missing and inaccessible assets both return 404.

### Path Parameters

- `assetId: string`

  Asset identifier

### Returns

- `asset_id: string`

  Asset identifier

- `content_type: string`

  Asset content type

- `created_at: string`

  Asset creation time (ISO 8601 datetime)

- `description: string`

  Asset description

- `failure_message: string`

  Failure message when the asset is in failed status

- `height: number`

- `name: string`

  Asset name

- `size_bytes: number`

- `status: "pending_upload" or "ready" or "failed"`

  - `"pending_upload"`

  - `"ready"`

  - `"failed"`

- `upload_content_type: string`

  Content type provided at upload time

- `uploaded_via: string`

  Asset source

- `url: string`

  Asset URL

- `width: number`

- `workspace_id: string`

  Workspace identifier

### Example

```http
curl https://app.flora.ai/api/v1/assets/$ASSET_ID \
    -H "Authorization: Bearer $FLORA_API_KEY"
```

#### Response

```json
{
  "asset_id": "asset_abc123",
  "content_type": "content_type",
  "created_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "failure_message": "failure_message",
  "height": 0,
  "name": "name",
  "size_bytes": 0,
  "status": "pending_upload",
  "upload_content_type": "upload_content_type",
  "uploaded_via": "uploaded_via",
  "url": "url",
  "width": 0,
  "workspace_id": "ws_abc123"
}
```

## Domain Types

### Asset Create Response

- `AssetCreateResponse object { asset_id, status, uploaded_via, 6 more }`

  - `asset_id: string`

    Asset identifier

  - `status: "pending_upload" or "ready" or "failed"`

    - `"pending_upload"`

    - `"ready"`

    - `"failed"`

  - `uploaded_via: "url" or "signed_url"`

    Asset source

    - `"url"`

    - `"signed_url"`

  - `url: string`

    Asset URL

  - `visibility: "workspace"`

    - `"workspace"`

  - `workspace_id: string`

    Workspace identifier

  - `expires_at: optional string`

    Expiration time for the upload URL

  - `upload: optional object { content_type, file_field, form_fields, 2 more }`

    - `content_type: "multipart/form-data"`

      - `"multipart/form-data"`

    - `file_field: "file"`

      - `"file"`

    - `form_fields: map[string]`

      Upload form fields

    - `method: "POST"`

      - `"POST"`

    - `url: string`

      Upload URL

  - `upload_url: optional string`

    Upload URL (serialized)

### Asset Complete Response

- `AssetCompleteResponse object { asset_id, status, url, 6 more }`

  - `asset_id: string`

    Asset identifier

  - `status: "pending_upload" or "ready" or "failed"`

    - `"pending_upload"`

    - `"ready"`

    - `"failed"`

  - `url: string`

    Asset URL

  - `visibility: "workspace"`

    - `"workspace"`

  - `workspace_id: string`

    Workspace identifier

  - `expires_at: optional string`

    Expiration time for the upload URL

  - `failure_message: optional string`

    Failure message when the asset is in failed status

  - `upload: optional object { content_type, file_field, form_fields, 2 more }`

    - `content_type: "multipart/form-data"`

      - `"multipart/form-data"`

    - `file_field: "file"`

      - `"file"`

    - `form_fields: map[string]`

      Upload form fields

    - `method: "POST"`

      - `"POST"`

    - `url: string`

      Upload URL

  - `upload_url: optional string`

    Upload URL (serialized)

### Asset Retry Response

- `AssetRetryResponse object { asset_id, status, url, 6 more }`

  - `asset_id: string`

    Asset identifier

  - `status: "pending_upload" or "ready" or "failed"`

    - `"pending_upload"`

    - `"ready"`

    - `"failed"`

  - `url: string`

    Asset URL

  - `visibility: "workspace"`

    - `"workspace"`

  - `workspace_id: string`

    Workspace identifier

  - `expires_at: optional string`

    Expiration time for the upload URL

  - `failure_message: optional string`

    Failure message when the asset is in failed status

  - `upload: optional object { content_type, file_field, form_fields, 2 more }`

    - `content_type: "multipart/form-data"`

      - `"multipart/form-data"`

    - `file_field: "file"`

      - `"file"`

    - `form_fields: map[string]`

      Upload form fields

    - `method: "POST"`

      - `"POST"`

    - `url: string`

      Upload URL

  - `upload_url: optional string`

    Upload URL (serialized)

### Asset List Response

- `AssetListResponse object { asset_id, content_type, created_at, 12 more }`

  - `asset_id: string`

    Asset identifier

  - `content_type: string`

    Asset content type

  - `created_at: number`

  - `description: string`

    Asset description

  - `height: number`

  - `name: string`

    Asset name

  - `size_bytes: number`

  - `status: "pending_upload" or "ready" or "failed"`

    - `"pending_upload"`

    - `"ready"`

    - `"failed"`

  - `upload_content_type: string`

    Content type provided at upload time

  - `uploaded_via: string`

    Asset source

  - `url: string`

    Asset URL

  - `width: number`

  - `workspace_id: string`

    Workspace identifier

  - `node_id: optional string`

    Associated node identifier

  - `project_id: optional string`

    Project identifier

### Asset Retrieve Response

- `AssetRetrieveResponse object { asset_id, content_type, created_at, 11 more }`

  - `asset_id: string`

    Asset identifier

  - `content_type: string`

    Asset content type

  - `created_at: string`

    Asset creation time (ISO 8601 datetime)

  - `description: string`

    Asset description

  - `failure_message: string`

    Failure message when the asset is in failed status

  - `height: number`

  - `name: string`

    Asset name

  - `size_bytes: number`

  - `status: "pending_upload" or "ready" or "failed"`

    - `"pending_upload"`

    - `"ready"`

    - `"failed"`

  - `upload_content_type: string`

    Content type provided at upload time

  - `uploaded_via: string`

    Asset source

  - `url: string`

    Asset URL

  - `width: number`

  - `workspace_id: string`

    Workspace identifier