Call Plays

Use the caller that already owns the work. A run started from outside Deepline returns a durable run ID; persist it if the caller needs to resume observation.

CLI

Use a local file while you are authoring it. Check it first, then run it.

deepline plays check ./enrich-company.play.ts --json
deepline plays run ./enrich-company.play.ts \
  --input '{"domain":"stripe.com"}'

Use a named reference for a saved or Prebuilt Play:

deepline plays run prebuilt/person-linkedin-to-email \
  --input '{"linkedin_url":"https://www.linkedin.com/in/real-person/"}'

TypeScript service or script

import { Deepline } from 'deepline';

declare const runs: {
  insert(input: { runId: string; status: 'running' }): Promise<void>;
};

const deepline = await Deepline.connect();
const job = await deepline.play('prebuilt/person-linkedin-to-email').run({
  linkedin_url: 'https://www.linkedin.com/in/real-person/',
});

await runs.insert({ runId: job.id, status: 'running' });
const result = await job.get();

Persist job.id before you wait. A local timeout does not cancel the remote run; Production Play integration explains how to resume the same run and write its result once.

Inside another Play

Use ctx.runPlay(...) for a statically resolvable scalar child Play. Use ctx.tools.execute(...) only for one provider-backed operation.

import { definePlay } from 'deepline';

type Input = {
  linkedin_url: string;
};

export default definePlay(
  'resolve-lead-email',
  async (ctx, input: Input) => {
    const email = await ctx.runPlay(
      'person_email',
      'prebuilt/person-linkedin-to-email',
      { linkedin_url: input.linkedin_url },
      { description: "Resolve this lead's work email." },
    );

    return { email };
  },
  {
    description: 'Resolve one lead email through a scalar Prebuilt Play.',
  },
);

See Prebuilt Plays for the child-play boundary.

Raw HTTP

Use HTTP for a non-TypeScript service, a notebook, or a scheduler that invokes an already-saved or Prebuilt Play:

curl -fsS -X POST "$DEEPLINE_HOST_URL/api/v2/plays/run" \
  -H "Authorization: Bearer $DEEPLINE_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"name":"prebuilt/person-linkedin-to-email","input":{"linkedin_url":"https://www.linkedin.com/in/real-person/"}}'

For raw HTTP, the response’s run.id is the run ID. The TypeScript SDK normalizes that value to job.id (and its lower-level workflowId field). HTTP and Python owns the polling example; Runtime API reference owns the generated endpoint contract.

Get started

Build and automate

Common workflows

Data and integrations

Reference

CLI

TypeScript service or script

Inside another Play

Raw HTTP

​CLI

​TypeScript service or script

​Inside another Play

​Raw HTTP

CLI

TypeScript service or script

Inside another Play

Raw HTTP