Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"pages": [
"listWorkflowRunsV2",
"listPausedWorkflowRunsV2",
"getWorkflowRunV2",
"downloadWorkflowRunFileV2",
"resumeWorkflowRunV2",
Expand Down
25 changes: 25 additions & 0 deletions apps/docs/content/docs/cli/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7525,6 +7525,31 @@ sim workflows runs get <runId> [options]

API request and response schemas: [getWorkflowRun](/api-reference/workflow-runs/getWorkflowRunV2).

### sim workflows runs paused

List runs waiting on human input across the workspace

```bash
sim workflows runs paused [options]
```

**Options**

<CommandTable>

| Option | Required | Description |
| --- | --- | --- |
| `--include-output` | No | Include each pause point's reviewer `display` content when true. |
| `--no-include-output` | No | Send --include-output as false. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--cursor <value>` | No | Continue from nextCursor returned by a previous result. |
| `--sort-by <value>` | No | Field used to sort the result. Defaults to "pausedAt". Accepted values: `pausedAt`. |
| `--sort-order <value>` | No | Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`. |

</CommandTable>

API request and response schemas: [listPausedRuns](/api-reference/workflow-runs/listPausedWorkflowRunsV2).

### sim workflows runs list

List runs for a workflow
Expand Down
23 changes: 23 additions & 0 deletions apps/docs/content/docs/cli/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -806,6 +806,29 @@ sim workflows runs list [options]

API request and response schemas: [listWorkflowRuns](/api-reference/workflow-runs/listWorkflowRunsV2).

### List runs waiting on human input across the workspace

```bash
sim workflows runs paused [options]
```

**Options**

<CommandTable>

| Option | Required | Description |
| --- | --- | --- |
| `--include-output` | No | Include each pause point's reviewer `display` content when true. |
| `--no-include-output` | No | Send --include-output as false. |
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
| `--cursor <value>` | No | Continue from nextCursor returned by a previous result. |
| `--sort-by <value>` | No | Field used to sort the result. Defaults to "pausedAt". Accepted values: `pausedAt`. |
| `--sort-order <value>` | No | Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`. |

</CommandTable>

API request and response schemas: [listPausedRuns](/api-reference/workflow-runs/listPausedWorkflowRunsV2).

### Show run status

Requested outputs are included in JSON or YAML output.
Expand Down
65 changes: 62 additions & 3 deletions apps/docs/openapi-v2-billing.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"get": {
"operationId": "getBillingStatus",
"summary": "Get billing status",
"description": "Get the current plan, billing standing, credit allowance, and storage quota. Pooled `credits` and `storage` are visible only to callers who can manage the payer's billing; workspace API keys receive null for both. Use List billing logs for credit history.\n\nOAuth scope: `api:read`.",
"description": "Get the current plan, billing standing, credit allowance, storage quota, and plan limits on runs. Pooled `credits` and `storage` are visible only to callers who can manage the payer's billing; workspace API keys receive null for both, but every caller reads `limits`. Use List billing logs for credit history.\n\nOAuth scope: `api:read`.",
"x-sim-operation": "billing.status.read",
"x-oauth-scope": "api:read",
"tags": ["Billing"],
Expand Down Expand Up @@ -105,6 +105,11 @@
"usedBytes": 5242880,
"limitBytes": 1073741824,
"percentUsed": 0.48828125
},
"limits": {
"maxSyncExecutionTimeoutSeconds": 3000,
"maxAsyncExecutionTimeoutSeconds": 5400,
"maxConcurrentExecutions": 50
}
}
}
Expand Down Expand Up @@ -717,12 +722,61 @@
}
],
"description": "The payer's storage consumption and quota, or null when the caller cannot manage that payer's billing. Always null for a workspace API key."
},
"limits": {
"type": "object",
"properties": {
"maxSyncExecutionTimeoutSeconds": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Longest a synchronous run may execute, in seconds, or null when synchronous runs are not time-limited."
},
"maxAsyncExecutionTimeoutSeconds": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"description": "Longest an asynchronous run may execute, in seconds, or null when asynchronous runs are not time-limited. `executionTimeoutSeconds` on Execute workflow can lower it, never raise it."
},
"maxConcurrentExecutions": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "Most runs the payer can have executing at once, across every workspace and member it funds, or null when concurrency is not limited."
}
},
"required": [
"maxSyncExecutionTimeoutSeconds",
"maxAsyncExecutionTimeoutSeconds",
"maxConcurrentExecutions"
],
"additionalProperties": false,
"description": "The payer's plan caps on workflow runs. Visible to every caller that can read the plan, including workspace API keys."
}
},
"required": ["workspaceId", "period", "plan", "status", "credits", "storage"],
"required": ["workspaceId", "period", "plan", "status", "credits", "storage", "limits"],
"additionalProperties": false,
"title": "Billing status",
"description": "Current billing standing, credit allowance, and storage quota."
"description": "Current billing standing, credit allowance, storage quota, and plan limits."
},
"V2BillingStatusResponse": {
"type": "object",
Expand Down Expand Up @@ -755,6 +809,11 @@
"usedBytes": 5242880,
"limitBytes": 1073741824,
"percentUsed": 0.48828125
},
"limits": {
"maxSyncExecutionTimeoutSeconds": 3000,
"maxAsyncExecutionTimeoutSeconds": 5400,
"maxConcurrentExecutions": 50
}
}
}
Expand Down
Loading
Loading