Workflows

Get a workflow (Beta)

Beta. Retrieve a single workflow with its resolved version. By default returns the current version; pass version to fetch a specific one.

get/v1/workflows/{slug}

Request

  • Base URL: https://api.valyu.ai
  • URL: https://api.valyu.ai/v1/workflows/{slug}
  • Auth: API key in header X-API-Key

Path parameters

slugstring required

The workflow slug.

Query parameters

versioninteger

Version to return. Defaults to the current version.

Response

The workflow.

slugstring required

Unique slug identifying the workflow within its scope. Used as workflow_id when running.

versioninteger required

The current (floating) published version number.

verticalstring nullable

Vertical the workflow targets (e.g. investment-banking, private-equity, hedge-funds, consulting, life-sciences, legal-regulatory, sales-intelligence, supply-chain).

tagsstring[]

Tags for discovery. Up to 20.

titlestring required

Display title.

subtitlestring nullable

Short subtitle.

descriptionstring nullable

Longer description of what the workflow does.

popularboolean

Whether the workflow is flagged as popular.

recommended_mode'fast' | 'standard' | 'heavy' | 'max'

Recommended DeepResearch mode for a workflow. Maps directly to the DeepResearch mode parameter.

estimated_timestring nullable

Human-readable estimate of how long a run takes.

is_valyuboolean

Whether this is a Valyu-curated workflow (read-only to users).

owner_org_idstring nullable

Organization that owns the workflow. null for Valyu-curated workflows.

created_atstring date-time

When the workflow was created.

updated_atstring date-time

When the workflow's current version was last published.

promptstring

Prompt template with {key} placeholders. Included on detail (get/create/update) and on list with ?expand=true.

strategystring nullable

Research strategy. Maps to DeepResearch research_strategy. Included on detail and on list with ?expand=true.

report_formatstring nullable

Report format instructions. Maps to DeepResearch report_format. Included on detail and on list with ?expand=true.

changelogstring nullable

Changelog for the current version. Included on detail and on list with ?expand=true.

Example response

{
  "slug": "ib-company-profile",
  "version": 1,
  "vertical": "investment-banking",
  "tags": [
    "company-profile",
    "equities"
  ],
  "title": "Company Profile",
  "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,
  "variables": [
    {
      "key": "company",
      "label": "Company name",
      "type": "text",
      "placeholder": "NVIDIA (NVDA)",
      "help": "The company you want to profile.",
      "examples": [
        "NVIDIA (NVDA)",
        "Microsoft (MSFT)"
      ]
    }
  ],
  "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.",
  "output_formats": [
    {
      "type": "object",
      "properties": {
        "base_case": {
          "type": "string"
        },
        "bull_case": {
          "type": "string"
        },
        "bear_case": {
          "type": "string"
        },
        "confidence": {
          "type": "number"
        }
      }
    },
    "toon"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.