Skip to content

Commit 98c8567

Browse files
icecrasher321icecrasher321
committed
improvement(external-endpoints): v2 versions with clean signatures + updated docs
1 parent 23ec96b commit 98c8567

69 files changed

Lines changed: 15754 additions & 145 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎apps/docs/content/docs/de/api-reference/getting-started.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ This returns immediately with a `jobId` and `statusUrl`:
121121
}
122122
```
123123

124-
Poll the [Get Job Status](/api-reference/workflows/getJobStatus) endpoint until the status is `completed` or `failed`:
124+
Poll the [Get Job Status](/api-reference/execution/getJobStatus) endpoint until the status is `completed` or `failed`:
125125

126126
```bash
127127
curl https://www.sim.ai/api/jobs/{jobId} \

‎apps/docs/content/docs/de/api-reference/meta.json‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"title": "API Reference",
33
"root": true,
44
"pages": [
5+
"---Getting Started---",
56
"getting-started",
67
"authentication",
78
"---SDKs---",
@@ -10,9 +11,13 @@
1011
"---Endpoints---",
1112
"(generated)/workflows",
1213
"(generated)/logs",
13-
"(generated)/usage",
1414
"(generated)/audit-logs",
1515
"(generated)/tables",
16-
"(generated)/files"
16+
"(generated)/files",
17+
"(generated)/knowledge-bases",
18+
"---Execution and Usage---",
19+
"(generated)/execution",
20+
"(generated)/human-in-the-loop",
21+
"(generated)/usage"
1722
]
1823
}

‎apps/docs/content/docs/en/api-reference/(generated)/execution/meta.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"pages": ["executeWorkflow", "getWorkflowExecution", "cancelExecution", "getJobStatus"]
3+
}

‎apps/docs/content/docs/en/api-reference/(generated)/workflows/meta.json‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
{
22
"pages": [
3-
"executeWorkflow",
4-
"getWorkflowExecution",
5-
"cancelExecution",
63
"listWorkflows",
74
"getWorkflow",
85
"deployWorkflow",
96
"undeployWorkflow",
10-
"rollbackWorkflow",
11-
"getJobStatus"
7+
"rollbackWorkflow"
128
]
139
}

‎apps/docs/content/docs/en/api-reference/getting-started.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ This returns immediately with a `jobId` and `statusUrl`:
121121
}
122122
```
123123

124-
Poll the [Get Job Status](/api-reference/workflows/getJobStatus) endpoint until the status is `completed` or `failed`:
124+
Poll the [Get Job Status](/api-reference/execution/getJobStatus) endpoint until the status is `completed` or `failed`:
125125

126126
```bash
127127
curl https://www.sim.ai/api/jobs/{jobId} \

‎apps/docs/content/docs/en/api-reference/meta.json‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,14 @@
1010
"typescript",
1111
"---Endpoints---",
1212
"(generated)/workflows",
13-
"(generated)/human-in-the-loop",
1413
"(generated)/logs",
15-
"(generated)/usage",
1614
"(generated)/audit-logs",
1715
"(generated)/tables",
1816
"(generated)/files",
19-
"(generated)/knowledge-bases"
17+
"(generated)/knowledge-bases",
18+
"---Execution and Usage---",
19+
"(generated)/execution",
20+
"(generated)/human-in-the-loop",
21+
"(generated)/usage"
2022
]
2123
}

‎apps/docs/content/docs/en/platform/enterprise/audit-logs.mdx‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Audit logs are also accessible through the Sim API for integration with external
3333

3434
```http
3535
GET /api/v1/audit-logs
36-
Authorization: Bearer <api-key>
36+
X-API-Key: <api-key>
3737
```
3838

3939
**Query parameters:**
@@ -71,11 +71,18 @@ Authorization: Bearer <api-key>
7171
"createdAt": "2026-04-20T21:16:00.000Z"
7272
}
7373
],
74-
"nextCursor": "eyJpZCI6ImFiYzEyMyJ9"
74+
"nextCursor": "eyJpZCI6ImFiYzEyMyJ9",
75+
"limits": {
76+
"workflowExecutionRateLimit": {
77+
"sync": { "requestsPerMinute": 60, "maxBurst": 10, "remaining": 59, "resetAt": "2026-04-20T21:17:00.000Z" },
78+
"async": { "requestsPerMinute": 30, "maxBurst": 5, "remaining": 30, "resetAt": "2026-04-20T21:17:00.000Z" }
79+
},
80+
"usage": { "currentPeriodCost": 1.25, "limit": 50, "plan": "enterprise", "isExceeded": false }
81+
}
7582
}
7683
```
7784

78-
Paginate by passing the `nextCursor` value as the `cursor` parameter in the next request. When `nextCursor` is absent, you have reached the last page.
85+
Paginate by passing the `nextCursor` value as the `cursor` parameter in the next request. When `nextCursor` is absent, you have reached the last page. Each entry also includes `actorName`; `metadata` is an arbitrary per-action JSON object. The `limits` object reports your current rate-limit and usage status.
7986

8087
The API accepts both personal and workspace-scoped API keys. Rate limits apply — the response includes `X-RateLimit-*` headers with your current limit and remaining quota.
8188

‎apps/docs/content/docs/es/api-reference/getting-started.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ This returns immediately with a `jobId` and `statusUrl`:
121121
}
122122
```
123123

124-
Poll the [Get Job Status](/api-reference/workflows/getJobStatus) endpoint until the status is `completed` or `failed`:
124+
Poll the [Get Job Status](/api-reference/execution/getJobStatus) endpoint until the status is `completed` or `failed`:
125125

126126
```bash
127127
curl https://www.sim.ai/api/jobs/{jobId} \

‎apps/docs/content/docs/es/api-reference/meta.json‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"title": "API Reference",
33
"root": true,
44
"pages": [
5+
"---Getting Started---",
56
"getting-started",
67
"authentication",
78
"---SDKs---",
@@ -10,7 +11,13 @@
1011
"---Endpoints---",
1112
"(generated)/workflows",
1213
"(generated)/logs",
13-
"(generated)/usage",
14-
"(generated)/audit-logs"
14+
"(generated)/audit-logs",
15+
"(generated)/tables",
16+
"(generated)/files",
17+
"(generated)/knowledge-bases",
18+
"---Execution and Usage---",
19+
"(generated)/execution",
20+
"(generated)/human-in-the-loop",
21+
"(generated)/usage"
1522
]
1623
}

‎apps/docs/content/docs/fr/api-reference/getting-started.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ This returns immediately with a `jobId` and `statusUrl`:
121121
}
122122
```
123123

124-
Poll the [Get Job Status](/api-reference/workflows/getJobStatus) endpoint until the status is `completed` or `failed`:
124+
Poll the [Get Job Status](/api-reference/execution/getJobStatus) endpoint until the status is `completed` or `failed`:
125125

126126
```bash
127127
curl https://www.sim.ai/api/jobs/{jobId} \

0 commit comments

Comments
 (0)