Skip to main content
POST
Execute one provider-backed tool
Authentication: workspace API key in Authorization: Bearer <key>. The request example uses toolId=free_simple_company_search. Replace both the tool ID and payload for another action. Read its tool contract first. URL-encode path values, including / characters inside Play references and run IDs.

Errors

Authorizations

Authorization
string
header
required

Create a workspace API key in the Deepline dashboard before calling authenticated endpoints.

Headers

Idempotency-Key
string

Optional caller-owned execution key. Case-sensitive, 1–200 ASCII letters, digits, period, underscore, colon, or hyphen. Persist before dispatch. Changed input conflicts; expired keys cannot be reused.

Required string length: 1 - 200
Pattern: ^[A-Za-z0-9._:-]+$

Path Parameters

toolId
string
required

The toolId returned by the related Deepline API call.

Minimum string length: 1

Body

application/json

Input matching the selected tool input schema.

payload
object
required

Input matching the selected tool input schema.

Response

A successful Runtime API response.

status
string
required
toolResponse
object
required
job_id
string

Execution request identity for billing and diagnostics.

meta
object
extractedLists
object
extractedValues
object
billing
object