Complete API reference with interactive try-it-out feature. Base URL: https://api.verifiedworkflows.com
/openapi.jsonAll endpoints require a Bearer token in the Authorization header. Obtain keys from your Account Settings.
Authorization: Bearer vw_live_YOUR_API_KEY
Workspace-Id: defaultTwo authentication methods are supported:
/v1/auth/login for user sessionsSliding window: 5 requests per 10 seconds per API key. Headers included in every response:
| Header | Description |
|---|---|
X-RateLimit-Limit | Maximum requests per window (5) |
X-RateLimit-Remaining | Remaining requests in current window |
Retry-After | Seconds to wait (only on 429 responses) |
All errors return a consistent JSON structure:
{
"type": "https://api.verifiedworkflows.com/errors/{error-type}",
"title": "Error Title",
"status": 400,
"detail": "Human-readable error description",
"instance": "/v1/tasks"
}| Status | Type | Description |
|---|---|---|
400 | bad-request | Invalid parameters |
401 | unauthorized | Missing/invalid auth |
403 | forbidden | Key revoked or insufficient scope |
404 | not-found | Resource not found |
422 | validation-failed | Schema validation error |
429 | rate-limit-exceeded | Too many requests |
500 | internal-error | Server error |
Create a new task for human review. Supports idempotency via Idempotency-Key header.
| Field | Type | Required | Description |
|---|---|---|---|
| type | string | yes | Task type |
| priority | string | yes | standard | express |
| title | string | yes | Task title |
| instructions | string | yes | Reviewer instructions |
| payload | object | yes | Task content |
| consensus_total | integer | no | Number of reviewers (default: 1) |
| required_skills | string[] | no | Required certifications |
| workflow_steps | string[] | no | Multi-step workflow labels |
Retrieve a specific task by ID including status, results, and metadata.
| Parameter | In | Type | Description |
|---|---|---|---|
| task_id | path | string | Task ID |
List all tasks in the workspace. Filtered by Workspace-Id header.
Submit a consensus vote for a task. When all votes are collected, the task is resolved.
Directly resolve a task with a result payload, bypassing the consensus flow.
Dashboard statistics: task counts, quality scores, balance, and completion metrics.
List all tasks for the authenticated client workspace with filtering support.
Submit multiple tasks in a single request. Max 100 tasks per batch.
Analytics overview with time-series data for tasks, quality, and costs.
Quality metrics broken down by task type, reviewer, and time period.
Cost breakdown by task type, priority, and time period.
Usage statistics and billing transaction history.
Save a task template for reuse. Body: { "name": string, "config": object }
List all saved task templates.
List webhook delivery attempts with status and retry information.
List all API keys for the workspace.
Create a new API key. Body: { "name": string, "scope": string }
Revoke an API key. The key will be marked as "Revoked" and can no longer be used.
List billing transactions for the workspace.
Add credits to workspace balance. Body: { "amount": float }