Workflows

Preview a resolved workflow (Beta)

Beta. Resolve a workflow's prompt template against supplied workflow_params without running it. Returns the resolved prompt, research strategy, report format, deliverables, recommended mode, and tools - exactly what a run would use. Useful for validating parameters before incurring a DeepResearch cost.

post/v1/workflows/{slug}/preview

Request

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

Path parameters

slugstring required

The workflow slug.

Request body

workflow_paramsobject

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

workflow_versioninteger

Version to preview. Defaults to the current version.

Example request

{
  "workflow_params": {
    "company": "NVIDIA (NVDA)"
  },
  "workflow_version": 1
}

Response

Resolved configuration.

estimated_creditsnumber nullable

Estimated credit cost of a run, when available.

Example response

{
  "workflow": {
    "slug": "ib-company-profile",
    "version": 1
  },
  "resolved": {
    "input": "Build a company profile for NVIDIA (NVDA) covering its business, financials, and recent developments.",
    "deliverables": [
      {
        "type": "xlsx",
        "description": "A model summary tab with revenue, margins, and key ratios."
      }
    ],
    "mode": "heavy",
    "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.