API & Python Sdk

Help
1

I’m starting out today with the Frame.io api.

I’m trying example scripts in python sdk

I can retrieve my account id, but I have no idea where to find a root_asset_id to get started.

This url referenced at docs frame io / docs / root-asset-ids doesn’t exist.

Before I waste any more time of this, I’d be grateful to know whether the docs are up to date? I see a reference to ‘v4’ of Frame.io . Perhaps I’m using v4 without knowing it, and for this reason the api isn’t going to be working for me?

Thank you in advance!

I can’t list project.

2

Hi there! Let’s start by figuring out if you’re on a V4 account or not, as you are correct in that it would preclude you from being able to use the legacy API.

Can you reach out to our support team via the in-app chat? If you can, just mention that you’d like to chat with Jeff and I can hop on with you!

3

Unfortunately you are joining us at an inconvenient time,

  1. If you have an Enterprise license, and are on the V4 UI, you are on the V4 API.
  2. If you have any other license, and are on the V4 UI, you do not (yet) have access to an API (to my knowledge).
  3. If you have any license, and are on the V3 UI, you have access to the V2 API.

You can tell if you are on the V4 UI if your team’s icon is in the bottom left with a house icon at the top left. I am going to assume the example scripts you are reading are for V2 since the V4 API is brand new, and the V4 API calls the “root-asset-id” the “root-folder-id”.

If you are on V2, you need to pull information about a project to get a root-asset-id.

/v2/teams/{team_id}/projects

To get your Team’s ID try…

/v2/accounts/{account_id}/teams

If you are on V4 and have Enterprise, things get a little more convoluted. The V2 docs allow you to test API calls easily; the V4 docs do not provide such luxuries. You will need to test the calls in Python or Postman.

/v4/accounts/{account_id}/workspaces/{workspace_id}/projects

To get the workspace id, call

/v4/accounts/{account_id}/workspaces

You can read more here for V2 or here for V4.

Note: The root_asset_id can be thought of as the id of the highest “folder” which is the container for all the assets in the project. Think of your C:/ drive on Win or /root/ on Linux.

4

Thank you very much for this kind reply. (And thank you Jeff for your earlier help.) I’m on v4 unfortunately.

As I’m not able to use this approach until the v4 API is made available, I will try using the Pipedream integration.

But before I do this, do you know if that is possible with v4?

Thank you in advance.

5

I am not familiar with Pipedream, however I am assuming it will not help you with V4.

In this code snippet on the official Pipedream webpage, it appears that you still need a bearer token, which you should not be able to get for V4 yet without Enterprise (someone correct me if this is misleading).

import { axios } from "@pipedream/platform"
export default defineComponent({
  props: {
    frame: {
      type: "app",
      app: "frame",
    }
  },
  async run({steps, $}) {
    return await axios($, {
      url: `https://api.frame.io/v2/accounts`,
      headers: {
        Authorization: `Bearer ${this.frame.$auth.oauth_access_token}`,
      },
    })
  },
})