Deepline
Static entry point for the Deepline SDK.
Signature: class Deepline
Members
| Member | Kind | Purpose | Parameters | Returns / type |
|---|---|---|---|---|
connect | method | Create a connected SDK context. Resolves configuration from options, environment variables, and CLI config files. See resolveConfig for the resolution order. | options?: DeeplineClientOptions - Optional overrides for API key, base URL, etc. | Promise<DeeplineContext> |
DeeplineContext
SDK context with tool shortcuts and play handles, created by Deepline.connect. Wraps a DeeplineClient for common operations.
Signature: class DeeplineContext
Members
| Member | Kind | Purpose | Parameters | Returns / type |
|---|---|---|---|---|
constructor | constructor | Create a high-level SDK context. Most callers should use Deepline.connect. direct construction isequivalent when you already have explicit client options. | options?: DeeplineClientOptions - Optional SDK client configuration. | |
billing | getter | Read current billing usage and exact per-request Deepline charges. | BillingNamespace | |
tools | getter | Tool operations namespace. | DeeplineToolsNamespace | |
executions | getter | Durable state for recoverable direct tool executions. | DeeplineExecutionsNamespace | |
plays | getter | Play discovery and named-play handles. Use plays.list() for discovery and plays.get(name) when you prefer anamespace spelling over play(name). | DeeplinePlaysNamespace | |
prebuilt | getter | Convenience references for Deepline-managed prebuilt plays. Known prebuilts are exposed by camel-cased aliases. Any other property is converted into prebuilt/<property> so callers can pass the reference todeepline.runPlay(...) inside a play. | Record<string, PrebuiltPlayRef> | |
play | method | Get a named play handle for remote lifecycle operations. | name: string - Play name (as registered on the server) | DeeplineNamedPlay<TInput, TOutput> |
runPlay | method | Run a named or prebuilt play and wait for its output. This is the high-level SDK equivalent of client.play(name).runSync(input).Inside a play, use deepline.runPlay(key, playRef, input, options).The runtime checkpoints the child run under a stable key. | playOrRef: string | PlayReferenceLike - Play name or prebuilt/reference object.input: TInput - JSON input passed to the play. | Promise<TOutput> |