René's URL Explorer Experiment

Title: docs(playbooks): a notebook as a backend and orchestrator-triggered runs by jamesbhobbs · Pull Request #623 · deepnote/deepnote · GitHub

Open Graph Title: docs(playbooks): a notebook as a backend and orchestrator-triggered runs by jamesbhobbs · Pull Request #623 · deepnote/deepnote

X Title: docs(playbooks): a notebook as a backend and orchestrator-triggered runs by jamesbhobbs · Pull Request #623 · deepnote/deepnote

Description: Third of five independent playbook PRs: use-case pages that show how existing Deepnote features combine. Every behavioural claim was checked against the source of the currently deployed web app and its public API contracts. Nothing here is a code change, and nothing depends on the unmerged API guides in #620; these pages link only to deepnote-api and the generated API reference. Pages docs/playbook-notebook-as-a-backend.md: calling a notebook from another system. It covers designing inputs and a JSON output, the runs API, the app data endpoint, sessions for repeated calls, the machines API, security and rate limits. docs/playbook-orchestrator-triggered-runs.md: triggering notebooks from Airflow, Dagster, Prefect, dbt or CI. It includes a polling helper, keeping a fallback schedule as code, monitoring through run history, and security. Claims checked against the web app source POST /v2/runs fields: notebookId, inputs, detached (default true), detachedRunStorageMode, machineType (beta), and blockIds (live mode only). Run statuses: pending, running, success, error, internal_error, stopped. There's no endpoint to cancel a run. GET /v2/runs/{runId} supports snapshotDelivery=blocks and fullOutputs. GET /v2/notebooks/{id}/app-data returns the first application/json output and the agent block summary from the caller's own newest successful detached run. Sessions (beta) are creator-only; execute also needs Edit access. Stopping a session is DELETE /v2/sessions/{id}. Machines endpoints: GET and PATCH /v2/projects/{id}/machine, and POST .../start, .../stop and .../restart. Schedules: GET, POST and DELETE /v2/notebooks/{id}/schedule. Pause reasons are access-revoked and consecutive-failures. Schedules more frequent than hourly need Enterprise. GET /v2/notebooks/{id}/runs returns runs newest first. Runs execute as the API key's creator. A key stops working when its creator leaves the workspace or is suspended or deactivated. Private projects only accept the owner's key. A schedule runs as its owner. Losing access pauses it and sends emails, to admins as well unless the project is private. Saving the schedule transfers ownership and resumes it. Schedule notifications are Slack or email only. Rate limits per minute: read, write and execution are 600, 200 and 40 on Team, and 2000, 600 and 120 on Enterprise. {{ variable }} in SQL blocks is rendered into bound parameters by the toolkit's JinjaSQL. Not verified The Python helper and curl examples haven't been run against a real workspace. Rendering on the docs site, and the "Playbooks" sidebar section, which will come in a separate docs-navigation PR. 🤖 Generated with Claude Code Summary by CodeRabbit Documentation Added guidance on exposing notebook logic through the Deepnote API, covering inputs and outputs, run management, warm sessions, machine controls, security, rate limits, and plan requirements. Added instructions for triggering notebook runs from workflow and orchestration tools, including status monitoring, retries, timeouts, notifications, and schedule management. Added Dagster to the documentation dictionary.

Open Graph Description: Third of five independent playbook PRs: use-case pages that show how existing Deepnote features combine. Every behavioural claim was checked against the source of the currently deployed web app and...

X Description: Third of five independent playbook PRs: use-case pages that show how existing Deepnote features combine. Every behavioural claim was checked against the source of the currently deployed web app and...

Opengraph URL: https://github.com/deepnote/deepnote/pull/623

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width