Skip to content
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"duplicateWorkflow",
"moveWorkflows",
"getWorkflowState",
"getWorkflowOutline",
"replaceWorkflowState",
"applyWorkflowOperations",
"applyWorkflowVariables",
Expand All @@ -24,6 +25,7 @@
"updateWorkflowPublicApi",
"listWorkflowTriggers",
"updateWorkflowTrigger",
"listWorkspaceSchedules",
"deployWorkflow",
"undeployWorkflow",
"rollbackWorkflow",
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/docs/api-reference/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Delete a key from the same settings page to revoke it. Update applications that

A read-only key cannot change workspace resources or run, resume, or cancel workflows. Reads can still cost credits: searches use embedding credits, and search chat uses model credits and keeps a private conversation history. Selector lookups call third-party services with your connected accounts.

A refused request fails with `403` and the message `This API key is read-only and cannot perform this operation`. Where the surface carries a code, it is `READ_ONLY_API_KEY`: in `error.details.code` on the v2 API and the Sim MCP server, in `details.code` on the v1 API and workflow execution, and in `error.data.code` on a workflow MCP server.
A refused request fails with `403` and the message `This API key is read-only and cannot perform this operation. Use a full-access API key.` Where the surface carries a code, it is `READ_ONLY_API_KEY`: in `error.details.code` on the v2 API and the Sim MCP server, in `details.code` on the v1 API and workflow execution, and in `error.data.code` on a workflow MCP server.

Access narrows a key; it never grants more than the key's identity already has. Access is fixed at creation, so create a new key to change it. Keys created before access levels existed have full access. Keys created from the deploy modal or for a workflow MCP server always have full access, because they exist to run workflows.

Expand Down
9 changes: 6 additions & 3 deletions apps/docs/content/docs/api-reference/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -174,11 +174,14 @@ Rejected v2 requests use HTTP error status codes and a stable code/message envel
{
"error": {
"code": "NOT_FOUND",
"message": "Workflow not found"
"message": "Workflow not found",
"traceId": "3f9a1c7e"
}
}
```

Every response carries an `x-request-id` header, and an error repeats it as `error.traceId`. Include it when you contact support about a failed request.

| Status | Meaning | Action |
| --- | --- | --- |
| `400` | Invalid request | Check the published schema and `error.details`, when present |
Expand All @@ -195,13 +198,13 @@ Other statuses and endpoint-specific recovery are documented in each reference.

V2 validates path parameters, query strings, and bodies against the published schema. Unknown fields return `400`; for example, `?limt=20` is an error. The rule also applies to endpoints with no query parameters: omit tracking tags, cache busters, and other undeclared fields.

A validation error can look like:
The message names the first rejected field, prefixed with where it was sent (`path`, `query`, `header`, or `body`); `error.details` lists every issue. A validation error can look like:

```json
{
"error": {
"code": "BAD_REQUEST",
"message": "Invalid request",
"message": "query: Unrecognized key: \"limt\"",
"details": [
{ "code": "unrecognized_keys", "keys": ["limt"], "path": [], "message": "Unrecognized key: \"limt\"" }
]
Expand Down
1 change: 1 addition & 0 deletions apps/docs/content/docs/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ See [output formats](/cli/output) for the JSON default and display formats.
| [`sim organizations`](/cli/organizations) | Manage organization membership, invitations, usage, access requests, and SSO. |
| [`sim permission-groups`](/cli/permission-groups) | Manage organization permission groups, their configuration, and member assignments. |
| [`sim sandboxes`](/cli/sandboxes) | Manage reusable dependency sets for Function blocks. |
| [`sim schedules`](/cli/schedules) | List the schedules deployed workflows run across a workspace. |
| [`sim secrets`](/cli/secrets) | Set and manage workspace or personal secrets. |
| [`sim selectors`](/cli/selectors) | Discover destination options for registered fields, such as calendars, channels, and tables. |
| [`sim skills`](/cli/skills) | Create reusable agent instructions and manage their editors. |
Expand Down
1 change: 1 addition & 0 deletions apps/docs/content/docs/cli/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
"organizations",
"permission-groups",
"sandboxes",
"schedules",
"secrets",
"selectors",
"skills",
Expand Down
51 changes: 51 additions & 0 deletions apps/docs/content/docs/cli/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5101,6 +5101,37 @@ sim sandboxes update <sandboxId> [options]

API request and response schemas: [updateSandbox](/api-reference/sandboxes/updateSandbox).

## sim schedules

List the schedules deployed workflows run across a workspace.

A schedule’s timing comes from its schedule block. Edit the block with `sim workflows operations apply`, then deploy; pause or resume one with `sim workflows triggers update`.

Also spelled `sim schedule`.

### sim schedules list

Show the timing and health of every schedule the workspace’s deployments run

```bash
sim schedules list [options]
```

**Options**

<CommandTable>

| Option | Required | Description |
| --- | --- | --- |
| `--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 "createdAt". Accepted values: `createdAt`. |
| `--sort-order <value>` | No | Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`. |

</CommandTable>

API request and response schemas: [listWorkspaceSchedules](/api-reference/workflows/listWorkspaceSchedules).

## sim secrets

Set and manage workspace or personal secrets.
Expand Down Expand Up @@ -8166,6 +8197,26 @@ sim workflows deployment update <workflowId> [options]

API request and response schemas: [updateWorkflowPublicApi](/api-reference/workflows/updateWorkflowPublicApi).

### sim workflows outline

Show a workflow’s draft as a compact read-only outline

```bash
sim workflows outline <workflowId>
```

**Arguments**

<CommandTable>

| Argument | Required | Description |
| --- | --- | --- |
| `workflowId` | Yes | Unique workflow identifier. |

</CommandTable>

API request and response schemas: [getWorkflowOutline](/api-reference/workflows/getWorkflowOutline).

### sim workflows state get

Get workflow state
Expand Down
35 changes: 35 additions & 0 deletions apps/docs/content/docs/cli/schedules.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Schedules
description: List the schedules deployed workflows run across a workspace.
---

import { CommandTable } from '@/components/ui/command-table'

List the schedules deployed workflows run across a workspace.

A schedule’s timing comes from its schedule block. Edit the block with `sim workflows operations apply`, then deploy; pause or resume one with `sim workflows triggers update`.

`sim schedules` is also spelled `sim schedule`.

These commands accept the [global options](/cli/commands#global-options).

## Show the timing and health of every schedule the workspace’s deployments run

```bash
sim schedules list [options]
```

**Options**

<CommandTable>

| Option | Required | Description |
| --- | --- | --- |
| `--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 "createdAt". Accepted values: `createdAt`. |
| `--sort-order <value>` | No | Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`. |

</CommandTable>

API request and response schemas: [listWorkspaceSchedules](/api-reference/workflows/listWorkspaceSchedules).
18 changes: 18 additions & 0 deletions apps/docs/content/docs/cli/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,24 @@ sim workflows state replace <workflowId> [options]

API request and response schemas: [replaceWorkflowState](/api-reference/workflows/replaceWorkflowState).

### Show a workflow’s draft as a compact read-only outline

```bash
sim workflows outline <workflowId>
```

**Arguments**

<CommandTable>

| Argument | Required | Description |
| --- | --- | --- |
| `workflowId` | Yes | Unique workflow identifier. |

</CommandTable>

API request and response schemas: [getWorkflowOutline](/api-reference/workflows/getWorkflowOutline).

### Edit a workflow’s blocks, connections and settings with a batch of operations

OAuth login or personal API key required.
Expand Down
4 changes: 4 additions & 0 deletions apps/docs/openapi-v2-billing.json
Original file line number Diff line number Diff line change
Expand Up @@ -596,6 +596,10 @@
"description": "Other structured context defined by the specific error."
}
]
},
"traceId": {
"description": "Identifier of this request, the same value as the `x-request-id` response header. Include it when contacting support.",
"type": "string"
}
},
"required": ["code", "message"],
Expand Down
4 changes: 4 additions & 0 deletions apps/docs/openapi-v2-files-audit.json
Original file line number Diff line number Diff line change
Expand Up @@ -4743,6 +4743,10 @@
"description": "Other structured context defined by the specific error."
}
]
},
"traceId": {
"description": "Identifier of this request, the same value as the `x-request-id` response header. Include it when contacting support.",
"type": "string"
}
},
"required": ["code", "message"],
Expand Down
4 changes: 4 additions & 0 deletions apps/docs/openapi-v2-knowledge.json
Original file line number Diff line number Diff line change
Expand Up @@ -6048,6 +6048,10 @@
"description": "Other structured context defined by the specific error."
}
]
},
"traceId": {
"description": "Identifier of this request, the same value as the `x-request-id` response header. Include it when contacting support.",
"type": "string"
}
},
"required": ["code", "message"],
Expand Down
4 changes: 4 additions & 0 deletions apps/docs/openapi-v2-logs.json
Original file line number Diff line number Diff line change
Expand Up @@ -1095,6 +1095,10 @@
"description": "Other structured context defined by the specific error."
}
]
},
"traceId": {
"description": "Identifier of this request, the same value as the `x-request-id` response header. Include it when contacting support.",
"type": "string"
}
},
"required": ["code", "message"],
Expand Down
11 changes: 10 additions & 1 deletion apps/docs/openapi-v2-resources.json
Original file line number Diff line number Diff line change
Expand Up @@ -14957,6 +14957,10 @@
"description": "Other structured context defined by the specific error."
}
]
},
"traceId": {
"description": "Identifier of this request, the same value as the `x-request-id` response header. Include it when contacting support.",
"type": "string"
}
},
"required": ["code", "message"],
Expand Down Expand Up @@ -20031,7 +20035,12 @@
},
"type": {
"type": "string",
"description": "Editor control the field renders as, e.g. `short-input`."
"description": "Editor control the field renders as, e.g. `short-input`. Not a value type; see `valueType`."
},
"valueType": {
"description": "Type of value the field holds, from the block’s declared input for the field (the same type `inputDefinitions` and operation `inputs` report). Absent when the block declares no input for the field.",
"type": "string",
"enum": ["string", "number", "boolean", "json", "array", "file"]
},
"title": {
"description": "Human-readable label.",
Expand Down
4 changes: 4 additions & 0 deletions apps/docs/openapi-v2-tables.json
Original file line number Diff line number Diff line change
Expand Up @@ -6007,6 +6007,10 @@
"description": "Other structured context defined by the specific error."
}
]
},
"traceId": {
"description": "Identifier of this request, the same value as the `x-request-id` response header. Include it when contacting support.",
"type": "string"
}
},
"required": ["code", "message"],
Expand Down
Loading
Loading