List workflows

Viewing v2— current version

GET

/v2/workspaces/{workspace_id}/workflows

curl --request GET \
  --url https://api.app.layer.ai/api/v2/workspaces/:workspace_id/workflows \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/workflows"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())

const url = 'https://api.app.layer.ai/api/v2/workspaces/:workspace_id/workflows';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

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

func main() {

  url := "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/workflows"

  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(res)
  fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.layer.ai/api/v2/workspaces/:workspace_id/workflows",
  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;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/workflows")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/workflows")

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

var client = new RestClient("https://api.app.layer.ai/api/v2/workspaces/:workspace_id/workflows");
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer <token>");
var response = client.Execute(request);

Unchanged from v1. This endpoint’s documented request and response schemas are identical in v1 and v2 — change the /v1 prefix to /v2. Schema equality is not a promise about behaviour, so keep your usual smoke tests.

List available generation workflows (published blueprints) in a workspace.

Authorizations

bearerAuth
oauth2
serviceAccount
workflows:read

Parameters

Path Parameters

workspace_id

required

Workspace Id

Id of the workspace that owns the resource.

string format: uuid

Id of the workspace that owns the resource.

Query Parameters

search

Search

Full-text search on workflow name/description

string

nullable

Full-text search on workflow name/description

limit

Limit

Maximum number of results to return.

integer

default: 20 >= 1 <= 100

Maximum number of results to return.

cursor

Cursor

Cursor from a previous response to fetch the next page.

string

nullable

Cursor from a previous response to fetch the next page.

Responses

200

Successful Response

application/json

ListWorkflowsOutput

object

workflows

required

Workflows

Array<object>

WorkflowSummary

object

workflow_id

required

Workflow Id

Unique workflow identifier

string format: uuid

name

required

Name

Workflow display name

string

description

required

Description

What this workflow generates

string

modality

Any of:

Modality
null

Modality

string

Allowed values: text image audio video three_d playable world

created_at

required

Created At

When this workflow version was created

string format: date-time

published_at

Published At

When this workflow version was published

string format: date-time

nullable

inputs

required

Inputs

Input parameters the workflow accepts

Array<object>

WorkflowInput

object

name

required

Name

Input parameter name (used as key in execute_workflow inputs)

string

type

required

Type

Parameter type: string, number, boolean, file, prompt, etc.

string

value_schema

Value Schema

JSON schema of the input value

object

key

additional properties

any

required

required

Required

Whether this input must be provided

boolean

description

required

Description

What this input controls

string

display_name

Display Name

Human-readable label

string

nullable

default

Any of:

Default
null

Default

Default value if not provided

outputs

required

Outputs

Output parameters the workflow produces

Array<object>

WorkflowOutput

object

name

required

Name

Output parameter name

string

type

required

Type

Output type: file, string, etc.

string

value_schema

Value Schema

JSON schema of the output value

object

key

additional properties

any

description

required

Description

What this output contains

string

display_name

Display Name

Human-readable label

string

nullable

pagination

required

PaginationOutput

object

next_cursor

Next Cursor

Cursor to use to get the next page

string

nullable

has_more_results

required

Has More Results

If there are more results to page through

boolean

total_count

Total Count

Total number of results matching the query

integer

nullable

Example

{
  "workflows": [
    {
      "modality": "text"
    }
  ]
}

401

Unauthenticated — missing or invalid Bearer token.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

403

Forbidden — insufficient permissions, or the access token lacks the scope the operation requires.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

404

Resource not found.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

409

The outcome of the request with this Idempotency-Key is not known yet: it is still running, or it failed without a stored response. Retry after the number of seconds in Retry-After.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

422

Invalid input parameters, or an Idempotency-Key reused for a different request.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

429

Rate limited — retry after the number of seconds in Retry-After.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

500

Internal server error.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}