Создать список коллекций

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.collections.index(
    account_id="50ece72f-aff0-44e9-ad44-651b48729eae",
    project_id="362a7dd6-3433-4912-a052-f763332cd1bb",
)

{
  "data": [
    {
      "aggregation_mode": "dynamic",
      "auto_generated": false,
      "created_at": "2024-02-02T21:19:24.828948Z",
      "description": "Description of collection",
      "id": "bb6d1b51-0ec3-45a7-a5ee-e31f743befe6",
      "name": "Test Collection",
      "private": false,
      "project_id": "7c880f8d-a8ff-4609-8aa9-be901ba8987e",
      "root_folder_id": "43f5bff1-9472-437b-9308-04aecf5557eb",
      "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": "bb6d1b51-0ec3-45a7-a5ee-e31f743befe6",
      "name": "Test Collection",
      "private": false,
      "project_id": "7c880f8d-a8ff-4609-8aa9-be901ba8987e",
      "root_folder_id": "43f5bff1-9472-437b-9308-04aecf5557eb",
      "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": "2ccf0bb9-f899-40b0-904e-0293313803a9",
        "name": "Jon Doe",
        "adobe_user_id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e"
      },
      "project": {
        "created_at": "2024-01-25T19:18:29.614189Z",
        "id": "c8454a51-bd6b-4e5e-ab8c-bd561230ab8c",
        "name": "My Project",
        "root_folder_id": "a3409d86-152f-4ad3-8ab9-04b2dc6258e2",
        "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": "c5dce86c-b667-40dd-8c8d-7b02fbd3e84d",
        "description": "Project Description",
        "adobe_id": "urn:aaid:sc:US:9f4e4d7a-4b6b-4c4f-9f00-b31a91cfc6f3",
        "image": "https://picture.frame.io/image/convert/frameio-uploads-development/projects/d5e6011c-2bc9-4596-be05-77d562627112/project_image_original.png",
        "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": "e3c0ef5f-8965-4068-abcb-86b7df890f31",
          "short_url": "https://f.io/GGa9wPw5",
          "downloading_enabled": true,
          "id": "9a18cbeb-3dba-4b0e-aca8-aafd9a3b3027",
          "expiration": "2026-09-12T11:20:32.411408Z",
          "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": "9e06e06f-2811-4c5b-9134-4c51739b4481"
          },
          "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": "4b454c53-fb39-4eac-bc6b-8c786d4ebbbc",
          "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": [
            "edc47851-ac68-4b48-9816-4cdb48222cca"
          ]
        }
      ]
    }
  ],
  "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

Аутентификация

AuthorizationBearer

Аутентификация Bearer в форме Bearer <token>, где token — ваш токен аутентификации.

Параметры пути

account_idstringОбязательныйformat: "uuid"

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

project_idstringОбязательныйformat: "uuid"

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

Параметры запроса

includestringОпциональный

Include query parameter for collections

afterstringОпциональный

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_sizeintegerОпциональный1-100По умолчанию 50

Page size query param for requests

include_total_countbooleanОпциональныйПо умолчанию false

Page query param to include the count of all entities

Заголовки ответа

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

Ответ

datalist of objects

Collections

linksobject

Links to paginated data

total_countinteger or nullОпциональный

Total count

Ошибки

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