Create an organization workflow (Beta)
curl --request POST \
--url https://api.valyu.ai/v1/workflows \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"slug": "quarterly-company-profile",
"title": "Quarterly Company Profile",
"version": {
"prompt": "Build a company profile for {company} covering its business, financials, and recent developments.",
"strategy": "Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.",
"report_format": "A one-page profile with business overview, key financials, and recent developments.",
"variables": [
{
"key": "company",
"label": "Company name",
"type": "text",
"required": false,
"placeholder": "NVIDIA (NVDA)",
"help": "The company you want to profile.",
"examples": [
"NVIDIA (NVDA)",
"Microsoft (MSFT)"
],
"validation": {
"min_length": 1,
"max_length": 2,
"pattern": "<string>",
"enum": [
"<string>"
]
}
}
],
"deliverables": [
{
"type": "xlsx",
"description": "A model summary tab with revenue, margins, and key ratios."
}
],
"tools": {
"code_execution": true,
"screenshots": true,
"browser_use": true,
"charts": true
},
"recommended_mode": "heavy",
"estimated_time": "10-20 min",
"output_formats": [
{
"type": "object",
"properties": {
"base_case": {
"type": "string"
},
"bull_case": {
"type": "string"
},
"bear_case": {
"type": "string"
},
"confidence": {
"type": "number"
}
}
},
"toon"
],
"changelog": "Added a competitive landscape section."
},
"subtitle": "One-page profile of a public company.",
"description": "Builds a company profile covering business, financials, and recent developments.",
"vertical": "investment-banking",
"tags": [
"company-profile",
"equities"
],
"icon": "building"
}
'import requests
url = "https://api.valyu.ai/v1/workflows"
payload = {
"slug": "quarterly-company-profile",
"title": "Quarterly Company Profile",
"version": {
"prompt": "Build a company profile for {company} covering its business, financials, and recent developments.",
"strategy": "Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.",
"report_format": "A one-page profile with business overview, key financials, and recent developments.",
"variables": [
{
"key": "company",
"label": "Company name",
"type": "text",
"required": False,
"placeholder": "NVIDIA (NVDA)",
"help": "The company you want to profile.",
"examples": ["NVIDIA (NVDA)", "Microsoft (MSFT)"],
"validation": {
"min_length": 1,
"max_length": 2,
"pattern": "<string>",
"enum": ["<string>"]
}
}
],
"deliverables": [
{
"type": "xlsx",
"description": "A model summary tab with revenue, margins, and key ratios."
}
],
"tools": {
"code_execution": True,
"screenshots": True,
"browser_use": True,
"charts": True
},
"recommended_mode": "heavy",
"estimated_time": "10-20 min",
"output_formats": [
{
"type": "object",
"properties": {
"base_case": { "type": "string" },
"bull_case": { "type": "string" },
"bear_case": { "type": "string" },
"confidence": { "type": "number" }
}
},
"toon"
],
"changelog": "Added a competitive landscape section."
},
"subtitle": "One-page profile of a public company.",
"description": "Builds a company profile covering business, financials, and recent developments.",
"vertical": "investment-banking",
"tags": ["company-profile", "equities"],
"icon": "building"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: 'quarterly-company-profile',
title: 'Quarterly Company Profile',
version: {
prompt: 'Build a company profile for {company} covering its business, financials, and recent developments.',
strategy: 'Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.',
report_format: 'A one-page profile with business overview, key financials, and recent developments.',
variables: [
{
key: 'company',
label: 'Company name',
type: 'text',
required: false,
placeholder: 'NVIDIA (NVDA)',
help: 'The company you want to profile.',
examples: ['NVIDIA (NVDA)', 'Microsoft (MSFT)'],
validation: {min_length: 1, max_length: 2, pattern: '<string>', enum: ['<string>']}
}
],
deliverables: [
{
type: 'xlsx',
description: 'A model summary tab with revenue, margins, and key ratios.'
}
],
tools: {code_execution: true, screenshots: true, browser_use: true, charts: true},
recommended_mode: 'heavy',
estimated_time: '10-20 min',
output_formats: [
{
type: 'object',
properties: {
base_case: {type: 'string'},
bull_case: {type: 'string'},
bear_case: {type: 'string'},
confidence: {type: 'number'}
}
},
'toon'
],
changelog: 'Added a competitive landscape section.'
},
subtitle: 'One-page profile of a public company.',
description: 'Builds a company profile covering business, financials, and recent developments.',
vertical: 'investment-banking',
tags: ['company-profile', 'equities'],
icon: 'building'
})
};
fetch('https://api.valyu.ai/v1/workflows', 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.valyu.ai/v1/workflows",
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([
'slug' => 'quarterly-company-profile',
'title' => 'Quarterly Company Profile',
'version' => [
'prompt' => 'Build a company profile for {company} covering its business, financials, and recent developments.',
'strategy' => 'Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.',
'report_format' => 'A one-page profile with business overview, key financials, and recent developments.',
'variables' => [
[
'key' => 'company',
'label' => 'Company name',
'type' => 'text',
'required' => false,
'placeholder' => 'NVIDIA (NVDA)',
'help' => 'The company you want to profile.',
'examples' => [
'NVIDIA (NVDA)',
'Microsoft (MSFT)'
],
'validation' => [
'min_length' => 1,
'max_length' => 2,
'pattern' => '<string>',
'enum' => [
'<string>'
]
]
]
],
'deliverables' => [
[
'type' => 'xlsx',
'description' => 'A model summary tab with revenue, margins, and key ratios.'
]
],
'tools' => [
'code_execution' => true,
'screenshots' => true,
'browser_use' => true,
'charts' => true
],
'recommended_mode' => 'heavy',
'estimated_time' => '10-20 min',
'output_formats' => [
[
'type' => 'object',
'properties' => [
'base_case' => [
'type' => 'string'
],
'bull_case' => [
'type' => 'string'
],
'bear_case' => [
'type' => 'string'
],
'confidence' => [
'type' => 'number'
]
]
],
'toon'
],
'changelog' => 'Added a competitive landscape section.'
],
'subtitle' => 'One-page profile of a public company.',
'description' => 'Builds a company profile covering business, financials, and recent developments.',
'vertical' => 'investment-banking',
'tags' => [
'company-profile',
'equities'
],
'icon' => 'building'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.valyu.ai/v1/workflows"
payload := strings.NewReader("{\n \"slug\": \"quarterly-company-profile\",\n \"title\": \"Quarterly Company Profile\",\n \"version\": {\n \"prompt\": \"Build a company profile for {company} covering its business, financials, and recent developments.\",\n \"strategy\": \"Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.\",\n \"report_format\": \"A one-page profile with business overview, key financials, and recent developments.\",\n \"variables\": [\n {\n \"key\": \"company\",\n \"label\": \"Company name\",\n \"type\": \"text\",\n \"required\": false,\n \"placeholder\": \"NVIDIA (NVDA)\",\n \"help\": \"The company you want to profile.\",\n \"examples\": [\n \"NVIDIA (NVDA)\",\n \"Microsoft (MSFT)\"\n ],\n \"validation\": {\n \"min_length\": 1,\n \"max_length\": 2,\n \"pattern\": \"<string>\",\n \"enum\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"deliverables\": [\n {\n \"type\": \"xlsx\",\n \"description\": \"A model summary tab with revenue, margins, and key ratios.\"\n }\n ],\n \"tools\": {\n \"code_execution\": true,\n \"screenshots\": true,\n \"browser_use\": true,\n \"charts\": true\n },\n \"recommended_mode\": \"heavy\",\n \"estimated_time\": \"10-20 min\",\n \"output_formats\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"base_case\": {\n \"type\": \"string\"\n },\n \"bull_case\": {\n \"type\": \"string\"\n },\n \"bear_case\": {\n \"type\": \"string\"\n },\n \"confidence\": {\n \"type\": \"number\"\n }\n }\n },\n \"toon\"\n ],\n \"changelog\": \"Added a competitive landscape section.\"\n },\n \"subtitle\": \"One-page profile of a public company.\",\n \"description\": \"Builds a company profile covering business, financials, and recent developments.\",\n \"vertical\": \"investment-banking\",\n \"tags\": [\n \"company-profile\",\n \"equities\"\n ],\n \"icon\": \"building\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.valyu.ai/v1/workflows")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"quarterly-company-profile\",\n \"title\": \"Quarterly Company Profile\",\n \"version\": {\n \"prompt\": \"Build a company profile for {company} covering its business, financials, and recent developments.\",\n \"strategy\": \"Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.\",\n \"report_format\": \"A one-page profile with business overview, key financials, and recent developments.\",\n \"variables\": [\n {\n \"key\": \"company\",\n \"label\": \"Company name\",\n \"type\": \"text\",\n \"required\": false,\n \"placeholder\": \"NVIDIA (NVDA)\",\n \"help\": \"The company you want to profile.\",\n \"examples\": [\n \"NVIDIA (NVDA)\",\n \"Microsoft (MSFT)\"\n ],\n \"validation\": {\n \"min_length\": 1,\n \"max_length\": 2,\n \"pattern\": \"<string>\",\n \"enum\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"deliverables\": [\n {\n \"type\": \"xlsx\",\n \"description\": \"A model summary tab with revenue, margins, and key ratios.\"\n }\n ],\n \"tools\": {\n \"code_execution\": true,\n \"screenshots\": true,\n \"browser_use\": true,\n \"charts\": true\n },\n \"recommended_mode\": \"heavy\",\n \"estimated_time\": \"10-20 min\",\n \"output_formats\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"base_case\": {\n \"type\": \"string\"\n },\n \"bull_case\": {\n \"type\": \"string\"\n },\n \"bear_case\": {\n \"type\": \"string\"\n },\n \"confidence\": {\n \"type\": \"number\"\n }\n }\n },\n \"toon\"\n ],\n \"changelog\": \"Added a competitive landscape section.\"\n },\n \"subtitle\": \"One-page profile of a public company.\",\n \"description\": \"Builds a company profile covering business, financials, and recent developments.\",\n \"vertical\": \"investment-banking\",\n \"tags\": [\n \"company-profile\",\n \"equities\"\n ],\n \"icon\": \"building\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valyu.ai/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"quarterly-company-profile\",\n \"title\": \"Quarterly Company Profile\",\n \"version\": {\n \"prompt\": \"Build a company profile for {company} covering its business, financials, and recent developments.\",\n \"strategy\": \"Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.\",\n \"report_format\": \"A one-page profile with business overview, key financials, and recent developments.\",\n \"variables\": [\n {\n \"key\": \"company\",\n \"label\": \"Company name\",\n \"type\": \"text\",\n \"required\": false,\n \"placeholder\": \"NVIDIA (NVDA)\",\n \"help\": \"The company you want to profile.\",\n \"examples\": [\n \"NVIDIA (NVDA)\",\n \"Microsoft (MSFT)\"\n ],\n \"validation\": {\n \"min_length\": 1,\n \"max_length\": 2,\n \"pattern\": \"<string>\",\n \"enum\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"deliverables\": [\n {\n \"type\": \"xlsx\",\n \"description\": \"A model summary tab with revenue, margins, and key ratios.\"\n }\n ],\n \"tools\": {\n \"code_execution\": true,\n \"screenshots\": true,\n \"browser_use\": true,\n \"charts\": true\n },\n \"recommended_mode\": \"heavy\",\n \"estimated_time\": \"10-20 min\",\n \"output_formats\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"base_case\": {\n \"type\": \"string\"\n },\n \"bull_case\": {\n \"type\": \"string\"\n },\n \"bear_case\": {\n \"type\": \"string\"\n },\n \"confidence\": {\n \"type\": \"number\"\n }\n }\n },\n \"toon\"\n ],\n \"changelog\": \"Added a competitive landscape section.\"\n },\n \"subtitle\": \"One-page profile of a public company.\",\n \"description\": \"Builds a company profile covering business, financials, and recent developments.\",\n \"vertical\": \"investment-banking\",\n \"tags\": [\n \"company-profile\",\n \"equities\"\n ],\n \"icon\": \"building\"\n}"
response = http.request(request)
puts response.read_body{
"slug": "ib-company-profile",
"version": 1,
"title": "Company Profile",
"vertical": "investment-banking",
"tags": [
"company-profile",
"equities"
],
"subtitle": "One-page profile of a public company.",
"description": "Builds a company profile covering business, financials, and recent developments.",
"popular": true,
"recommended_mode": "heavy",
"estimated_time": "10-20 min",
"is_valyu": true,
"owner_org_id": null,
"variables": [
{
"key": "company",
"label": "Company name",
"type": "text",
"required": false,
"placeholder": "NVIDIA (NVDA)",
"help": "The company you want to profile.",
"examples": [
"NVIDIA (NVDA)",
"Microsoft (MSFT)"
],
"validation": {
"min_length": 1,
"max_length": 2,
"pattern": "<string>",
"enum": [
"<string>"
]
}
}
],
"deliverables": [
{
"type": "xlsx",
"description": "A model summary tab with revenue, margins, and key ratios."
}
],
"created_at": "2026-01-10T12:00:00Z",
"updated_at": "2026-01-15T09:30:00Z",
"prompt": "Build a company profile for {company} covering its business, financials, and recent developments.",
"strategy": "<string>",
"report_format": "<string>",
"tools": {
"code_execution": true,
"screenshots": true,
"browser_use": true,
"charts": true
},
"changelog": "<string>",
"output_formats": [
{
"type": "object",
"properties": {
"base_case": {
"type": "string"
},
"bull_case": {
"type": "string"
},
"bear_case": {
"type": "string"
},
"confidence": {
"type": "number"
}
}
},
"toon"
]
}Create Workflow
Reference for creating a custom org Workflow template via POST /v1/workflows.
POST
/
v1
/
workflows
Create an organization workflow (Beta)
curl --request POST \
--url https://api.valyu.ai/v1/workflows \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"slug": "quarterly-company-profile",
"title": "Quarterly Company Profile",
"version": {
"prompt": "Build a company profile for {company} covering its business, financials, and recent developments.",
"strategy": "Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.",
"report_format": "A one-page profile with business overview, key financials, and recent developments.",
"variables": [
{
"key": "company",
"label": "Company name",
"type": "text",
"required": false,
"placeholder": "NVIDIA (NVDA)",
"help": "The company you want to profile.",
"examples": [
"NVIDIA (NVDA)",
"Microsoft (MSFT)"
],
"validation": {
"min_length": 1,
"max_length": 2,
"pattern": "<string>",
"enum": [
"<string>"
]
}
}
],
"deliverables": [
{
"type": "xlsx",
"description": "A model summary tab with revenue, margins, and key ratios."
}
],
"tools": {
"code_execution": true,
"screenshots": true,
"browser_use": true,
"charts": true
},
"recommended_mode": "heavy",
"estimated_time": "10-20 min",
"output_formats": [
{
"type": "object",
"properties": {
"base_case": {
"type": "string"
},
"bull_case": {
"type": "string"
},
"bear_case": {
"type": "string"
},
"confidence": {
"type": "number"
}
}
},
"toon"
],
"changelog": "Added a competitive landscape section."
},
"subtitle": "One-page profile of a public company.",
"description": "Builds a company profile covering business, financials, and recent developments.",
"vertical": "investment-banking",
"tags": [
"company-profile",
"equities"
],
"icon": "building"
}
'import requests
url = "https://api.valyu.ai/v1/workflows"
payload = {
"slug": "quarterly-company-profile",
"title": "Quarterly Company Profile",
"version": {
"prompt": "Build a company profile for {company} covering its business, financials, and recent developments.",
"strategy": "Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.",
"report_format": "A one-page profile with business overview, key financials, and recent developments.",
"variables": [
{
"key": "company",
"label": "Company name",
"type": "text",
"required": False,
"placeholder": "NVIDIA (NVDA)",
"help": "The company you want to profile.",
"examples": ["NVIDIA (NVDA)", "Microsoft (MSFT)"],
"validation": {
"min_length": 1,
"max_length": 2,
"pattern": "<string>",
"enum": ["<string>"]
}
}
],
"deliverables": [
{
"type": "xlsx",
"description": "A model summary tab with revenue, margins, and key ratios."
}
],
"tools": {
"code_execution": True,
"screenshots": True,
"browser_use": True,
"charts": True
},
"recommended_mode": "heavy",
"estimated_time": "10-20 min",
"output_formats": [
{
"type": "object",
"properties": {
"base_case": { "type": "string" },
"bull_case": { "type": "string" },
"bear_case": { "type": "string" },
"confidence": { "type": "number" }
}
},
"toon"
],
"changelog": "Added a competitive landscape section."
},
"subtitle": "One-page profile of a public company.",
"description": "Builds a company profile covering business, financials, and recent developments.",
"vertical": "investment-banking",
"tags": ["company-profile", "equities"],
"icon": "building"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: 'quarterly-company-profile',
title: 'Quarterly Company Profile',
version: {
prompt: 'Build a company profile for {company} covering its business, financials, and recent developments.',
strategy: 'Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.',
report_format: 'A one-page profile with business overview, key financials, and recent developments.',
variables: [
{
key: 'company',
label: 'Company name',
type: 'text',
required: false,
placeholder: 'NVIDIA (NVDA)',
help: 'The company you want to profile.',
examples: ['NVIDIA (NVDA)', 'Microsoft (MSFT)'],
validation: {min_length: 1, max_length: 2, pattern: '<string>', enum: ['<string>']}
}
],
deliverables: [
{
type: 'xlsx',
description: 'A model summary tab with revenue, margins, and key ratios.'
}
],
tools: {code_execution: true, screenshots: true, browser_use: true, charts: true},
recommended_mode: 'heavy',
estimated_time: '10-20 min',
output_formats: [
{
type: 'object',
properties: {
base_case: {type: 'string'},
bull_case: {type: 'string'},
bear_case: {type: 'string'},
confidence: {type: 'number'}
}
},
'toon'
],
changelog: 'Added a competitive landscape section.'
},
subtitle: 'One-page profile of a public company.',
description: 'Builds a company profile covering business, financials, and recent developments.',
vertical: 'investment-banking',
tags: ['company-profile', 'equities'],
icon: 'building'
})
};
fetch('https://api.valyu.ai/v1/workflows', 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.valyu.ai/v1/workflows",
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([
'slug' => 'quarterly-company-profile',
'title' => 'Quarterly Company Profile',
'version' => [
'prompt' => 'Build a company profile for {company} covering its business, financials, and recent developments.',
'strategy' => 'Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.',
'report_format' => 'A one-page profile with business overview, key financials, and recent developments.',
'variables' => [
[
'key' => 'company',
'label' => 'Company name',
'type' => 'text',
'required' => false,
'placeholder' => 'NVIDIA (NVDA)',
'help' => 'The company you want to profile.',
'examples' => [
'NVIDIA (NVDA)',
'Microsoft (MSFT)'
],
'validation' => [
'min_length' => 1,
'max_length' => 2,
'pattern' => '<string>',
'enum' => [
'<string>'
]
]
]
],
'deliverables' => [
[
'type' => 'xlsx',
'description' => 'A model summary tab with revenue, margins, and key ratios.'
]
],
'tools' => [
'code_execution' => true,
'screenshots' => true,
'browser_use' => true,
'charts' => true
],
'recommended_mode' => 'heavy',
'estimated_time' => '10-20 min',
'output_formats' => [
[
'type' => 'object',
'properties' => [
'base_case' => [
'type' => 'string'
],
'bull_case' => [
'type' => 'string'
],
'bear_case' => [
'type' => 'string'
],
'confidence' => [
'type' => 'number'
]
]
],
'toon'
],
'changelog' => 'Added a competitive landscape section.'
],
'subtitle' => 'One-page profile of a public company.',
'description' => 'Builds a company profile covering business, financials, and recent developments.',
'vertical' => 'investment-banking',
'tags' => [
'company-profile',
'equities'
],
'icon' => 'building'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.valyu.ai/v1/workflows"
payload := strings.NewReader("{\n \"slug\": \"quarterly-company-profile\",\n \"title\": \"Quarterly Company Profile\",\n \"version\": {\n \"prompt\": \"Build a company profile for {company} covering its business, financials, and recent developments.\",\n \"strategy\": \"Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.\",\n \"report_format\": \"A one-page profile with business overview, key financials, and recent developments.\",\n \"variables\": [\n {\n \"key\": \"company\",\n \"label\": \"Company name\",\n \"type\": \"text\",\n \"required\": false,\n \"placeholder\": \"NVIDIA (NVDA)\",\n \"help\": \"The company you want to profile.\",\n \"examples\": [\n \"NVIDIA (NVDA)\",\n \"Microsoft (MSFT)\"\n ],\n \"validation\": {\n \"min_length\": 1,\n \"max_length\": 2,\n \"pattern\": \"<string>\",\n \"enum\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"deliverables\": [\n {\n \"type\": \"xlsx\",\n \"description\": \"A model summary tab with revenue, margins, and key ratios.\"\n }\n ],\n \"tools\": {\n \"code_execution\": true,\n \"screenshots\": true,\n \"browser_use\": true,\n \"charts\": true\n },\n \"recommended_mode\": \"heavy\",\n \"estimated_time\": \"10-20 min\",\n \"output_formats\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"base_case\": {\n \"type\": \"string\"\n },\n \"bull_case\": {\n \"type\": \"string\"\n },\n \"bear_case\": {\n \"type\": \"string\"\n },\n \"confidence\": {\n \"type\": \"number\"\n }\n }\n },\n \"toon\"\n ],\n \"changelog\": \"Added a competitive landscape section.\"\n },\n \"subtitle\": \"One-page profile of a public company.\",\n \"description\": \"Builds a company profile covering business, financials, and recent developments.\",\n \"vertical\": \"investment-banking\",\n \"tags\": [\n \"company-profile\",\n \"equities\"\n ],\n \"icon\": \"building\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.valyu.ai/v1/workflows")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"quarterly-company-profile\",\n \"title\": \"Quarterly Company Profile\",\n \"version\": {\n \"prompt\": \"Build a company profile for {company} covering its business, financials, and recent developments.\",\n \"strategy\": \"Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.\",\n \"report_format\": \"A one-page profile with business overview, key financials, and recent developments.\",\n \"variables\": [\n {\n \"key\": \"company\",\n \"label\": \"Company name\",\n \"type\": \"text\",\n \"required\": false,\n \"placeholder\": \"NVIDIA (NVDA)\",\n \"help\": \"The company you want to profile.\",\n \"examples\": [\n \"NVIDIA (NVDA)\",\n \"Microsoft (MSFT)\"\n ],\n \"validation\": {\n \"min_length\": 1,\n \"max_length\": 2,\n \"pattern\": \"<string>\",\n \"enum\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"deliverables\": [\n {\n \"type\": \"xlsx\",\n \"description\": \"A model summary tab with revenue, margins, and key ratios.\"\n }\n ],\n \"tools\": {\n \"code_execution\": true,\n \"screenshots\": true,\n \"browser_use\": true,\n \"charts\": true\n },\n \"recommended_mode\": \"heavy\",\n \"estimated_time\": \"10-20 min\",\n \"output_formats\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"base_case\": {\n \"type\": \"string\"\n },\n \"bull_case\": {\n \"type\": \"string\"\n },\n \"bear_case\": {\n \"type\": \"string\"\n },\n \"confidence\": {\n \"type\": \"number\"\n }\n }\n },\n \"toon\"\n ],\n \"changelog\": \"Added a competitive landscape section.\"\n },\n \"subtitle\": \"One-page profile of a public company.\",\n \"description\": \"Builds a company profile covering business, financials, and recent developments.\",\n \"vertical\": \"investment-banking\",\n \"tags\": [\n \"company-profile\",\n \"equities\"\n ],\n \"icon\": \"building\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valyu.ai/v1/workflows")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"quarterly-company-profile\",\n \"title\": \"Quarterly Company Profile\",\n \"version\": {\n \"prompt\": \"Build a company profile for {company} covering its business, financials, and recent developments.\",\n \"strategy\": \"Prioritise the latest 10-K/10-Q, investor relations materials, and reputable news.\",\n \"report_format\": \"A one-page profile with business overview, key financials, and recent developments.\",\n \"variables\": [\n {\n \"key\": \"company\",\n \"label\": \"Company name\",\n \"type\": \"text\",\n \"required\": false,\n \"placeholder\": \"NVIDIA (NVDA)\",\n \"help\": \"The company you want to profile.\",\n \"examples\": [\n \"NVIDIA (NVDA)\",\n \"Microsoft (MSFT)\"\n ],\n \"validation\": {\n \"min_length\": 1,\n \"max_length\": 2,\n \"pattern\": \"<string>\",\n \"enum\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"deliverables\": [\n {\n \"type\": \"xlsx\",\n \"description\": \"A model summary tab with revenue, margins, and key ratios.\"\n }\n ],\n \"tools\": {\n \"code_execution\": true,\n \"screenshots\": true,\n \"browser_use\": true,\n \"charts\": true\n },\n \"recommended_mode\": \"heavy\",\n \"estimated_time\": \"10-20 min\",\n \"output_formats\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"base_case\": {\n \"type\": \"string\"\n },\n \"bull_case\": {\n \"type\": \"string\"\n },\n \"bear_case\": {\n \"type\": \"string\"\n },\n \"confidence\": {\n \"type\": \"number\"\n }\n }\n },\n \"toon\"\n ],\n \"changelog\": \"Added a competitive landscape section.\"\n },\n \"subtitle\": \"One-page profile of a public company.\",\n \"description\": \"Builds a company profile covering business, financials, and recent developments.\",\n \"vertical\": \"investment-banking\",\n \"tags\": [\n \"company-profile\",\n \"equities\"\n ],\n \"icon\": \"building\"\n}"
response = http.request(request)
puts response.read_body{
"slug": "ib-company-profile",
"version": 1,
"title": "Company Profile",
"vertical": "investment-banking",
"tags": [
"company-profile",
"equities"
],
"subtitle": "One-page profile of a public company.",
"description": "Builds a company profile covering business, financials, and recent developments.",
"popular": true,
"recommended_mode": "heavy",
"estimated_time": "10-20 min",
"is_valyu": true,
"owner_org_id": null,
"variables": [
{
"key": "company",
"label": "Company name",
"type": "text",
"required": false,
"placeholder": "NVIDIA (NVDA)",
"help": "The company you want to profile.",
"examples": [
"NVIDIA (NVDA)",
"Microsoft (MSFT)"
],
"validation": {
"min_length": 1,
"max_length": 2,
"pattern": "<string>",
"enum": [
"<string>"
]
}
}
],
"deliverables": [
{
"type": "xlsx",
"description": "A model summary tab with revenue, margins, and key ratios."
}
],
"created_at": "2026-01-10T12:00:00Z",
"updated_at": "2026-01-15T09:30:00Z",
"prompt": "Build a company profile for {company} covering its business, financials, and recent developments.",
"strategy": "<string>",
"report_format": "<string>",
"tools": {
"code_execution": true,
"screenshots": true,
"browser_use": true,
"charts": true
},
"changelog": "<string>",
"output_formats": [
{
"type": "object",
"properties": {
"base_case": {
"type": "string"
},
"bull_case": {
"type": "string"
},
"bear_case": {
"type": "string"
},
"confidence": {
"type": "number"
}
}
},
"toon"
]
}Beta
Create a workflow owned by your organization. Define the variable inputs and the instructions that should remain consistent between runs.
Creating a workflow does not run research or schedule recurring execution. Preview the template, then create a research task with its slug and parameter values.
Authorizations
API key for authentication. Get yours at platform.valyu.ai.
Body
application/json
Create an organization workflow. The authenticated org owns the workflow. Default org quota is 100 workflows. The first version is supplied as the nested version object.
Unique slug within your org.
Example:
"quarterly-company-profile"
Example:
"Quarterly Company Profile"
The workflow's first version body.
Show child attributes
Show child attributes
Example:
"One-page profile of a public company."
Example:
"Builds a company profile covering business, financials, and recent developments."
Example:
"investment-banking"
Maximum array length:
20Example:
["company-profile", "equities"]
Example:
"building"
Response
Workflow created.
A single workflow returned as a flat object: the list-row fields plus the resolved version body (prompt, strategy, report_format, tools, changelog, output_formats). Returned by get, create (201), and update.
Unique slug identifying the workflow within its scope. Used as workflow_id when running.
Example:
"ib-company-profile"
The current (floating) published version number.
Required range:
x >= 1Example:
1
Display title.
Example:
"Company Profile"
Vertical the workflow targets (e.g. investment-banking, private-equity, hedge-funds, consulting, life-sciences, legal-regulatory, sales-intelligence, supply-chain).
Example:
"investment-banking"
Tags for discovery. Up to 20.
Maximum array length:
20Example:
["company-profile", "equities"]
Short subtitle.
Example:
"One-page profile of a public company."
Longer description of what the workflow does.
Example:
"Builds a company profile covering business, financials, and recent developments."
Whether the workflow is flagged as popular.
Example:
true
Recommended DeepResearch mode for a workflow. Maps directly to the DeepResearch mode parameter.
Available options:
fast, standard, heavy, max Example:
"heavy"
Human-readable estimate of how long a run takes.
Example:
"10-20 min"
Whether this is a Valyu-curated workflow (read-only to users).
Example:
true
Organization that owns the workflow. null for Valyu-curated workflows.
Example:
null
Typed variables referenced by the prompt template. Up to 50.
Maximum array length:
50Show child attributes
Show child attributes
Deliverables the workflow produces. Up to 20.
Maximum array length:
20Show child attributes
Show child attributes
When the workflow was created.
Example:
"2026-01-10T12:00:00Z"
When the workflow's current version was last published.
Example:
"2026-01-15T09:30:00Z"
Prompt template with {key} placeholders. Included on detail (get/create/update) and on list with ?expand=true.
Example:
"Build a company profile for {company} covering its business, financials, and recent developments."
Research strategy. Maps to DeepResearch research_strategy. Included on detail and on list with ?expand=true.
Report format instructions. Maps to DeepResearch report_format. Included on detail and on list with ?expand=true.
Optional tools the workflow's research agent may use.
Show child attributes
Show child attributes
Changelog for the current version. Included on detail and on list with ?expand=true.
Output formats the workflow produces. Items are the strings "markdown", "pdf", or "toon", and/or a single JSON Schema object for structured output. Rules: at most one JSON Schema object; a JSON Schema object cannot be combined with "markdown" or "pdf"; "toon" requires a JSON Schema object. An invalid combination returns 400 invalid_output_formats.
At run time, a task created with workflow_id inherits the workflow's output_formats when the request does not pass its own; a request-level output_formats always wins.
Available options:
markdown, pdf, toon Example:
[
{
"type": "object",
"properties": {
"base_case": { "type": "string" },
"bull_case": { "type": "string" },
"bear_case": { "type": "string" },
"confidence": { "type": "number" }
}
},
"toon"
]
Was this page helpful?