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
108 changes: 0 additions & 108 deletions .github/workflows/publish-python-sdk.yml

This file was deleted.

141 changes: 0 additions & 141 deletions .github/workflows/publish-ts-sdk.yml

This file was deleted.

2 changes: 0 additions & 2 deletions apps/docs/COPY_AUDIT.md
Original file line number Diff line number Diff line change
Expand Up @@ -637,8 +637,6 @@ Every row below represents a fully reviewed inventory entry. “Rewritten” inc
| --- | --- | --- | --- |
| [api-reference/authentication.mdx](content/docs/api-reference/authentication.mdx) | rewritten | Separated credential identity/current access from workspace-key management and operation policies; retained workspace payer/member attribution and personal/OAuth restrictions. Retained verified one-time key display/create/revoke instructions and exact Sim API keys label; qualified encryption and modern/legacy prefixes by API_ENCRYPTION_KEY. Kept API-key versus OAuth headers, scope table, method-independent scopes, account grant versus login revocation and API-key logout caveat. Replaced duplicate three-language request with curl and canonical Getting started/SDK links; folded repeated credential-safety text. | Verified improvement. Distinguishes acting identity, current role/policy, operation-specific workspace-key access, and payer instead of the baseline vague permissions table. Corrects API-key Bearer misuse, optional encryption/legacy prefix, OAuth scope/grant and logout behavior; removes duplicate HTTP language samples while linking complete versions. Preserved: Retains key creation/revocation/one-time display, X-API-Key, server-side credentials, modern prefix and OAuth scopes. Complete HTTP examples still exist in Getting started; OAuth/profile detail remains in CLI authentication. |
| [api-reference/getting-started.mdx](content/docs/api-reference/getting-started.mdx) | rewritten | Separated Cloud/self-host origins, active deployment prerequisites, manual draft access, HTTP result versus in-band run failures, and request versus execution rate policies. Added checked env-backed direct requests, all current wait/terminal/pause states, async mode compatibility and client/server timeout distinction. Preserved one-shot X-Run-Id409 behavior and uncertain-run reconciliation; fixed pagination with required workspaceId and URL-encoded returned cursor. Preserved resource/list/error shapes, strict undeclared-field behavior and validation details while distinguishing OAuth401, usage402, conflict409 and USD/credits. Kept substantial first-call Steps/language Tabs; removed routine status/billing callouts. API navigation moves advanced workflow-sync after SDKs under API guides. Used shared authored tabs with padded mixed content, wrapped prose, visible horizontal scrolling, and mobile touch targets. | Verified improvement. Examples now define environment prerequisites and handle HTTP and in-band run failures; manual draft execution is distinguished from the active deployment. Explains actual status/pause/redaction, async option compatibility, one-shot run-ID recovery, endpoint-specific units, and bound cursor queries. Preserved: Retains origin/OpenAPI URL, API-key creation, ID lookup, deployment, three HTTP languages, async run/status URL, envelopes, strict unknown-field validation, pagination and Retry-After. |
| [api-reference/python.mdx](content/docs/api-reference/python.mdx) | rewritten | Retained every public method signature/default and complete return-field reference, added forced-sync method and missing retry timeout parameter. Replaced repeated Quick Start/Basic/Steps/env tabs with env-backed context manager; retained sequential multiple-workflow, file-like upload, async polling, retry/status/usage examples. Explained Python failed result versus exception, completed/paused/cancelled states, metadata units and unset logs/traces; preserved 0.2.x migration and mixed legacy/v2 helpers. Fixed usage requestsPerMinute/maxBurst fields and account/key-owner USD scope; Python storage omission explicit; corrected v2 reset milliseconds with legacy-unit caveat. Replaced broken SDK streaming example and done-event parser with raw HTTP SSE inspection and canonical framing/forwarding instructions; preserved Flask backend authentication, event preservation, status/timeout/cleanup concerns. Added redacting to polling and local wait deadline, distinguished client/server timeouts, output selectors, run fields/files/permissions and opaque large-value references. | Verified improvement. Replaces the misleading async/streaming/readiness claims with blocking HTTP, SDK-vs-HTTP streaming limits and failed/paused/cancelled result behavior. Keeps full method and return reference while consolidating repeated examples; corrects retry/reset units and usage shape. Preserved: Retains Python/requests requirements, context management/close, method options/defaults, types, baseURL, file inputs, async polling, retry, usage helpers and Apache-2.0 link. Legacy status/jobs and SDK migration remain explicit; runnable examples replace duplicate/incorrect samples. |
| [api-reference/typescript.mdx](content/docs/api-reference/typescript.mdx) | rewritten | Retained all public method signatures/options and complete declared/runtime return fields, added forced-sync convenience and LargeValueRef/legacyJob status distinctions. Used Bun install and Node18+ ESM requirement, scoped automatic globalFile conversion to Node20+, fixed Buffer-to-BlobPart typing using Uint8Array. Explained failed-run rejection versus cancelled/paused resolution and exact-state run lookup; async polling waits through runtime redacting without widening SDK types. Fixed legacy USD usage fields/storage, v2 reset-millisecond example, client wait versus server cap, rate-only retries and unsafe-retry recovery. Replaced broken SDK streaming and stale done-frame example with raw HTTP stream, terminal/reset handling, chunk boundaries and canonical protocol client links. Folded duplicate initialization/Steps/environment tabs into one setup, preserved backend helper and Express/Next.js POST/auth/input-size/status responsibilities; retained file formats and actual upload example. | Verified improvement. Corrects Node minimum/global File availability, failed-run rejection, paused success, absent synchronous status, unsupported SDK streaming, and timeout-without-abort. Preserves complete declarations and options while reducing repeated implementations; corrects retries/usage/reset units and shows HTTP framing. Preserved: Retains constructor and methods, options/defaults, types, setter/helpers, file and URL objects, server/backend authorization, async polling, retry, usage, legacy compatibility and license link. |
| [api-reference/workflow-sync.mdx](content/docs/api-reference/workflow-sync.mdx) | rewritten | Reorganized prerequisites/import/fork/sync/verification/recovery and moved advanced navigation; retained every command/endpoint relationship and scope/role distinction. Made billing-enabled Enterprise versus billing-disabled deployment gate explicit; qualified export sanitization and kept unresolved env values/provenance non-authority. Retained source kind mappings, flat occurrence bindings/encodings/positions, null/required binding rules, dependentValues and selector scope/context/partial/restart bounds. Preserved fork drafts/explicit copies, push/pull direction/direct edge, mapping read/write projection, omitted/replaced/cleared saved choices and trigger URL adoption. Preserved request-ID/fingerprint apply commands, atomic import/idMap/plain-import exception, receipt workspace ownership, committed-follow-up failure and exact deployment readiness. Kept uncertainty reconciliation/stale preview recovery, rollback draft/copy limitations, unlink/exclusions; moved contributor harness details to existing canonical repository README link. | Verified improvement. Puts permissions and deployment gates before mutation steps; separates export/import, fork, direction-relative sync, receipt/recovery, and rollback consequences. Corrects confidentiality guarantees and adds selector bounds, fingerprint/retry safeguards, copy identity differences and exact deployment readiness. Preserved: Retains CLI↔HTTP map, all import/sync payload shapes, source IDs, nested occurrences/encodings, destination selectors, trigger adoption, request IDs, receipts and retry recovery. Contributor harness detail moved to a linked canonical README that contains Bun/Docker/PostgreSQL17/fixtures/migration boundary. |

### Knowledgebase (7)
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/app/llms.txt/route.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Sim is the open-source AI workspace where teams build, deploy, and manage AI age
- Run a deployed workflow: \`POST ${SIM_SITE_URL}/api/v2/workflows/{workflowId}/execute\` with a JSON body like \`{ "input": { "fieldName": "value" } }\`.
- Authenticate API keys with the \`X-API-Key\` header. \`Authorization: Bearer\` accepts only Sim OAuth access tokens, never API keys.
- 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\`.
- SDKs: \`simstudio-ts-sdk\` (npm) and \`simstudio-sdk\` (PyPI). Full reference: [API getting started](${baseUrl}/api-reference/getting-started).
- Full reference: [API getting started](${baseUrl}/api-reference/getting-started).
## Documentation Overview
Expand Down
Loading
Loading