Kommentar erstellen | Frame.io API Documentation

from frameio import Frameio, Anchor, AttachmentInput, LinkParams, TextReviewAnnotation, TextReviewAnnotationBounds
from frameio.comments import CreateCommentParamsData
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.comments.create(
    account_id="5e1a1943-b3db-4f80-8fa3-f3ff26e371e3",
    file_id="47114202-7ef7-4fd3-8870-7e5aefb347f9",
    data=CreateCommentParamsData(
        anchor=Anchor(
            x=0.5,
            y=0.5,
        ),
        annotation="[{\"tool\":\"rect\",\"color\":\"#F22237\",\"size\":8,\"x\":0.277726001863933,\"y\":0.12909555568499534,\"w\":0.3153168321877913,\"h\":0.5308131407269339,\"ix\":0.277726001863933,\"iy\":0.12909555568499534,\"radius\":8}]",
        attachments=[
            AttachmentInput(
                file_size=1024000,
                media_type="image/png",
                name="screenshot.png",
            )
        ],
        completed=False,
        duration=10,
        links=[
            LinkParams(
                end_index=13,
                start_index=5,
                url="https://www.example.com",
            )
        ],
        page=4,
        text="This is great!",
        text_review_annotation=TextReviewAnnotation(
            bounds=[
                TextReviewAnnotationBounds(
                    height=42,
                    width=130,
                    x=12.5,
                    y=24,
                )
            ],
            selection_text="existing copy",
            suggested_text="updated copy",
            text_review_annotation_type="replace",
        ),
        timestamp="00:00:02:12",
    ),
)

{
  "data": {
    "annotation": "annotation",
    "attachments": [
      {
        "created_at": "2024-02-02T21:19:24.828948Z",
        "file_size": 1024000,
        "id": "971093ae-46ee-47c5-b227-1757be688848",
        "media_type": "image/png",
        "name": "screenshot.png",
        "upload_urls": [
          "https://s3.amazonaws.com/bucket/part1?signature=..."
        ]
      }
    ],
    "completed_at": null,
    "completer_id": null,
    "created_at": "2024-02-02T21:19:24.828948Z",
    "duration": 10,
    "file_id": "4ae08df1-b419-4897-aba5-560198a18237",
    "id": "29de1290-df8e-4908-91bf-090a628b44e7",
    "links": [
      {
        "end_index": 13,
        "start_index": 5,
        "text": "Test User",
        "url": "https://www.example.com"
      }
    ],
    "mentions": [
      {
        "end_index": 13,
        "start_index": 5,
        "text": "Test User",
        "user_id": "8b9259a4-384f-4406-bb47-7d94293636dd"
      }
    ],
    "page": 1,
    "text": "This is great!",
    "text_edited_at": "2024-02-02T21:19:24.828948Z",
    "text_review_annotation": {
      "bounds": [
        {
          "height": 42,
          "width": 130,
          "x": 12.5,
          "y": 24
        }
      ],
      "selection_text": "existing copy",
      "suggested_text": "updated copy",
      "text_review_annotation_type": "replace"
    },
    "timestamp": 123,
    "updated_at": "2024-02-02T21:19:24.828948Z",
    "anchor": {
      "x": 0.5,
      "y": 0.5
    }
  }
}

Kommentar zu einer Datei erstellen.
Rate-Limits: 100 Aufrufe pro 1,00 Minute(n) pro account_user

Authentifizierung

AuthorizationBearer

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

Pfadparameter

account_idstringErforderlich

Eine Frame.io- oder Adobe-Entitäts-ID. Normalerweise eine Frame.io-UUID. Für Konten, Projekte, Ordner, Dateien und Versionsstapel, die sich im Adobe Cloud-Speicher befinden (was bei Workfront-verbundenen Konten und -Projekten der Fall ist), kann aber auch eine von Adobe vergebene ID verwendet werden. Diese IDs müssen das Präfix ‘adobe:’ haben (z. B. ‘adobe:<adobe_org_id>’ für ein Konto, ‘adobe:<adobe_asset_id>’ für ein Projekt oder einen Ordner, ‘adobe:<adobe_asset_id>|<version>’ für ein Datei-Asset).

Eine Frame.io- oder Adobe-Entitäts-ID. Normalerweise eine Frame.io-UUID. Für Konten, Projekte, Ordner, Dateien und Versionsstapel, die sich im Adobe Cloud-Speicher befinden (was bei Workfront-verbundenen Konten und -Projekten der Fall ist), kann aber auch eine von Adobe vergebene ID verwendet werden. Diese IDs müssen das Präfix 'adobe:' haben (z. B. 'adobe:<adobe_org_id>' für ein Konto, 'adobe:<adobe_asset_id>' für ein Projekt oder einen Ordner, 'adobe:<adobe_asset_id>|<version>' für ein Datei-Asset).

file_idstringErforderlich

Eine Frame.io- oder Adobe-Entitäts-ID. Normalerweise eine Frame.io-UUID. Für Konten, Projekte, Ordner, Dateien und Versionsstapel, die sich im Adobe Cloud-Speicher befinden (was bei Workfront-verbundenen Konten und -Projekten der Fall ist), kann aber auch eine von Adobe vergebene ID verwendet werden. Diese IDs müssen das Präfix 'adobe:' haben (z. B. 'adobe:<adobe_org_id>' für ein Konto, 'adobe:<adobe_asset_id>' für ein Projekt oder einen Ordner, 'adobe:<adobe_asset_id>|<version>' für ein Datei-Asset).

Abfrageparameter

timestamp_as_timecodebooleanOptional

Anfrage

Fließtext der Kommentarparameter

dataobjectErforderlich

Antwort-Header

x-ratelimit-limitinteger

Rate-Limit

x-ratelimit-remaininginteger

Verbleibendes Rate-Limit

x-ratelimit-windowinteger

Rate-Limit-Fenster in Millisekunden

Antwort

Erstellt

dataobject

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