Flows

Model properties

Name
id
Type
string
Description
Unique identifier for the flow.
Name
is_failed
Type
boolean
Description
Whether or not the flow has failed to be processed.
Name
is_ready
Type
boolean
Description
Whether or not the flow is fully processed and its deliverables are ready for consumption.
Name
deliverables
Type
array
Description
An array of deliverables that are available for the flow. The flow specific deliverables will be included along with any deliverables created by the flow's jobs. This array will be empty if the workflow has not been processed.
Name
metadata
Type
object
Description
An object containing user-supplied metadata about the flow.

GET/v2/flows

List all flows

This endpoint allows you to retrieve a paginated list of all your flows. By default, a maximum of 15 flows are shown per page.

Request parameters

Name
page
Type
integer
Description
Specify the page number to retrieve. Default is 1.
Name
per_page
Type
integer
Description
Limit the number of flows returned per page. Default is 15.

Request

GET

/v2/flows

curl -G https://api.editframe.com/v2/flows \
  -H "Authorization: Bearer {token}" \
  -d limit=10

Response

{
  "data": [
    {
      "id": "yKOqd7QnJZ",
      "is_failed": false,
      "is_ready": true,
      "deliverables": [
        {
          "type": "zip",
          "download_url": "https://api.editframe.com/v2/flows/yKOqd7QnJZ/download"
        },
        {
          "type": "video",
          "id": "yKOqd7QnJZ",
          "metadata": {
            "user_id": "123"
          },
          "flow_id": "yKOqd7QnJZ",
          "download_url": "https://api.editframe.com/v2/videos/yKOqd7QnJZ/download",
          "stream_url": "https://api.editframe.com/v2/videos/yKOqd7QnJZ/stream?client_id=tU9gOSX4evc0yKOqd7QnJZ"
        },
        {
          "type": "video",
          "id": "PgQQX3hrtZ",
          "metadata": {
            "user_id": "123"
          },
          "flow_id": "yKOqd7QnJZ",
          "download_url": "https://api.editframe.com/v2/videos/PgQQX3hrtZ/download",
          "stream_url": "https://api.editframe.com/v2/videos/PgQQX3hrtZ/stream?client_id=tU9gOSX4evc0yKOqd7QnJZ"
        }
      ],
      "metadata": {
        
      },
    },
    {
      // ...
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 2,
    "from": 1,
    "to": 10
  }
}

GET/v2/flows/:id

Retrieve a flow

This endpoint allows you to retrieve an individual flow by providing the flow id. Refer to the model properties to see which properties are included with flow objects.

Request

GET

/v2/flows/PgQQX3hrtZ

curl https://api.editframe.com/v2/flows/PgQQX3hrtZ \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "yKOqd7QnJZ",
  "is_failed": false,
  "is_ready": true,
  "deliverables": [
    {
      "type": "zip",
      "download_url": "https://api.editframe.com/v2/flows/yKOqd7QnJZ/download/zip"
    },
    {
      "type": "video",
      "id": "yKOqd7QnJZ",
      "metadata": {
        "user_id": "123"
      },
      "flow_id": "yKOqd7QnJZ",
      "download_url": "https://api.editframe.com/v2/videos/yKOqd7QnJZ/download",
      "stream_url": "https://api.editframe.com/v2/videos/yKOqd7QnJZ/stream?client_id=tU9gOSX4evc0yKOqd7QnJZ"
    },
    {
      "type": "video",
      "id": "PgQQX3hrtZ",
      "metadata": {
        "user_id": "123"
      },
      "flow_id": "yKOqd7QnJZ",
      "download_url": "https://api.editframe.com/v2/videos/PgQQX3hrtZ/download",
      "stream_url": "https://api.editframe.com/v2/videos/PgQQX3hrtZ/stream?client_id=tU9gOSX4evc0yKOqd7QnJZ"
    }
  ],
  "metadata": {
    
  },
},

DELETE/v2/flows/:id

Delete a flow

This endpoint allows you to delete a workflow and its corresponding jobs.

In addition to destroying the Flow model, this action will permanently delete the Video models and any associated files generated by the workflow.

Request

DELETE

/v2/flows/PgQQX3hrtZ

curl -X DELETE https://api.editframe.com/v2/flows/PgQQX3hrtZ \
  -H "Authorization: Bearer {token}"