Sammlungen auflisten | Frame.io API Documentation

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.collections.index(
    account_id="ffa7d15a-fef3-4fd9-adb9-536df5c54a33",
    project_id="571abc7e-1942-4a01-98b2-d7fa3626cb82",
)

{
  "data": [
    {
      "aggregation_mode": "dynamic",
      "auto_generated": false,
      "created_at": "2024-02-02T21:19:24.828948Z",
      "description": "Description of collection",
      "id": "726e0358-9881-4051-a3e5-93ab2f0f684b",
      "name": "Test Collection",
      "private": false,
      "project_id": "78f00ce8-48b3-4409-8c12-2e6c7a614db1",
      "root_folder_id": "5baae00b-0514-4a9e-8906-f03dd182bfcd",
      "updated_at": "2024-02-02T21:19:24.828948Z"
    },
    {
      "aggregation_mode": "dynamic",
      "auto_generated": false,
      "created_at": "2024-02-02T21:19:24.828948Z",
      "description": "Description of collection",
      "id": "726e0358-9881-4051-a3e5-93ab2f0f684b",
      "name": "Test Collection",
      "private": false,
      "project_id": "78f00ce8-48b3-4409-8c12-2e6c7a614db1",
      "root_folder_id": "5baae00b-0514-4a9e-8906-f03dd182bfcd",
      "updated_at": "2024-02-02T21:19:24.828948Z",
      "creator": {
        "active": true,
        "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
        "email": "user_email@example.com",
        "id": "55c87358-92ac-4d7b-a448-76c255bb8204",
        "name": "Jon Doe",
        "adobe_user_id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e"
      },
      "project": {
        "created_at": "2024-01-25T19:18:29.614189Z",
        "id": "38f2de6c-ca9a-484a-8660-a26b09d2f7b5",
        "name": "My Project",
        "root_folder_id": "435736ea-dd66-4d77-a6ec-f4d04c1e82a3",
        "status": "active",
        "storage": 15000,
        "updated_at": "2024-02-07T16:44:41.986478Z",
        "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/",
        "workspace_id": "26cbc0cb-9eb3-4591-bb90-81927ba5c1a4",
        "adobe_id": "urn:aaid:sc:US:9f4e4d7a-4b6b-4c4f-9f00-b31a91cfc6f3",
        "restricted": false
      },
      "shares": [
        {
          "enabled": true,
          "access": "public",
          "last_viewed_at": "2024-03-02T21:19:24.828948Z",
          "updated_at": "2024-02-02T21:19:24.828948Z",
          "commenting_enabled": true,
          "description": "Description of share",
          "created_at": "2024-02-02T21:19:24.828948Z",
          "name": "Test Share",
          "collection_id": "55279f13-c066-4518-9407-09e5bcfcf99c",
          "short_url": "https://f.io/GGa9wPw5",
          "downloading_enabled": true,
          "id": "8b77ad12-cabe-4a04-a63e-04c3fa5311e9",
          "expiration": "2026-09-03T00:39:49.450363Z",
          "card_info_enabled": true,
          "icons_visible_on_list": true,
          "theme": "dark",
          "editable_fields_enabled": false,
          "card_aspect_ratio": "square",
          "passphrase": "as!dfj39sd(*",
          "sort_by": {
            "direction": "asc",
            "field_definition_id": "ab290b48-a1b4-48e9-9533-ebdaa86c2569"
          },
          "forensic_watermark_enabled": false,
          "list_row_size": "small",
          "card_size": "medium",
          "reel_card_aspect_ratio": "square",
          "drm_enabled": false,
          "show_asset_name_in_reel_layout": false,
          "captions_enabled": true,
          "transcripts_enabled": true,
          "watermark_enabled": true,
          "reel_card_fit_image": false,
          "featured_field_definition_id": "016ad3e0-fd9d-4773-a3c0-ba3bbb06d2f4",
          "open_in_viewer_enabled": true,
          "accent_color": "#FF0000",
          "layout": "grid",
          "show_all_asset_versions": true,
          "name_column_width": null,
          "thumbnail_scale": "fill",
          "title_line_count": 1,
          "visible_field_definition_ids": [
            "3a53c60c-5439-40f2-a8ab-de17a5ba62b0"
          ]
        }
      ]
    }
  ],
  "links": {
    "next": "/v4/accounts/123/projects/123/collections"
  },
  "total_count": 10
}

List collections for a project.
Rate Limits: 100 calls per 1.00 minute(s) per account_user

Authentifizierung

AuthorizationBearer

Bearer-Authentifizierung der Form Bearer <token>, wobei token Ihr Auth-Token ist.

Pfadparameter

account_idstringErforderlichFormat: "uuid"

A UUID string that uniquely identifies a Frame.io entity.

project_idstringErforderlichFormat: "uuid"

A UUID string that uniquely identifies a Frame.io entity.

Abfrageparameter

includestringOptional

Include query parameter for collections

afterstringOptional

Opaque Cursor query param for requests returning paginated results.

NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable.

page_sizeintegerOptional1-100Standardwert ist 50

Page size query param for requests

include_total_countbooleanOptionalStandardwert ist false

Page query param to include the count of all entities

Antwort-Header

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

Antwort

datalist of objects

Collections

linksobject

Links to paginated data

total_countinteger or nullOptional

Total count

Fehler

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error