Headers

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

Params

Param name Description
title
optional

Query for title

Validations:

  • Must be a String

tags
optional

Query for tags, comma-seperated

Validations:

  • Must be a String

media_types
optional

Query for media types, comma-seperated

Validations:

  • Must be a String

category
optional

Query for category

Validations:

  • Must be a String

owner
optional

Query for owner

Validations:

  • Must be a String

status
optional

Query for status

Validations:

  • Must be one of: open, approved, rejected.

Examples

GET /api/v2/search?title=Sample+Asset
200
{
  "results": [
    {
      "id": "Gg4bfIIBxZWjhF1keE9T",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-47@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "new assets",
      "tags": [
        "sample",
        "clip"
      ],
      "ai_tags": null,
      "media_type": "placeholder",
      "modification_date": "2022-08-08T06:19:12Z",
      "created_date": "2022-08-08T06:19:11Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false,
      "thumbnail_project_id": null
    }
  ],
  "results_count": 1
}
GET /api/v2/search?title=Sample+Project
200
{
  "results": [
    {
      "id": "PQ4bfIIBxZWjhF1khk-h",
      "external_id": null,
      "project_id": null,
      "owner": "admin-user-48@example.com",
      "description": "This is a new project",
      "title": "Sample Project",
      "category": "new projects",
      "tags": [
        "sample"
      ],
      "media_type": "project",
      "modification_date": "2022-08-08T06:19:16Z",
      "created_date": "2022-08-08T06:19:14Z",
      "status": "open",
      "deleted": false,
      "thumbnail_asset_id": null,
      "isPublic": false
    }
  ],
  "results_count": 1
}
GET /api/v2/search?tags=clip
200
{
  "results": [
    {
      "id": "Rg4bfIIBxZWjhF1kjk88",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-49@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "new assets",
      "tags": [
        "sample",
        "clip"
      ],
      "ai_tags": null,
      "media_type": "placeholder",
      "modification_date": "2022-08-08T06:19:17Z",
      "created_date": "2022-08-08T06:19:16Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false,
      "thumbnail_project_id": null
    }
  ],
  "results_count": 1
}
GET /api/v2/search?tags=sample
200
{
  "results": [
    {
      "id": "YA4bfIIBxZWjhF1kmE-l",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-50@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "new assets",
      "tags": [
        "sample",
        "clip"
      ],
      "ai_tags": null,
      "media_type": "placeholder",
      "modification_date": "2022-08-08T06:19:20Z",
      "created_date": "2022-08-08T06:19:19Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false,
      "thumbnail_project_id": null
    },
    {
      "id": "Zw4bfIIBxZWjhF1km09R",
      "external_id": null,
      "project_id": null,
      "owner": "admin-user-50@example.com",
      "description": "This is a new project",
      "title": "Sample Project",
      "category": "new projects",
      "tags": [
        "sample"
      ],
      "media_type": "project",
      "modification_date": "2022-08-08T06:19:21Z",
      "created_date": "2022-08-08T06:19:20Z",
      "status": "open",
      "deleted": false,
      "thumbnail_asset_id": null,
      "isPublic": false
    }
  ],
  "results_count": 2
}
GET /api/v2/search?media_types=project%2C+placeholder
200
{
  "results": [
    {
      "id": "dQ4bfIIBxZWjhF1kok9V",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-51@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "new assets",
      "tags": [
        "sample",
        "clip"
      ],
      "ai_tags": null,
      "media_type": "placeholder",
      "modification_date": "2022-08-08T06:19:22Z",
      "created_date": "2022-08-08T06:19:22Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false,
      "thumbnail_project_id": null
    },
    {
      "id": "fg4bfIIBxZWjhF1kpU_b",
      "external_id": null,
      "project_id": null,
      "owner": "admin-user-51@example.com",
      "description": "This is a new project",
      "title": "Sample Project",
      "category": "new projects",
      "tags": [
        "sample"
      ],
      "media_type": "project",
      "modification_date": "2022-08-08T06:19:23Z",
      "created_date": "2022-08-08T06:19:22Z",
      "status": "open",
      "deleted": false,
      "thumbnail_asset_id": null,
      "isPublic": false
    }
  ],
  "results_count": 2
}
GET /api/v2/search?media_types=placeholder
200
{
  "results": [
    {
      "id": "ig4bfIIBxZWjhF1krE-v",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-52@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "new assets",
      "tags": [
        "sample",
        "clip"
      ],
      "ai_tags": null,
      "media_type": "placeholder",
      "modification_date": "2022-08-08T06:19:25Z",
      "created_date": "2022-08-08T06:19:24Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false,
      "thumbnail_project_id": null
    }
  ],
  "results_count": 1
}
GET /api/v2/search?category=New+Assets
200
{
  "results": [
    {
      "id": "nQ4bfIIBxZWjhF1kt08V",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-53@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "new assets",
      "tags": [
        "sample",
        "clip"
      ],
      "ai_tags": null,
      "media_type": "placeholder",
      "modification_date": "2022-08-08T06:19:28Z",
      "created_date": "2022-08-08T06:19:27Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false,
      "thumbnail_project_id": null
    }
  ],
  "results_count": 1
}
GET /api/v2/search?owner=admin-user-54%40example.com
200
{
  "results": [
    {
      "id": "sg4bfIIBxZWjhF1kwE_z",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-54@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "new assets",
      "tags": [
        "sample",
        "clip"
      ],
      "ai_tags": null,
      "media_type": "placeholder",
      "modification_date": "2022-08-08T06:19:30Z",
      "created_date": "2022-08-08T06:19:29Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false,
      "thumbnail_project_id": null
    },
    {
      "id": "tg4bfIIBxZWjhF1kxE_1",
      "external_id": null,
      "project_id": null,
      "owner": "admin-user-54@example.com",
      "description": "This is a new project",
      "title": "Sample Project",
      "category": "new projects",
      "tags": [
        "sample"
      ],
      "media_type": "project",
      "modification_date": "2022-08-08T06:19:31Z",
      "created_date": "2022-08-08T06:19:30Z",
      "status": "open",
      "deleted": false,
      "thumbnail_asset_id": null,
      "isPublic": false
    }
  ],
  "results_count": 2
}
GET /api/v2/search?status=open
200
{
  "results": [
    {
      "id": "xQ4bfIIBxZWjhF1ky0-e",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-55@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "new assets",
      "tags": [
        "sample",
        "clip"
      ],
      "ai_tags": null,
      "media_type": "placeholder",
      "modification_date": "2022-08-08T06:19:33Z",
      "created_date": "2022-08-08T06:19:32Z",
      "status": "open",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false,
      "thumbnail_project_id": null
    },
    {
      "id": "yg4bfIIBxZWjhF1kzk9m",
      "external_id": null,
      "project_id": null,
      "owner": "admin-user-55@example.com",
      "description": "This is a new project",
      "title": "Sample Project",
      "category": "new projects",
      "tags": [
        "sample"
      ],
      "media_type": "project",
      "modification_date": "2022-08-08T06:19:34Z",
      "created_date": "2022-08-08T06:19:33Z",
      "status": "open",
      "deleted": false,
      "thumbnail_asset_id": null,
      "isPublic": false
    }
  ],
  "results_count": 2
}
GET /api/v2/search?status=approved
200
{
  "results": [
    {
      "id": "1A4bfIIBxZWjhF1k1U8p",
      "external_id": null,
      "project_id": null,
      "parent_asset_id": null,
      "owner": "admin-user-56@example.com",
      "description": "This is a new asset",
      "title": "Sample Asset",
      "category": "new assets",
      "tags": [
        "sample",
        "clip"
      ],
      "ai_tags": null,
      "media_type": "placeholder",
      "modification_date": "2022-08-08T06:19:38Z",
      "created_date": "2022-08-08T06:19:35Z",
      "status": "approved",
      "original_filename": null,
      "md5_sum": null,
      "deleted": false,
      "thumbnail_project_id": null
    }
  ],
  "results_count": 1
}

Errors

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