Attachments

>>>

GET /api/v2/assets/:asset_id/attachments
Get attachments for an asset

Headers

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

Examples

// Asset not found
GET /api/v2/assets/:asset_id/attachments
404
{
  "error": "asset not found"
}
// Successful request
GET /api/v2/assets/UqFkJDWdw7Sdg7TQZS-J/attachments
200
{
  "attachments": []
}
// Successful request
GET /api/v2/assets/bDzHAAxLXsSmhL4lax8D/attachments
200
{
  "attachments": [
    {
      "id": "S3kQqTTXTFMLBhsY8XeY",
      "external_id": null,
      "parent_id": "bDzHAAxLXsSmhL4lax8D",
      "project_id": null,
      "owner": "admin-user-66@example.com",
      "title": "sample attachment",
      "description": null,
      "category": null,
      "tags": [],
      "ai_tags": [],
      "status": "open",
      "media_type": "placeholder",
      "original_filename": null,
      "drop_folder_id": null,
      "md5_sum": null,
      "created_date": "2023-11-27T09:42:52.099Z",
      "modification_date": "2023-11-27T09:42:52.099Z",
      "deleted": null
    }
  ]
}

Errors

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

POST /api/v2/assets/:asset_id/attachments
Create attachment for an asset

Headers

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

Params

Param name Description
title
required

Title

Validations:

  • Must be a String

Examples

// Successful request
POST /api/v2/assets/NBmnCtuFCbI88s1cNHJX/attachments
{
  "title": "sample attachment"
}
200
{
  "asset": {
    "id": "Hd0WZ_Wfpsv9_51bxXBt",
    "external_id": null,
    "parent_id": "NBmnCtuFCbI88s1cNHJX",
    "project_id": null,
    "owner": "admin-user-67@example.com",
    "title": "sample attachment",
    "description": null,
    "category": null,
    "tags": [],
    "ai_tags": [],
    "status": "open",
    "media_type": "placeholder",
    "original_filename": null,
    "drop_folder_id": null,
    "md5_sum": null,
    "created_date": "2023-11-27T09:42:52.577Z",
    "modification_date": "2023-11-27T09:42:52.577Z",
    "deleted": null
  }
}
// When missing required parameters
POST /api/v2/assets/A19eXjFE5vFsMssy67fE/attachments
422
{
  "error": "Missing parameter title"
}
// With invalid parameters
POST /api/v2/assets/MuisjSIDxKPdtEiJsvwP/attachments
{
  "title": "Testing too long title: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
400
{
  "error": "Title is too long (maximum is 255 characters)"
}

Errors

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

GET /api/v2/projects/:project_id/attachments
Get attachments for project

Headers

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

Examples

// Project not found
GET /api/v2/projects/:project_id/attachments
404
{
  "error": "project not found"
}
// Successful request
GET /api/v2/projects/MKEejlgPARb7pJp8JrD4/attachments
200
{
  "attachments": []
}
// Successful request
GET /api/v2/projects/If8_aXgtMF4ggxOPqvKM/attachments
200
{
  "attachments": [
    {
      "id": "Z4xvirg6hr4hi9C7tiby",
      "external_id": null,
      "parent_id": "If8_aXgtMF4ggxOPqvKM",
      "project_id": null,
      "owner": "admin-user-72@example.com",
      "title": "sample attachment",
      "description": null,
      "category": null,
      "tags": [],
      "ai_tags": [],
      "status": "open",
      "media_type": "placeholder",
      "original_filename": null,
      "drop_folder_id": null,
      "md5_sum": null,
      "created_date": "2023-11-27T09:42:53.904Z",
      "modification_date": "2023-11-27T09:42:53.904Z",
      "deleted": null
    }
  ]
}

Errors

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

POST /api/v2/projects/:project_id/attachments
Create attachment for a project

Headers

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

Params

Param name Description
title
required

Title

Validations:

  • Must be a String

Examples

// Project not found
POST /api/v2/projects/:project_id/attachments
{
  "title": "sample attachment"
}
404
{
  "error": "project not found"
}
// Successful request
POST /api/v2/projects/czPBmrbRE76BOmD0Ykz8/attachments
{
  "title": "sample attachment"
}
200
{
  "asset": {
    "id": "u0wgdvwXs2KD3MgqNV8_",
    "external_id": null,
    "parent_id": "czPBmrbRE76BOmD0Ykz8",
    "project_id": null,
    "owner": "admin-user-74@example.com",
    "title": "sample attachment",
    "description": null,
    "category": null,
    "tags": [],
    "ai_tags": [],
    "status": "open",
    "media_type": "placeholder",
    "original_filename": null,
    "drop_folder_id": null,
    "md5_sum": null,
    "created_date": "2023-11-27T09:42:54.394Z",
    "modification_date": "2023-11-27T09:42:54.394Z",
    "deleted": null
  }
}
// When missing required parameters
POST /api/v2/projects/GEgkmoV5jzJNLjdZAz7J/attachments
422
{
  "error": "Missing parameter title"
}
// With invalid parameters
POST /api/v2/projects/-23mQQaJiZrjw1MLBEc1/attachments
{
  "title": "Testing too long title: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
400
{
  "error": "Title is too long (maximum is 255 characters)"
}

Errors

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