You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 75663c8
Browse filesBrowse the repository at this point in the historyBrowse files
fix(docs): return 404 for unknown docs paths and derive integration counts from the catalog (#9003)
* fix(docs): return 404 for unknown docs paths and derive integration counts from the catalog
- Pass the bundled OpenAPI specs to fumadocs in memory instead of by file path; serverless functions don't ship the spec files, so every non-prerendered docs route failed with a 500
- Set dynamicParams = false on the docs page and llms.mdx route so unknown paths are a static 404
- Generate catalog totals and derive every public integration claim from them in one unit (integrations, actions, triggers) instead of the hardcoded "1,000+" and stale comparison counts
- Add a "Calling the Sim API" section to the docs llms.txt and clarify X-API-Key vs Bearer in the API docs
- Redirect /triggers/api to the API deployment page
* fix(seo): keep JSON-LD integration claims to the count the pages show
constDOCS_DESCRIPTION=`Documentation for Sim — the open-source AI workspace where teams build, deploy, and manage AI agents. Connect ${INTEGRATION_REACH} and every major LLM.`
26
+
24
27
conststructuredData={
25
28
'@context': 'https://schema.org',
26
29
'@type': 'WebSite',
27
30
name: 'Sim Documentation',
28
-
description:
29
-
'Documentation for Sim — the open-source AI workspace where teams build, deploy, and manage AI agents. Connect 1,000+ integrations and every major LLM.',
31
+
description: DOCS_DESCRIPTION,
30
32
url: DOCS_BASE_URL,
31
33
publisher: {
32
34
'@type': 'Organization',
@@ -118,8 +120,7 @@ export const metadata = {
118
120
default: 'Sim Documentation — The AI Workspace for Teams',
119
121
template: '%s | Sim Docs',
120
122
},
121
-
description:
122
-
'Documentation for Sim — the open-source AI workspace where teams build, deploy, and manage AI agents. Connect 1,000+ integrations and every major LLM.',
123
+
description: DOCS_DESCRIPTION,
123
124
applicationName: 'Sim Docs',
124
125
generator: 'Next.js',
125
126
referrer: 'origin-when-cross-origin'asconst,
@@ -165,8 +166,7 @@ export const metadata = {
165
166
url: DOCS_BASE_URL,
166
167
siteName: 'Sim Documentation',
167
168
title: 'Sim Documentation — The AI Workspace for Teams',
168
-
description:
169
-
'Documentation for Sim — the open-source AI workspace where teams build, deploy, and manage AI agents. Connect 1,000+ integrations and every major LLM.',
title: 'Sim Documentation — The AI Workspace for Teams',
182
-
description:
183
-
'Documentation for Sim — the open-source AI workspace where teams build, deploy, and manage AI agents. Connect 1,000+ integrations and every major LLM.',
> The open-source AI workspace where teams build, deploy, and manage AI agents.
34
35
35
-
Sim is the open-source AI workspace where teams build, deploy, and manage AI agents. Connect 1,000+ integrations and every major LLM to create agents that automate real work — visually, conversationally, or with code. Trusted by over 100,000 builders.
36
+
Sim is the open-source AI workspace where teams build, deploy, and manage AI agents. Connect ${INTEGRATION_REACH} and every major LLM to create agents that automate real work — visually, conversationally, or with code. Trusted by over 100,000 builders.
37
+
38
+
## Calling the Sim API
39
+
40
+
- Base URL: \`${SIM_SITE_URL}\`. Every endpoint is under \`/api\`; there is no \`api.sim.ai\` host.
41
+
- Run a deployed workflow: \`POST ${SIM_SITE_URL}/api/v2/workflows/{workflowId}/execute\` with a JSON body like \`{ "input": { "fieldName": "value" } }\`.
42
+
- Authenticate API keys with the \`X-API-Key\` header. \`Authorization: Bearer\` accepts only Sim OAuth access tokens, never API keys.
43
+
- Responses wrap the payload in \`data\`. A synchronous run returns \`200 { "data": { "runId", "status", "output", ... } }\`; with \`"async": true\` in the body it returns \`202 { "data": { "runId", "statusUrl" } }\` and you poll \`statusUrl\`.
44
+
- SDKs: \`simstudio-ts-sdk\` (npm) and \`simstudio-sdk\` (PyPI). Full reference: [API getting started](${baseUrl}/api-reference/getting-started).
@@ -74,8 +75,7 @@ export function StructuredData({
74
75
applicationCategory: 'BusinessApplication',
75
76
applicationSubCategory: 'AI Workspace',
76
77
operatingSystem: 'Any',
77
-
description:
78
-
'Sim is the open-source AI workspace where teams build, deploy, and manage AI agents. Connect 1,000+ integrations and every major LLM to create agents that automate real work.',
78
+
description: `Sim is the open-source AI workspace where teams build, deploy, and manage AI agents. Connect ${INTEGRATION_COUNT_LABEL} integrations and every major LLM to create agents that automate real work.`,
79
79
url: baseUrl,
80
80
author: {
81
81
'@type': 'Organization',
@@ -89,7 +89,7 @@ export function StructuredData({
Copy file name to clipboardExpand all lines: apps/docs/content/docs/api-reference/authentication.mdx
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ administrators can create shared keys from **Workspace settings** → **Sim API
38
38
39
39
## Using API Keys
40
40
41
-
Pass your API key in the `X-API-Key` header with every request:
41
+
Pass your API key in the `X-API-Key` header with every request. An API key is never accepted as `Authorization: Bearer`; that header is only for [OAuth access tokens](#oauth-access-tokens).
42
42
43
43
<Tabsitems={['curl', 'TypeScript', 'Python']}>
44
44
<Tabvalue="curl">
@@ -66,6 +66,8 @@ Pass your API key in the `X-API-Key` header with every request:
Copy file name to clipboardExpand all lines: apps/docs/content/docs/api-reference/getting-started.mdx
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,8 @@ All API requests are made to:
15
15
https://www.sim.ai
16
16
```
17
17
18
+
Every endpoint lives under `/api` on this origin, for example `https://www.sim.ai/api/v2/workflows/{workflowId}/execute`. There is no `api.sim.ai` host.
19
+
18
20
## OpenAPI specification
19
21
20
22
Download the [complete OpenAPI 3.1 specification](/openapi.json) as JSON for client generation, request validation, and API tooling.
0 commit comments