Create Asset

• Endpoints
• Response Structure
  • Versions
• Response Example
  • Success
  • Errors
• Request Parameters
• Request Example

The /asset endpoint of the Disguise Cloud Drive API allows you to create a new asset within a specified drive and parent folder. An asset represents a file within a drive.

For instructions on how to upload an asset, please see How to Upload.

Endpoints

Response Structure

A successful response from the /asset endpoint will be the same as the Content endpoint, but without the pagination wrapper.

Versions

Response Example

curl -X POST https://drive-api.disguise.cloud/v1/drives/{{drive_id}}/content/{{content_id}}/asset \
-H "Authorization: Token YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "name": "My Asset",
  "file_extension": "png",
  "upload_uuid": "5c43e95e-11da-4a3b-953f-e0d0452f26dd"
}'

Success

A successful response will return a 201 Created with the following JSON:

Please Note: After an asset is uploaded, it will be processed. This will result in a file type
and a status of pending until the processing is complete, and is expected behaviour.
Once processing is complete, the asset will update to the proper type (such as image) with a
status of active.

{
  "id": "a1862761-3966-467a-a74e-adc98d7c563c",
  "drive_id": "3b5b9cab-073d-416a-bcf1-f2b3154fb0ee",
  "parent_id": "c71df693-d1ff-461d-9da6-b9f1ee9c6748",
  "name": "My Asset.png",
  "versions": [
    {
      "id": "67f4a888-1eac-422a-88bb-4514e5d4ec92",
      "asset_id": "a1862761-3966-467a-a74e-adc98d7c563c",
      "label": null,
      "thumbnail": null,
      "version_number": 1,
      "filesize_bytes": null,
      "type": "file",
      "status": "pending",
      "url": "{{file_url}}",
      "is_active": true,
      "created_at": "2024-12-10T18:28:49.000000Z",
      "updated_at": "2024-12-10T18:28:49.000000Z",
      "uploaded_by_user": "e4686083-413d-49df-ad02-0f000fbf7be1",
      "uploaded_by_user_status": "active"
    }
  ],
  "is_locked": null,
  "locked_by_id": null,
  "uploaded_by_id": "e4686083-413d-49df-ad02-0f000fbf7be1",
  "url": "{{file_url}}",
  "format": null,
  "thumbnail": null,
  "thumbnail_tiny": null,
  "type": "file",
  "length": null,
  "width": null,
  "height": null,
  "dimensions": null,
  "size_bytes": null,
  "status": "pending",
  "meta": null,
  "file_extension": "png",
  "is_shared": false,
  "share_slug": null,
  "share_url": null,
  "description": null,
  "created_at": "2024-12-10T18:28:49.000000Z",
  "updated_at": "2024-12-10T18:28:49.000000Z",
  "children": null
}

Errors

If the drive is not found, the API will return a 404 Not Found status code and the following JSON:

{
  "error": {
    "message": "Drive not found",
    "details": "Drive not found"
  }
}

If the parent folder is not found, the API will return a 404 Not Found status code and the following JSON:

{
  "error": {
    "message": "Parent folder not found",
    "details": "Parent folder not found"
  }
}

If you try to create an asset before uploading a file, the API will return a 400 Bad Request status code and the following JSON:

{
  "error": {
    "message": "Asset not found in storage",
    "details": "Please ensure the upload_uuid is correct and the file is uploaded"
  }
}

Request Parameters

The following parameters can be used with the /asset endpoint for POST requests:

Request Example

Below is an example of making a POST request to the /asset endpoint to create a new asset within a drive and parent folder:

curl -X POST https://drive-api.disguise.cloud/v1/drives/{{drive_id}}/content/{{content_id}}/asset \
-H "Authorization: Token YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "name": "My Asset",
  "file_extension": "png",
  "upload_uuid": "5c43e95e-11da-4a3b-953f-e0d0452f26dd"
}'