Skip to main content
New to Corsair? See API access, authentication, and error handling.

Auth

status

auth.status Show the API key, user, workspace and rate-limit tier this plugin is using Risk: read
Input: empty object Output

Billing

autoRecharge.get

billing.autoRecharge.get Read the automatic credit recharge settings Risk: read
Input: empty object Output

autoRecharge.update

billing.autoRecharge.update Turn automatic recharge on or off or change its limits (lets Deepline charge the saved card automatically) Risk: destructive
Input Output

balance

billing.balance Get workspace credit balance Risk: read
Input Output: object

catalog

billing.catalog Read the published plan catalog, meters and the plan the workspace is on Risk: read
Input: empty object Output

creditPurchases.create

billing.creditPurchases.create Buy credits through a payment-gated purchase (spends money) Risk: destructive
Input Output

creditPurchases.recover

billing.creditPurchases.recover Check or retire an uncertain credit purchase by its original key (never charges) Risk: write
Input Output

entitlements

billing.entitlements Read current workspace provider benefits Risk: read
Input: Record<string, any> Output

includedCompute

billing.includedCompute Read Play compute pricing, included minutes and minutes used this period Risk: read
Input Output

invoices

billing.invoices List subscription invoices and credit purchase receipts, newest first Risk: read
Input Output

ledger

billing.ledger List or export the credit ledger Risk: read
Input Requires workspace admin access. Returns JSON pages, including has_more and next_cursor. Output

plans

billing.plans List plans that can be started or changed to, and check a promo code without redeeming it Risk: read
Input Output

planTransitions.create

billing.planTransitions.create Start, change, cancel or restore the billing plan (changes what the workspace pays) Risk: destructive
Input Output

portalSessions.create

billing.portalSessions.create Create a Stripe billing portal link for payment details and invoices (the link grants billing access) Risk: write
Input Output

quote

billing.quote Estimate the maximum credits for Play sandbox sessions (quote only, spends nothing) Risk: read
Input
Output

status

billing.status Read plan, payment, recharge and invoice state Risk: read
Input: empty object Output

subscription.cancel

billing.subscription.cancel Cancel the subscription at period end, or undo a pending cancellation (changes the subscription) Risk: destructive
Input Output

subscription.status

billing.subscription.status Read subscription state, renewal and cancellation facts, and remaining credit pools Risk: read
Input: empty object Output

topUp

billing.topUp Charge the saved payment method and add credits (spends money) Risk: destructive
Input Output: object

usage

billing.usage Get usage and recent charges Risk: read
Input Output

usageEvents

billing.usageEvents Page raw per-request usage events, or look up one by request_id (not a final charge) Risk: read
Input Output

Datasets

history

datasets.history Read immutable run row history with coverage and continuation cursor Risk: read
Input Follow nextCursor. Read coverage before concluding that history is complete. Output

rows

datasets.rows Read a page of saved dataset rows, optionally scoped to a run Risk: read
Input Pass runId to require rows from that run. Use the exact dataset namespace reported by the run and advance offset to retrieve further pages. Output

Db

query

db.query Run SQL on the workspace customer database; writes can change storage tables Risk: destructive
Input Output

Executions

getByKey

executions.getByKey Recover a tool execution by its idempotency key Risk: read
Input Reads an existing execution without launching another. Inspect responseStatus and executionRecovery.state before interpreting response as a success. Output

Health

get

health.get Check Runtime API availability Risk: read
Input: Record<string, any> Output

Integrations

balance

integrations.balance Read the live balance of the workspace’s own provider credential (LeadMagic) Risk: read
Input Output

integrations.connectLink Get the dashboard link where a workspace admin connects a provider Risk: read
Input Output

setCredentials

integrations.setCredentials Save provider credential fields for the workspace (replaces the stored credential; values never returned) Risk: destructive
Input Output

startOAuth

integrations.startOAuth Start provider OAuth and return the URL a person opens to grant access Risk: write
Input Output

Monitors

access

monitors.access Check whether the workspace can use Deepline Monitors Risk: read
Input: empty object Output

available

monitors.available List deployable monitor tools, or describe the payload, outputs and pricing of one tool Risk: read
Input Output: object

batch.get

monitors.batch.get Read a monitor batch operation, such as the plan from a dry-run start or stop Risk: read
Input Output

check

monitors.check Validate a monitor definition and show its plan and pricing without deploying or spending credits Risk: read
Input Output

delete

monitors.delete Delete a deployed monitor and deprovision its upstream resource; dryRun shows the plan Risk: destructive
Input Output

dependents

monitors.dependents List the published Plays that react to one monitor Risk: read
Input Output

deploy

monitors.deploy Deploy a monitor from a definition; creates an upstream provider resource and may spend credits Risk: destructive
Input Output

fleets.list

monitors.fleets.list List Monitor Fleets, or their overview with status counts Risk: read
Input Output

get

monitors.get Get one deployed monitor by its public key Risk: read
Input Output

health

monitors.health Read monitor delivery and convergence health Risk: read
Input Output

jobs.cancel

monitors.jobs.cancel Cancel a running Monitor Job Risk: destructive
Input Output

jobs.get

monitors.jobs.get Get the state, phase and counts of a Monitor Job Risk: read
Input Output

jobs.logs

monitors.jobs.logs Read the logs of a Monitor Job Risk: read
Input Output

ledger.findings

monitors.ledger.findings List the recent findings of one monitor Risk: read
Input Output: Record<string, any>

ledger.get

monitors.ledger.get Get the ledger entry of one monitor Risk: read
Input Output: Record<string, any>

ledger.list

monitors.ledger.list List monitors with status, findings counts, signals and the Plays each one triggers Risk: read
Input Output

list

monitors.list List deployed monitors by lifecycle state, with cursor paging Risk: read
Input Output

preview

monitors.preview Sample recent matches for a monitor definition before deploying; each returned match costs credits Risk: destructive
Input Output

reactivate

monitors.reactivate Reactivate a disabled monitor, creating a replacement upstream resource; dryRun shows the cost Risk: destructive
Input Output: Record<string, any>

start

monitors.start Apply the retained definition of a stopped monitor upstream; may spend credits Risk: destructive
Input Output: object

stop

monitors.stop Stop a monitor upstream while keeping its definition for monitors.start Risk: destructive
Input Output: object

test

monitors.test Validate an explicit event payload against the webhook contract of a deployed monitor; writes, charges and dispatches nothing Risk: read
Input Output

update

monitors.update Update the name or payload of a deployed monitor; payload changes can replace the upstream resource and spend credits Risk: destructive
Input Output

Notifications

channels

notifications.channels List Slack channels visible to the connected Deepline Slack app Risk: read
Input Output

configuration.change

notifications.configuration.change Save or delete one notification group atomically against the expected workspace version Risk: write
Input
Output

configuration.get

notifications.configuration.get Read notification groups, destinations, rules and the workspace version Risk: read
Input: empty object Output

create

notifications.create Create a named Slack notification for chosen Play events Risk: write
Input Output: Record<string, any>

delete

notifications.delete Archive a named notification without touching its Slack integration Risk: destructive
Input Output

dlq.get

notifications.dlq.get Get one dead-lettered notification delivery Risk: read
Input Output: Record<string, any>

dlq.list

notifications.dlq.list List notification deliveries that exhausted their retries Risk: read
Input Output

dlq.update

notifications.dlq.update Retry (send again) or archive one dead-lettered notification delivery Risk: destructive
Input Output: Record<string, any>

list

notifications.list List named notifications, the event catalog, destinations and dead-letter count Risk: read
Input: empty object Output

test

notifications.test Send a test message to the Slack target of a notification Risk: destructive
Input Output

update

notifications.update Pause or resume a notification, or change its name, events and Slack target Risk: write
Input Output: Record<string, any>

Plays

activity

plays.activity Count Play runs and delivered Monitor findings by day Risk: read
Input Output

clearHistory

plays.clearHistory Permanently delete a Play’s run history and saved sheet data, keeping its code and versions Risk: destructive
Input Output

cost

plays.cost Estimate credits per row or run for one saved or prebuilt Play (does not start a run) Risk: read
Input Output

delete

plays.delete Move a workspace Play to Trash and disable its cron and webhook triggers (restorable) Risk: destructive
Input Output

get

plays.get Describe one callable Play Risk: read
Input Output

list

plays.list List and search callable Plays Risk: read
Input Uses SDK inventory pagination. Pass cursor with unchanged filters; search maps to grep on the wire. Output

paths

plays.paths List the folder locations of workspace Plays, one page Risk: read
Input Output

pin

plays.pin Pin or unpin a workspace Play so it sorts first Risk: write
Input Output

restore

plays.restore Restore a workspace Play from Trash Risk: write
Input Output

run

plays.run Start a saved or prebuilt Play run (may spend credits or perform external actions) Risk: destructive
Input May spend credits or perform external actions. A wait timeout returns the existing run. Inspect run.id instead of submitting again. Output: object

settings.get

plays.settings.get Read a workspace Play’s location and display name Risk: read
Input Output

settings.update

plays.settings.update Change a workspace Play’s location or display name; omitted fields stay as they are Risk: write
Input
Output

share.get

plays.share.get Read a Play’s public share page status and revision picker Risk: read
Input Output

share.publish

plays.share.publish Publish or repoint a Play’s public share page to a revision (publicly viewable) Risk: destructive
Input Output

share.regenerate

plays.share.regenerate Regenerate a Play’s public share page copy with an LLM (rewrites the public page) Risk: destructive
Input Output

share.unpublish

plays.share.unpublish Delete a Play’s public share page and its cards Risk: destructive
Input Output

share.update

plays.share.update Change share page settings: search indexing, cost and latency display Risk: write
Input Output

triggers.get

plays.triggers.get Read a workspace Play’s cron schedule and inbound webhook trigger, with the webhook URL Risk: read
Input Output

triggers.history

plays.triggers.history List one trigger’s recent runs Risk: read
Input Output

triggers.inventory

plays.triggers.inventory List cron and webhook triggers across the workspace, one page Risk: read
Input Output

triggers.update

plays.triggers.update Set or remove a Play cron schedule or inbound webhook (optional HMAC or Standard Webhooks signing) and publish it live (scheduled runs may spend credits) Risk: destructive
Input
Output

versions.list

plays.versions.list List a Play’s saved versions, newest first Risk: read
Input Output

versions.publish

plays.versions.publish Make a Play version live; its cron and webhook triggers then run that version (may spend credits) Risk: destructive
Input Output

Runs

billing

runs.billing Read credits billed to up to 100 runs and whether they are settling Risk: read
Input Output

children

runs.children List one page of async child Runs Risk: read
Input Output

events

runs.events Search structured run events across the workspace or one run Risk: read
Input Output

get

runs.get Get one Play run status Risk: read
Input The default is the canonical run package. full true returns the legacy wrapper; watchSnapshot true returns a bounded snapshot. Output: object

history

runs.history Search and page workspace run history Risk: read
Input Output

input

runs.input Read the exact original input retained for a run Risk: read
Input Output

list

runs.list List Play runs filtered by Play, status or run id Risk: read
Input Output

logs

runs.logs Read retained run logs; continue with lastSeq as afterSeq Risk: read
Input Output

receipts

runs.receipts Read retained tool results for a run by receipt key, without executing tools Risk: read
Input Output

rerun

runs.rerun Start a new run from a past run’s input and revision (may spend credits) Risk: destructive
Input Output

resume

runs.resume Continue a failed or cancelled run in place (may spend credits) Risk: destructive
Input Output

status

runs.status Read the lifecycle status and progress counters of one run Risk: read
Input Output: object

stop

runs.stop Stop one running Play run Risk: destructive
Input Output

stopAll

runs.stopAll Stop every active run in the workspace; dryRun only lists them Risk: destructive
Input Output: object

query

search.query Search tools, monitor types, plays, and docs Risk: read
Input Output

Secrets

inspect

secrets.inspect Check whether a secret is active for the org or a Play, without its value Risk: read
Input Output

list

secrets.list List Play secret metadata (never values) Risk: read
Input: empty object Output

set

secrets.set Create or rotate a Play or org secret (replaces the stored value; value never returned) Risk: destructive
Input: object
Output

updateNote

secrets.updateNote Add, replace or clear the non-sensitive note on one secret Risk: write
Input Output

Tools

describeModel

tools.describeModel Describe an AI Gateway model: metadata, provider options and an example input Risk: read
Input Output

execute

tools.execute Execute one provider-backed tool (may spend credits or perform external actions) Risk: destructive
Input May spend credits or perform external actions. Send the provider input under payload. Preserve idempotencyKey before dispatch and reuse it for recovery. Output

get

tools.get Describe one provider-backed tool Risk: read
Input Returns the tool’s input contract, output contract, access requirements and pricing. Read it before tools.execute. Output: object

list

tools.list List callable provider tools Risk: read
Input Use a narrow grep or categories filter for large catalogs. compact false includes provider schemas. Output

providers

tools.providers List discoverable providers with tool counts and categories, or only recent additions Risk: read
Input Output

quote

tools.quote Price an ai_inference, deeplineagent or ai_evaluate payload without running it Risk: read
Input Output

search

tools.search Search callable provider tools Risk: read
Input Output

Workspace

members.list

workspace.members.list List one page of workspace members and their grants Risk: read
Input Output

serviceAccounts.list

workspace.serviceAccounts.list List workspace service accounts and key metadata (prefix and last 4 only) Risk: read
Input: empty object Output