Search assets

curl --request GET \
  --url https://api.runflow.io/v1/assets \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.runflow.io/v1/assets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.runflow.io/v1/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runflow.io/v1/assets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.runflow.io/v1/assets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "r2_key": "<string>",
      "url": "<string>",
      "thumbnail_url": "<string>",
      "mime_type": "<string>",
      "size_bytes": 123,
      "asset_type": "<string>",
      "source_type": "<string>",
      "source_id": "<string>",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "deleted_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_by_user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "avatar_url": "<string>"
      }
    }
  ],
  "first": "<string>",
  "next": "<string>",
  "previous": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

GET

assets

Search assets

curl --request GET \
  --url https://api.runflow.io/v1/assets \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.runflow.io/v1/assets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.runflow.io/v1/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runflow.io/v1/assets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.runflow.io/v1/assets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "r2_key": "<string>",
      "url": "<string>",
      "thumbnail_url": "<string>",
      "mime_type": "<string>",
      "size_bytes": 123,
      "asset_type": "<string>",
      "source_type": "<string>",
      "source_id": "<string>",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "deleted_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_by_user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "avatar_url": "<string>"
      }
    }
  ],
  "first": "<string>",
  "next": "<string>",
  "previous": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Organization-Id

string | null

Query Parameters

add_signature

boolean

default:false

Replace url and thumbnail_url with presigned GET URLs valid for up to 1 week. Default: true on detail (GET /assets/{id}), false on search (GET /assets). When false, storage does not need to be configured.

string | null

ANTLR filter expression

limit

integer | null

Page size

Required range: 1 <= x <= 500

sort_by

string | null

Sort expression (e.g. created_at:desc)

fields

string | null

Field projection (e.g. id,name)

embed

string | null

Relation embedding. Available values: created_by_user. Use a comma-separated list to request multiple embeds.

string | null

Pagination cursor query

from_prev

boolean

default:false

Backward pagination flag

Response

Paginated asset list.

Paginated list response.

items

FullValidator · object[]

required

Show child attributes

first

string | null

Reference

Additional surfaces

Search assets

Authorizations

Headers

Query Parameters

Response