Skip to content

docs: align with subconscious 0.1.10 / subconscious-sdk 0.1.6 SDKs#30

Open
AjayaRamachandran wants to merge 2 commits into
mainfrom
coop-sdk-fixes
Open

docs: align with subconscious 0.1.10 / subconscious-sdk 0.1.6 SDKs#30
AjayaRamachandran wants to merge 2 commits into
mainfrom
coop-sdk-fixes

Conversation

@AjayaRamachandran
Copy link
Copy Markdown
Contributor

Brings the public docs in line with the new SDK shape that landed in subconscious 0.1.10 (Node) and subconscious-sdk 0.1.6 (Python):

  • run / runAndWait split: examples now call client.runAndWait() and client.run_and_wait() directly instead of the deprecated client.run({ ..., options: { awaitCompletion: true } }) form
  • Tool builders: examples use tools.platform("..."), tools.function({...}), tools.mcp({...}), tools.resource("...") instead of hand-rolled discriminated-union literals
  • Structured output: Pydantic / Zod classes are now passed directly as answerFormat; result.answer is the decoded structured value (not a JSON string), narrowable via the generic on runAndWait
  • Stream Events v2: streaming.mdx documents the full event taxonomy (started, delta, reasoning_node, tool_call, result, error, done) and the canonical SSE wire format using event: started {runId} (camelCase). Notes that legacy run_id snake_case still parses for back-compat
  • Error codes: error-handling.mdx now lists the canonical ErrorCode enum, including canceled (one l, matching RunStatus). Calls out the cancelled -> canceled rename
  • Libraries page: dropped the misleading "v1.0 is out" banner; documents the back-compat behavior of options.awaitCompletion (still works, prints one-shot deprecation warning); SDK methods table now includes runAndWait, observe, and notes the camelCase / snake_case spellings
  • Webhooks via per-run callbackUrl: switched to a cURL example since the SDK doesn't currently pass output.* through to the REST surface
  • Response-handling: replaced bogus parsedAnswer / parsed_answer field references (they don't exist in either SDK) with the real shape: result.answer is the typed value when answerFormat is set
  • openapi.json: updated RunOptions description to reflect the deprecated client-side awaitCompletion behavior

No semantic API or wire-format changes — all docs-only updates.

AjayaRamachandran and others added 2 commits May 1, 2026 16:39
Brings the public docs in line with the new SDK shape that landed in
subconscious 0.1.10 (Node) and subconscious-sdk 0.1.6 (Python):

  - run / runAndWait split: examples now call client.runAndWait() and
    client.run_and_wait() directly instead of the deprecated
    client.run({ ..., options: { awaitCompletion: true } }) form
  - Tool builders: examples use tools.platform("..."), tools.function({...}),
    tools.mcp({...}), tools.resource("...") instead of hand-rolled
    discriminated-union literals
  - Structured output: Pydantic / Zod classes are now passed directly as
    answerFormat; result.answer is the decoded structured value (not a
    JSON string), narrowable via the generic on runAndWait<T>
  - Stream Events v2: streaming.mdx documents the full event taxonomy
    (started, delta, reasoning_node, tool_call, result, error, done) and
    the canonical SSE wire format using event: started {runId}
    (camelCase). Notes that legacy run_id snake_case still parses for
    back-compat
  - Error codes: error-handling.mdx now lists the canonical ErrorCode
    enum, including canceled (one l, matching RunStatus). Calls out the
    cancelled -> canceled rename
  - Libraries page: dropped the misleading "v1.0 is out" banner;
    documents the back-compat behavior of options.awaitCompletion (still
    works, prints one-shot deprecation warning); SDK methods table now
    includes runAndWait, observe, and notes the camelCase / snake_case
    spellings
  - Webhooks via per-run callbackUrl: switched to a cURL example since
    the SDK doesn't currently pass output.* through to the REST surface
  - Response-handling: replaced bogus parsedAnswer / parsed_answer field
    references (they don't exist in either SDK) with the real shape:
    result.answer is the typed value when answerFormat is set
  - openapi.json: updated RunOptions description to reflect the
    deprecated client-side awaitCompletion behavior

No semantic API or wire-format changes — all docs-only updates.

Co-authored-by: Cursor <cursoragent@cursor.com>
Document resource tools in input.tools and remove stale function-tool method/timeout fields so examples match the co-op SDK updates.

Co-authored-by: Cursor <cursoragent@cursor.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant