GET /data/projects/{project_id}/output-files

Retrieve all output files for a given project with optional filtering by output type, task type, representation, file status, and name.

Path parameters

  • project_id string(uuid) Required

    Project unique identifier

Query parameters

  • output_type_id string(uuid)

    Filter by output type

  • task_type_id string(uuid)

    Filter by task type

  • file_status_id string(uuid)

    Filter by file status

  • representation string

    Filter by representation

  • name string

    Filter by file name

Responses

  • 200 application/json

    All output files for the project

    Hide response attributes Show response attributes object
    • id string(uuid)

      Output file unique identifier

    • name string

      Output file name

    • revision integer

      Output file revision

    • path string

      Output file path

    • updated_at string(date-time)

      Last update timestamp

    • project_id string(uuid)

      Project identifier

GET /data/projects/{project_id}/output-files
curl -X GET "http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/output-files?output_type_id=b35b7fb5-df86-5776-b181-68564193d36&task_type_id=c46c8gc6-eg97-6887-c292-79675204e47&file_status_id=d57d9hd7-fh08-7998-d403-80786315f58&representation=cache&name=main" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
import requests

url = "http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/output-files"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json"
}
params = {
    "output_type_id": "b35b7fb5-df86-5776-b181-68564193d36",
    "task_type_id": "c46c8gc6-eg97-6887-c292-79675204e47",
    "file_status_id": "d57d9hd7-fh08-7998-d403-80786315f58",
    "representation": "cache",
    "name": "main"
}
payload = None

response = requests.get(
    url,
    headers=headers,
    params=params,
    json=payload
)

response.raise_for_status()

if response.content:
    print(response.json())
curl \
 --request GET 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/output-files' \
 --header "Authorization: $API_KEY"
Response examples (200)
[
  {
    "id": "e68e0ie8-gi19-8009-e514-91897426g69",
    "name": "main",
    "revision": 1,
    "path": "/project/asset/output/main_v001.mp4",
    "updated_at": "2023-01-01T12:00:00Z",
    "project_id": "f79f1jf9-hj20-9010-f625-a09008537h80"
  }
]