​
Introduction

Searching for assets is a fundamental operation in digital asset management workflows. Whether you’re managing a large library of assets or collaborating with a team, being able to efficiently locate and filter assets is crucial. This guide demonstrates how to use the Mudstack API to search for assets, filter them by library, and filter by review status. By following these examples, you can streamline your workflows and improve productivity.

These examples are designed for developers integrating Mudstack into their applications or automation scripts. They demonstrate how to:

  1. Search for assets using the /workspaces/assets/search endpoint.
  2. Filter assets by library, specifically finding the library named “Ready for engine”.
  3. Filter assets where the reviewStatus is “rejected”.

Before starting, ensure you have a valid API token and workspace ID. These are required for authenticating your requests.

​
Before Starting: Authenticate and Retrieve an Authorization Token

Use the /auth/token endpoint to retrieve an authorization token. Replace <your_account_id>, <your_key>, and <your_secret> with your account ID, API key, and secret, respectively.

# Python example to retrieve an authorization token
import requests

url = "https://api.mudstack.com/auth/token"
data = {
    "account_id": "<your_account_id>",
    "key": "<your_key>",
    "secret": "<your_secret>"
}
response = requests.post(url, json=data)
token = response.json()["token"]
print(token)

​
Examples

​
Example 1: Search for Assets by Query

Use the /workspaces/assets/search endpoint to search for assets by a specific query. Replace <your_key>, <your_secret>, <workspace_id>, and <account_id> with your API key, secret, workspace ID, and account ID, respectively.

# Step 1: Obtain an authorization token
import requests

auth_url = "https://api.mudstack.com/auth/token"
auth_data = {"key": "<your_key>", "secret": "<your_secret>"}
auth_response = requests.post(auth_url, json=auth_data)
token = auth_response.json()["token"]

# Step 2: Use the token to search for assets by query
url = "https://api.mudstack.com/workspaces/assets/search"
headers = {
    "Authorization": f"Bearer {token}",
    "x-workspace-id": "<workspace_id>",
    "x-account-id": "<account_id>",
    "Content-Type": "application/json"
}
data = {"filters": {"query": "example"}}
response = requests.get(url, headers=headers, json=data)
print(response.json())

​
Example 2: Filter Assets by Library

To filter assets by library, first retrieve all libraries using the /workspaces/libraries endpoint. Then, find the library with the name “Ready for engine” and use its id to filter assets.

# Step 1: Obtain an authorization token
auth_url = "https://api.mudstack.com/auth/token"
auth_data = {"key": "<your_key>", "secret": "<your_secret>"}
auth_response = requests.post(auth_url, json=auth_data)
token = auth_response.json()["token"]

# Step 2: Retrieve libraries
libraries_url = "https://api.mudstack.com/workspaces/libraries"
headers = {
    "Authorization": f"Bearer {token}",
    "x-workspace-id": "<workspace_id>",
    "x-account-id": "<account_id>"
}
libraries_response = requests.get(libraries_url, headers=headers)
libraries = libraries_response.json()["libraries"]
library_id = next(lib["id"] for lib in libraries if lib["name"] == "Ready for engine")

# Step 3: Filter assets by library ID
assets_url = "https://api.mudstack.com/workspaces/assets/search"
data = {"filters": {"libraries": [library_id]}}
assets_response = requests.get(assets_url, headers=headers, json=data)
print(assets_response.json())

​
Example 3: Filter Assets by Review Status

Filter assets where the reviewStatus is “rejected” using the /workspaces/assets/search endpoint.

# Step 1: Obtain an authorization token
auth_url = "https://api.mudstack.com/auth/token"
auth_data = {"key": "<your_key>", "secret": "<your_secret>"}
auth_response = requests.post(auth_url, json=auth_data)
token = auth_response.json()["token"]

# Step 2: Filter assets by review status
url = "https://api.mudstack.com/workspaces/assets/search"
headers = {
    "Authorization": f"Bearer {token}",
    "x-workspace-id": "<workspace_id>",
    "x-account-id": "<account_id>",
    "Content-Type": "application/json"
}
data = {"filters": {"reviewStatus": ["rejected"]}}
response = requests.get(url, headers=headers, json=data)
print(response.json())

​
Explore More Examples

Looking for more examples? Check out the following guides to learn about other use cases:

Was this page helpful?