API reference

Base URL: https://code.deepline.com Use this API from a trusted backend service, serverless function, notebook, or scheduler. For local Play files, use the CLI or SDK so Deepline can bundle and validate the source first. This page owns the shared HTTP contract. Each provider guide owns its connection, verified tool IDs, payload requirements, approval rules, and side effects.

Authentication and security

Send a workspace API key with every request:

Authorization: Bearer <DEEPLINE_API_KEY>

Keep the key in a server-side secret store or environment variable. Do not send it to a browser, commit it to source control, or put it in a client-side mobile application. Direct API calls use bearer authentication; they do not require a separate request-signing scheme.

Inspect a tool before you execute it

Tool IDs, input schemas, and Deepline pricing are live contracts. Search for a tool, read GET /api/v2/integrations/{toolId}/get, then confirm the provider guide’s approval and side-effect notes. Do not guess a payload from an old blog post or retry an ambiguous provider mutation blindly.

Inspect a public tool contract

Read a tool’s schema before you execute it. This is a metadata request: it does not execute the tool or create a charge.

curl --request GET \
  "https://code.deepline.com/api/v2/integrations/free_simple_company_search/get" \
  -H "Authorization: Bearer $DEEPLINE_API_KEY"

free_simple_company_search is a public, discoverable tool. Its returned inputSchema describes the required sql field. When you deliberately execute that tool, use the path-routed endpoint and this request envelope:

POST /api/v2/integrations/free_simple_company_search/execute
Content-Type: application/json

{
  "payload": {
    "sql": "SELECT company_name, normalized_domain FROM companies WHERE normalized_domain = 'openai.com' LIMIT 1"
  }
}

POST /api/v2/integrations/execute is not supported for new callers. For any other tool, first inspect GET /api/v2/integrations/{toolId}/get, then use POST /api/v2/integrations/{toolId}/execute with its documented input schema.

Start a saved or prebuilt Play

Start an already saved Play with POST /api/v2/plays/run. Deepline-managed prebuilt Plays must use the prebuilt/ namespace.

curl --request POST "https://code.deepline.com/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/example-person/"
    }
  }'

This starts provider work and can use Deepline credits. The response is a play_run package. Read its public run ID from run.id:

{
  "schemaVersion": 1,
  "kind": "play_run",
  "run": {
    "id": "play/prebuilt/person-linkedin-to-email/run/20260829t123456-789-a1b2c3d4",
    "playName": "person-linkedin-to-email",
    "status": "running"
  }
}

Read Play-run status

URL-encode run.id, then request the canonical run endpoint:

GET /api/v2/runs/{URL-encoded run.id}?full=true

For example, if the encoded ID is in ENCODED_RUN_ID:

curl "https://code.deepline.com/api/v2/runs/$ENCODED_RUN_ID?full=true" \
  -H "Authorization: Bearer $DEEPLINE_API_KEY"

Read run.status from the response. completed, failed, and cancelled are terminal statuses. The full response includes the run package and outputs.

Environment variables

DEEPLINE_API_KEY: workspace-scoped bearer key.
Provider credentials: configure them only for the providers your workspace uses. Each provider guide documents its authentication requirement.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Authentication and security

Inspect a tool before you execute it

Inspect a public tool contract

Start a saved or prebuilt Play

Read Play-run status

Environment variables

​Authentication and security

​Inspect a tool before you execute it

​Inspect a public tool contract

​Start a saved or prebuilt Play

​Read Play-run status

​Environment variables

Authentication and security

Inspect a tool before you execute it

Inspect a public tool contract

Start a saved or prebuilt Play

Read Play-run status

Environment variables