Skip to main content
POST
/
v1
/
workflows
/
{slug}
/
preview
Preview a resolved workflow (Beta)
curl --request POST \
  --url https://api.valyu.ai/v1/workflows/{slug}/preview \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "workflow_params": {
    "company": "NVIDIA (NVDA)"
  },
  "workflow_version": 1
}
'
{
  "workflow": {
    "slug": "ib-company-profile",
    "version": 1
  },
  "resolved": {
    "input": "Build a company profile for NVIDIA (NVDA) covering its business, financials, and recent developments.",
    "research_strategy": "<string>",
    "report_format": "<string>",
    "deliverables": [
      {
        "type": "xlsx",
        "description": "A model summary tab with revenue, margins, and key ratios."
      }
    ],
    "mode": "heavy",
    "tools": {
      "code_execution": true,
      "screenshots": true,
      "browser_use": true,
      "charts": true
    },
    "output_formats": [
      {
        "type": "object",
        "properties": {
          "base_case": {
            "type": "string"
          },
          "bull_case": {
            "type": "string"
          },
          "bear_case": {
            "type": "string"
          },
          "confidence": {
            "type": "number"
          }
        }
      },
      "toon"
    ]
  },
  "estimated_credits": null
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get yours at platform.valyu.ai.

Path Parameters

​
slug
string
required

The workflow slug.

Body

application/json

Resolve a workflow template against supplied parameters without running it.

​
workflow_params
object

Values for the workflow's template variables, keyed by variable key.

Example:
{ "company": "NVIDIA (NVDA)" }
​
workflow_version
integer

Version to preview. Defaults to the current version.

Required range: x >= 1
Example:

1

Response

Resolved configuration.

The resolved configuration a run with these parameters would use.

​
workflow
object
required

Which workflow and version were resolved.

​
resolved
object
required

The resolved DeepResearch configuration.

​
estimated_credits
number | null

Estimated credit cost of a run, when available.

Example:

null