Headers

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

Params

Param name Description
drop_folder_id
required

Drop Folder 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

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

// Successful request
POST /api/v2/drop_folders/50/assets/incoming
{
  "title": "Title",
  "description": "Desc",
  "category": "category",
  "tags": [
    "tag",
    "tag2"
  ]
}
200
{
  "asset": {
    "id": "gTbzYtmxC4ZaaRSLH0xl",
    "external_id": null,
    "parent_id": null,
    "project_id": null,
    "owner": "admin-user-149@example.com",
    "title": "Title",
    "description": "Desc",
    "category": "category",
    "tags": [
      "tag",
      "tag2"
    ],
    "ai_tags": [],
    "status": "open",
    "media_type": "placeholder",
    "original_filename": null,
    "drop_folder_id": 50,
    "md5_sum": null,
    "created_date": "2023-11-27T09:43:09.943Z",
    "modification_date": "2023-11-27T09:43:09.999Z",
    "deleted": null
  }
}
// Missing parameter
POST /api/v2/drop_folders/51/assets/incoming
{
  "description": "Desc",
  "category": "category",
  "tags": [
    "tag",
    "tag2"
  ]
}
422
{
  "error": "Missing parameter title"
}
// Nonexistant Drop Folder ID
POST /api/v2/drop_folders/non-functioning-id/assets/incoming
{
  "title": "Title",
  "description": "Desc",
  "category": "category",
  "tags": [
    "tag",
    "tag2"
  ]
}
404
{
  "error": "dropfolder not found"
}

Errors

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