POST /api/v2/projects/:project_id/assets
Create a new asset to project

Headers

Header name	Description
Content-Type required	application/json
X-API-KEY required	YOUR_API_KEY

Params

Param name	Description
project_id required	Project ID Validations: Must be a String
title required	Title Validations: Must be a String
description optional	Description Validations: Must be a String
category optional	Category Validations: Must be a String
tags optional	Tags Validations: Must be an array of String
external_id optional	External ID Validations: Must be a String
media_type optional	Type. During asset creation, only used for articles. Defaults to placeholder with no media. Validations: Must be one of: article.
url optional	Media from URL Validations: Must be a Hash
url[file_url] required	File URL Validations: Must be a String
url[filename] required	Filename Validations: Must be a String
s3 optional	Media from S3 Validations: Must be a Hash
s3[s3_key] required	File URL Validations: Must be a String
s3[filename] required	Filename Validations: Must be a String

Examples

// Failed request
POST /api/v2/projects/not-found-id/assets
404
{
  "error": "project not found"
}

// Failed request, missing required "title" parameter
POST /api/v2/projects/M3v-xrSG70BGtqli0xy7/assets
{
  "description": "Sample asset from API V2",
  "category": "Sample",
  "tags": [
    "sample",
    "test"
  ]
}
422
{
  "error": "Missing parameter title"
}

// Failed request, invalid media type
POST /api/v2/projects/qehefpq_b_S2POV3_YTf/assets
{
  "title": "Sample Asset",
  "description": "Sample asset from API V2",
  "category": "Sample",
  "tags": [
    "sample",
    "test"
  ],
  "media_type": "image"
}
422
{
  "error": "Invalid parameter 'media_type' value \"image\": Must be one of: <code>article</code>."
}

// Successful request without media
POST /api/v2/projects/DtialUGXI36apS40-0cE/assets
{
  "title": "Sample Asset",
  "description": "Sample asset from API V2",
  "category": "Sample",
  "tags": [
    "sample",
    "test"
  ]
}
200
{
  "asset": {
    "id": "v_Fa1CZTS56Vkgdoyo4e",
    "external_id": null,
    "parent_id": null,
    "project_id": "DtialUGXI36apS40-0cE",
    "owner": "admin-user-253@example.com",
    "title": "Sample Asset",
    "description": "Sample asset from API V2",
    "category": "sample",
    "tags": [
      "sample",
      "test"
    ],
    "ai_tags": [],
    "status": "open",
    "media_type": "placeholder",
    "original_filename": null,
    "drop_folder_id": null,
    "md5_sum": null,
    "created_date": "2023-11-27T09:43:34.166Z",
    "modification_date": "2023-11-27T09:43:34.223Z",
    "deleted": null
  }
}

// Successful request for article
POST /api/v2/projects/RDYDzeg1NxHJFf7qJMMv/assets
{
  "title": "Sample Asset",
  "description": "Sample asset from API V2",
  "category": "Sample",
  "tags": [
    "sample",
    "test"
  ],
  "media_type": "article"
}
200
{
  "asset": {
    "id": "Yr6Bnp1zBqP0RdSi8p1K",
    "external_id": null,
    "parent_id": null,
    "project_id": "RDYDzeg1NxHJFf7qJMMv",
    "owner": "admin-user-254@example.com",
    "title": "Sample Asset",
    "description": "Sample asset from API V2",
    "category": "sample",
    "tags": [
      "sample",
      "test"
    ],
    "ai_tags": [],
    "status": "open",
    "media_type": "article",
    "original_filename": null,
    "drop_folder_id": null,
    "md5_sum": null,
    "created_date": "2023-11-27T09:43:34.545Z",
    "modification_date": "2023-11-27T09:43:34.725Z",
    "deleted": null
  }
}

// Successful request with HTTP file URL
POST /api/v2/projects/s_N169fyG8lY-sFjGGJ9/assets
{
  "title": "Sample Asset",
  "description": "Sample asset from API V2",
  "category": "Sample",
  "tags": [
    "sample",
    "test"
  ],
  "url": {
    "file_url": "http://www.example.com/jpgfile.jpg",
    "filename": "jpgfile.jpg"
  }
}
200
{
  "asset": {
    "id": "McC66LDIygdLGTdqRs9E",
    "external_id": null,
    "parent_id": null,
    "project_id": "s_N169fyG8lY-sFjGGJ9",
    "owner": "admin-user-255@example.com",
    "title": "Sample Asset",
    "description": "Sample asset from API V2",
    "category": "sample",
    "tags": [
      "sample",
      "test"
    ],
    "ai_tags": [],
    "status": "open",
    "media_type": "processing",
    "original_filename": "jpgfile.jpg",
    "drop_folder_id": null,
    "md5_sum": null,
    "created_date": "2023-11-27T09:43:35.050Z",
    "modification_date": "2023-11-27T09:43:35.194Z",
    "deleted": null
  }
}

// Successful request with HTTPS file URL
POST /api/v2/projects/LtOOWFo7cxi-ob7PeT8w/assets
{
  "title": "Sample Asset",
  "description": "Sample asset from API V2",
  "category": "Sample",
  "tags": [
    "sample",
    "test"
  ],
  "url": {
    "file_url": "https://www.example.com/jpgfile.jpg",
    "filename": "jpgfile.jpg"
  }
}
200
{
  "asset": {
    "id": "eGsHkJULCQHevHyiw4lZ",
    "external_id": null,
    "parent_id": null,
    "project_id": "LtOOWFo7cxi-ob7PeT8w",
    "owner": "admin-user-256@example.com",
    "title": "Sample Asset",
    "description": "Sample asset from API V2",
    "category": "sample",
    "tags": [
      "sample",
      "test"
    ],
    "ai_tags": [],
    "status": "open",
    "media_type": "processing",
    "original_filename": "jpgfile.jpg",
    "drop_folder_id": null,
    "md5_sum": null,
    "created_date": "2023-11-27T09:43:35.523Z",
    "modification_date": "2023-11-27T09:43:35.646Z",
    "deleted": null
  }
}

// Invalid file URL
POST /api/v2/projects/IChVAhYnVIBcwdQr-8Me/assets
{
  "title": "Sample Asset",
  "description": "Sample asset from API V2",
  "category": "Sample",
  "tags": [
    "sample",
    "test"
  ],
  "url": {
    "file_url": "/local/downloads/myfile.jpg",
    "filename": "jpgfile.jpg"
  }
}
400
{
  "error": "Asset t5_jeMYGzfkYEdDNzbI9 created, adding media to asset failed: not a valid HTTP URL"
}

Errors

Code	Description
401	Unauthorized
404	Not found
500	Internal Server Error
422	Missing parameters