Introducing the Frame.io V4 API Early Access Program

General
,
21

I’m on v4. Support said:

This account is not linked with Adobe.

Now you can still sign up for the Adobe Creative Cloud for Frame.io offer. There are two workarounds for this.

  1. You can either delete your Frame.io current account under the email [redacted] and sign up again.
  2. You can change the email of the current Frame.io account to an alternate email (one that is not registered with Frame.io). Doing this will free up your email [redacted] and you can sign up again.

While resigning, make sure you choose the “Continue with Adobe” option to avail of the offer.

22

My apologies for that, our support team is still learning this new process as part of this early access program.

I have reached out internally to try and get this resolved for you. It is outside normal business hours so I’m not sure how soon this will get taken care of, it may not happen until Monday.

Thank you in advance for your patience and again I’m sorry for the confusion here!

23

Understood; I know exactly how that goes! :wink: Thanks so much for your response. Will stand by until Monday.

1 Like
24

Im trying to setup S2S, however I don’t have the product listed in Adobe Admin so Im unable to assign a user as a “Developer” to the product. However I do have Adobe and Frame accounts linked so I can use the V4 API. Any insight is appreciated

https://helpx.adobe.com/enterprise/using/automate-using-frame-io.html#:~:text=How%20to%20Set%20Up%20S2S%20on%20Developer%20Console

25

@media S2S your Frame.io account would need to be fully managed via the Adobe Admin Console (if you can invite other people to your account via Frame.io, then this is not an Adobe Managed account) in order to enable S2S, which is an Enterprise feature only currently. Simply having your Adobe and Frame.io accounts would not give access to Frame.io as a product in the Admin Console to enable S2S (it does however give access to use th V4 API in general).

In my initial post we explained this as:

"In the future, we will migrate all Frame users to the Adobe Admin Console. This will not break existing customer API workflows, but it will change how you can access multiple accounts. This transition is necessary to introduce interoperability across all Adobe products (such as AEM, Firefly, etc.) and so we can enable Server to Server (S2S)

You would need to be added to an Adobe Org as a developer that has Frame.io as part of it’s offerings in order to access S2S at this time.

1 Like
26

Thanks for the clarification

27

I’m running into an issue where I can add the frameio api to the adobe developer, set the uri, generate a token via https but then when I use that to retrieve frameio inforation i get permissions errors. Am I right in gathering from these forums that as it’s in early access and alpha then the frameio api I’ve added through the adobe developer site won’t be for v4? Is there a way to get the early access?

I can send a request usnig my token to retrieve basic adobe account information, but nothing from framio, I get the following errors:
{“code”:401,“message”:“Not Authorized”,“errors”:[{“code”:401,“status”:401,“title”:“Not Authorized”,“detail”:“You are not allowed to access that resource”}]}

I’ve definitely apped the frameio api to the console in adobe developer too

28

@WikRik Hi, if you are able to get your Adobe account information but not the Frame.io account information then your Frame.io account is not linked to your Adobe ID. Please reach out to our support team to ask them to be able to link your Adobe ID to your Frame.io account.

29

Hi @CharlieAnderson I thought the same but I contacted them, they shut down my v3 account, freed up my email (as it’s the same as my adobe) then I started a new account with v4 using my adobe account. The log in page is via adobe and support have since featured me that it is indeed linked to my adobe account. Is there anything else I can do?

Perhaps it’s the scopes I’m requesting along with the authorisation token? I can’t find a good list of what scopes the frameio api in v4 allows.

30

I’ve successfully obtained an Adobe access token using the Frameio OAuth flow.

However, every attempt to use this token against the Frame.io v2 REST API returns a 401 Unauthorized — including /v2/me, /v2/accounts, /v2/workspaces, and /v2/projects.

Is Adobe OAuth expected to work with Frameio’s REST API, or are additional scopes/permissions required?

  • Which endpoints can be used with an Adobe-signed token?
  • Do Adobe ID–based users need to register a different type of integration for API access?

Edit: just realised I needed the v4/ accounts. Seem to be getting somewhere.

31

@WikRik you are trying to use the legacy API baseurl (/v2) with the Adobe access tokens, but that is not possible as it’s only scoped to work with the new /v4 endpoints. You can learn more here:

1 Like
32

thanks @CharlieAnderson now all working thank you. I’ve noticed a key difference with v4 and that’s that you can’t currently retrieve the annotations in any way, only a string if there is an annotation, but not the annotations data itself. It used to be that you could access the json file of the vector information, is that on the roadmap for v4, or some other way of getting the annotation drawings out?

33

Happy to help! Glad you got it working! Annotations are not yet supported via the API, it is called out int he Migration guide here: https://developer.adobe.com/frameio/guides/Migration/#6-comments

34

ah thanks again @CharlieAnderson that’s really helpful. I can’t see anything about Annotations in there though, is that on the horizon? And is there a rough eta on the replies part? Appreciate all your help

35

@WikRik I just took a look at the show comments endpoint and annotations should be available in the 200 response under “annotation”.

{
"data": {
"annotation": "annotation",
"created_at": "2024-02-02T21:19:24.828948Z",
"file_id": "4ae08df1-b419-4897-aba5-560198a18237",
"id": "8adf1a94-455a-4883-b7a4-08f2e5d2a8a9",
"owner": {},
"page": 1,
"replies": [ ],
"text": "This is great!",
"text_edited_at": "2024-02-02T21:19:24.828948Z",
"timestamp": 123,
"updated_at": "2024-02-02T21:19:24.828948Z"
}
}

Not sure about the timeline for the replies endpoint but keep an eye on the Alpha endpoints for new changes that might include that.

36

thanks, am I right in thinking that for now the annotation is just a string that is basically a boolean, whether it has an annotation or not? But that later we might be able to get the actual annotation info?

37

The example there isn’t to spec, but the annotation syntax should roughly match what we do in v3 of Frame.io - https://developer.frame.io/docs/workflows-assets/working-with-annotations.

What is your end goal for what you’d like to do with annotations and is there additional functionality you’d like to have like access to such as an SVG overlay, PNG overlay of the drawn annotation, a composited version for download, etc?

38

hi @jhodges thanks for that. I’m building out an interface for unreal, so far getting most of what I need, I can get the annotations in their vector description which I might then convert to an image with a python library, but if there’s an easier way like being able to download a png with an alpha channel or something?

A couple of other questions that you can probably help solve quickly. When I’m getting information via the api, the replies come through Unknown then the date, then the reply, I assume Unknown is supposed to refer to the user who replied? Weirdly if I reply to the reply then the text that frameio returns has @username in it correctly, so perhaps the initial reply username isn’t working, or perhaps Unknown refers to something else?

Secondly, and this should be an easy one, the timestamp for comments come in differently than what frameio shows on the main site. For example if I leave a comment at 12:06 seconds then query the api it will return 293.0s. I thought it might be a frame number, but if I divide it by the frame rate then it’s still not right. It’s close, but not right.

39

I’m going to send you a DM with some sample code you can use to draw annotations. It’s not perfect, but it’s a start. I’ll add you to the feature request for PNG w/ alpha as an optional download for each comment annotation.

I’ve passed along your question regarding comment replies to engineering as I’m not sure what the answer is.

Lastly, this is in fact the frame number, but I don’t think the calculation of it is very robust, that’s something we’ll investigate further. Do you mind sharing the video you’re seeing this issue with in a DM via a share link so that we can debug?

40

hi again, lots of success getting info out of frameio, but when trying to write to it I’m hitting a wall. I can see there are limited scopes vai adobe, but in the frameio v4 api there are some write commands and update commands for assets / files and folders, but if I try and do anything I run up against there not being a route for POST as opposed to GET. Any ideas?