List workflow components

curl --request POST \
  --url https://api.example.com/api/v1/business/workflows/components \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "search": "<string>",
  "capability_ids": [
    "<string>"
  ],
  "skill_id": "<string>",
  "capability_id": "<string>",
  "page": 1,
  "size": 50
}
'

import requests

url = "https://api.example.com/api/v1/business/workflows/components"

payload = {
    "search": "<string>",
    "capability_ids": ["<string>"],
    "skill_id": "<string>",
    "capability_id": "<string>",
    "page": 1,
    "size": 50
}
headers = {
    "x-project-id": "<x-project-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-project-id': '<x-project-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    search: '<string>',
    capability_ids: ['<string>'],
    skill_id: '<string>',
    capability_id: '<string>',
    page: 1,
    size: 50
  })
};

fetch('https://api.example.com/api/v1/business/workflows/components', 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.example.com/api/v1/business/workflows/components",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'search' => '<string>',
    'capability_ids' => [
        '<string>'
    ],
    'skill_id' => '<string>',
    'capability_id' => '<string>',
    'page' => 1,
    'size' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-project-id: <x-project-id>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/api/v1/business/workflows/components"

	payload := strings.NewReader("{\n  \"search\": \"<string>\",\n  \"capability_ids\": [\n    \"<string>\"\n  ],\n  \"skill_id\": \"<string>\",\n  \"capability_id\": \"<string>\",\n  \"page\": 1,\n  \"size\": 50\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-project-id", "<x-project-id>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/business/workflows/components")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"search\": \"<string>\",\n  \"capability_ids\": [\n    \"<string>\"\n  ],\n  \"skill_id\": \"<string>\",\n  \"capability_id\": \"<string>\",\n  \"page\": 1,\n  \"size\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/workflows/components")

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

request = Net::HTTP::Post.new(url)
request["x-project-id"] = '<x-project-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"search\": \"<string>\",\n  \"capability_ids\": [\n    \"<string>\"\n  ],\n  \"skill_id\": \"<string>\",\n  \"capability_id\": \"<string>\",\n  \"page\": 1,\n  \"size\": 50\n}"

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Playbooks

List workflow components

List the building blocks used to assemble workflows: the catalog of available components, a specific set of components fetched by id, or the capabilities offered by the workflows hub.

Example: “List the workflow building blocks I can add to a workflow”

Usage: pick what you want with view: components for the catalog (with an optional text search), batch to fetch specific components by their capability ids, or hub_capabilities for the workflows-hub capabilities (optionally narrowed to one skill or one capability id). The lists come back in pages of up to 100 (50 by default); ask for the next page by its number.

Response: the matching components or hub capabilities, each with its id, name, and description.

POST

api

business

workflows

components

List workflow components

curl --request POST \
  --url https://api.example.com/api/v1/business/workflows/components \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "search": "<string>",
  "capability_ids": [
    "<string>"
  ],
  "skill_id": "<string>",
  "capability_id": "<string>",
  "page": 1,
  "size": 50
}
'

import requests

url = "https://api.example.com/api/v1/business/workflows/components"

payload = {
    "search": "<string>",
    "capability_ids": ["<string>"],
    "skill_id": "<string>",
    "capability_id": "<string>",
    "page": 1,
    "size": 50
}
headers = {
    "x-project-id": "<x-project-id>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-project-id': '<x-project-id>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    search: '<string>',
    capability_ids: ['<string>'],
    skill_id: '<string>',
    capability_id: '<string>',
    page: 1,
    size: 50
  })
};

fetch('https://api.example.com/api/v1/business/workflows/components', 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.example.com/api/v1/business/workflows/components",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'search' => '<string>',
    'capability_ids' => [
        '<string>'
    ],
    'skill_id' => '<string>',
    'capability_id' => '<string>',
    'page' => 1,
    'size' => 50
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-project-id: <x-project-id>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.example.com/api/v1/business/workflows/components"

	payload := strings.NewReader("{\n  \"search\": \"<string>\",\n  \"capability_ids\": [\n    \"<string>\"\n  ],\n  \"skill_id\": \"<string>\",\n  \"capability_id\": \"<string>\",\n  \"page\": 1,\n  \"size\": 50\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-project-id", "<x-project-id>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/business/workflows/components")
  .header("x-project-id", "<x-project-id>")
  .header("Content-Type", "application/json")
  .body("{\n  \"search\": \"<string>\",\n  \"capability_ids\": [\n    \"<string>\"\n  ],\n  \"skill_id\": \"<string>\",\n  \"capability_id\": \"<string>\",\n  \"page\": 1,\n  \"size\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/business/workflows/components")

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

request = Net::HTTP::Post.new(url)
request["x-project-id"] = '<x-project-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"search\": \"<string>\",\n  \"capability_ids\": [\n    \"<string>\"\n  ],\n  \"skill_id\": \"<string>\",\n  \"capability_id\": \"<string>\",\n  \"page\": 1,\n  \"size\": 50\n}"

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

x-project-id

string<uuid>

required

Project ID for tenant scoping

X-Workspace-Id

string<uuid> | null

Overrides the key's workspace

X-API-Key

string | null

User API key

Body

application/json

view

enum<string>

required

'components' catalog, 'batch' by ids, or 'hub_capabilities'

Available options:

components,

batch,

hub_capabilities

string | null

Free-text search (components view)

capability_ids

string[] | null

Capability ids to fetch (required for view='batch')

skill_id

string | null

Hub skill id filter (hub_capabilities view) - pass this directly when the skill is already named; no need to list unfiltered first.

capability_id

string | null

Hub capability id filter (hub_capabilities view) - pass this directly when the capability id is already known; no need to list unfiltered first.

page

integer

default:1

1-based page

Required range: x >= 1

size

integer

default:50

Page size

Required range: 1 <= x <= 100

Response

Successful Response

Getting Started

Identity & Project

Tasks

Agent Runs

Playbooks

Grids

Knowledge Base & Brand Kit

Pages

Integrations & Attachments

List workflow components

Headers

Body

Response