For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Getting Started
Use Cases
Core Concepts
Integration Guides
API Details
Tutorials
Best Practices
- Changelog
API Reference

API Reference Workflows

Get workflow rollout map

GET

https://devapi.withverifa.com/api/v1/workflows/:workflow_id/rollout

GET

/api/v1/workflows/:workflow_id/rollout

$ curl https://devapi.withverifa.com/api/v1/workflows/workflow_id/rollout \
>      -H "X-API-Key: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "data": [
3     {
4       "version": 3,
5       "rollout_percentage": 60,
6       "updated_at": "2024-05-10T14:45:00Z"
7     },
8     {
9       "version": 4,
10       "rollout_percentage": 40,
11       "updated_at": "2024-05-10T14:45:00Z"
12     }
13   ]
14 }

Returns the version → traffic-percentage rollout map for a workflow. The percentages across active versions sum to 100.

Required scope: workflows:read

Was this page helpful?

Update workflow rollout map

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

workflow_idstringRequired

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Key-InflectionenumOptionalDefaults to snake

Response key casing. Defaults to snake.

Allowed values:

Response

Rollout map.

datalist of objects

Errors

401

Unauthorized Error

404

Not Found Error