Live Direct Marketing Tasks API
The Tasks API from Live Direct Marketing — 31 operation(s) for tasks.
Operations 41
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/api/tasks
List tasks with status and method filters · List tasks with pagination and status/method filters
#
Ask an LLM
“Which of my tasks are currently active?”
“Can I filter my task list down to only site-scoring tasks?”
Tell an agent
List my tasks with status {status}.
Show page {page} of my tasks for method {methodId}, {pageSize} per page.
Ask an LLM
“How do I set up a site-scoring task that pulls its companies from a company list?”
“Can I create an email validation task that sources contacts from a contact list?”
Tell an agent
Create a scoring task with method {methodId} named {methodName} that scores companies from list {companyListId}.
Create a {methodName} task (method {methodId}) over contact list {contactListId} that waits until {resumeAt}.
Ask an LLM
“How far along is my task — how many items has it processed out of the total?”
“Where can I see the full record for one task?”
Tell an agent
Show me task {id}.
Fetch the details and progress counters of task {id}.
PATCH
/api/tasks/{id}
Update a task's description, config or schedule · Update task description, configuration, or schedule
#
Ask an LLM
“Can I change the description or source list on a task I already created?”
“How do I push back the date an existing task resumes at?”
Tell an agent
Change the description of task {id} to {description}.
Reschedule task {id} to resume at {resumeAt} with {streamCount} parallel streams.
Ask an LLM
“How do I permanently remove a task I no longer need?”
“Can I delete a task outright instead of just stopping it?”
Tell an agent destructive · confirm first
Delete task {id}.
Remove task {id} from my workspace for good.
GET
/api/tasks/{id}/branches
List a task's sub-sequence branches · List sub-sequence branches of a task
#
Ask an LLM
“What sub-sequence branches hang off my task?”
“Which branches have been created under a given task?”
Tell an agent
List the branches of task {id}.
Show every sub-sequence branch configured under task {id}.
POST
/api/tasks/{id}/branches
Create a sub-sequence branch off a task · Create a sub-sequence branch off a task
#
Ask an LLM
“Can I branch contacts off a task into an ICP review when a certain event happens?”
“How do I add a conditional sub-sequence to an existing task?”
Tell an agent
Create a {methodName} branch (method {methodId}) on task {id} triggered by {branchTrigger}.
Add a branch to task {id} using method {methodId} ({methodName}) that fires on {branchTrigger} and draws from list {contactListId}.
POST
/api/tasks/{id}/branches/{branchId}/enroll
Enroll contacts into a task branch · Enroll contacts into a task branch
#
Ask an LLM
“How do I manually put specific contacts into a task's branch?”
“Can I push a handful of contacts straight into a sub-sequence branch?”
Tell an agent
Enroll contacts {contactIds} into branch {branchId} of task {id}.
Add these contacts {contactIds} to task branch {branchId}.
GET
/api/tasks/{id}/items
List the items a task has processed · List items processed by a task with pagination
#
Ask an LLM
“Which individual items has my task worked through, and with what status?”
“Can I page through only the failed items of a task?”
Tell an agent
List items of task {id} with status {status}.
Show page {page} of task {id}'s items, {pageSize} per page.
Ask an LLM
“What happened to one particular item inside my task?”
“Where can I inspect a single processed item of a task?”
Tell an agent
Show item {itemId} of task {id}.
Fetch the result for task item {itemId} in task {id}.
Ask an LLM
“What are the overall counts for my task — done, pending, errored?”
“Can I see a summary of totals for one task?”
Tell an agent
Give me the aggregate stats for task {id}.
Summarize item totals by status for task {id}.
GET
/api/tasks/{id}/errors
List errors from a task run · List errors encountered during a task run
#
Ask an LLM
“Why did my task run hit errors?”
“What error messages did a task produce while running?”
Tell an agent
List the errors encountered by task {id}.
Show me what went wrong during task {id}'s run.
Ask an LLM
“How do I kick off a task so it begins processing its list?”
“Can I do a trial run that only processes a few items and then pauses?”
Tell an agent
Start task {id}.
Run task {id} as a trial on at most {limit} items, then pause.
Ask an LLM
“Can I temporarily halt a task that is running right now?”
“What do I call to put an active task on hold?”
Tell an agent
Pause task {id}.
Put running task {id} on hold for now.
Ask an LLM
“How do I end a task for good and mark it as done?”
“Can I finish a task early without deleting it?”
Tell an agent destructive · confirm first
Stop task {id} and mark it as done.
End task {id} now.
POST
/api/tasks/{id}/restart
Retry a task's errored items · Resume a task: resets ERROR items to PENDING and sets status=ACTIVE.
#
Ask an LLM
“How do I retry only the items that errored in a task without redoing scored ones?”
“Will restarting a task wipe out results that were already scored?”
Tell an agent
Restart task {id} so its errored items are retried.
Reset the ERROR items of task {id} to pending and reactivate it.
GET
/api/tasks/{id}/analytics
Get open, click and reply rates for a task · Get analytics for a task (open/click/reply rates)
#
Ask an LLM
“What open, click and reply rates did my mailing task get?”
“How well did a task perform in terms of engagement?”
Tell an agent
Show open, click and reply analytics for task {id}.
Report the engagement rates of task {id}.
GET
/api/tasks/{id}/monitor
Watch a running task in real time · Get real-time monitor data for a running task
#
Ask an LLM
“What is my running task doing at this moment?”
“Is there a live monitoring view for a task in progress?”
Tell an agent
Show the real-time monitor for task {id}.
Get live monitoring data for running task {id}.
GET
/api/tasks/{id}/report.csv
Download a CSV report of task items · Download a CSV report of all task items
#
Ask an LLM
“Can I export all of a task's items to a spreadsheet?”
“How do I get a CSV of everything a task processed?”
Tell an agent
Download the CSV item report for task {id}.
Export all items of task {id} as a CSV file.
GET
/api/tasks/{id}/circuit-breaker
Check a task's circuit-breaker state · Get the circuit-breaker state for a task
#
Ask an LLM
“Has the circuit breaker tripped on my task?”
“Why did a task stop itself after too many errors?”
Tell an agent
Show the circuit-breaker state for task {id}.
Check whether task {id}'s circuit breaker is open.
POST
/api/tasks/{id}/circuit-breaker/reset
Reset a tripped circuit breaker · Reset a tripped circuit breaker for a task
#
Ask an LLM
“How do I clear a tripped circuit breaker so my task can carry on?”
“Can I reset the breaker after fixing what caused the errors?”
Tell an agent
Reset the circuit breaker on task {id}.
Clear the tripped breaker for task {id}.
Ask an LLM
“Which pipeline steps are configured on my scoring task?”
“In what order will a task run its steps?”
Tell an agent
List the pipeline steps of task {id}.
Show the configured step pipeline for task {id}.
Ask an LLM
“Can I add a site availability check or email extraction step to a scoring task?”
“How do I route companies to another list when a pipeline step fails?”
Tell an agent
Add a {type} step to task {id}.
Add a {type} step named {name} to task {id} that moves failures to list {onFailTarget}.
PUT
/api/tasks/{id}/steps/reorder
Reorder a task's pipeline steps · Reorder pipeline steps in a task
#
Ask an LLM
“Can I change the order in which a task runs its pipeline steps?”
“How do I move the keyword step ahead of the AI content step?”
Tell an agent
Reorder the steps of task {id} to {stepIds}.
Set the pipeline order for task {id} as {stepIds}.
PATCH
/api/tasks/{id}/steps/{stepId}
Update a single pipeline step · Update a single pipeline step
#
Ask an LLM
“Can I disable one pipeline step without deleting it?”
“How do I change what happens when a particular step errors?”
Tell an agent
Set enabled to {enabled} on step {stepId} of task {id}.
Change step {stepId} in task {id} so errors do {onError}.
DELETE
/api/tasks/{id}/steps/{stepId}
Delete a pipeline step from a task · Delete a pipeline step from a task
#
Ask an LLM
“How do I drop a step from a task's pipeline?”
“Can I remove the phone extraction step from my scoring task?”
Tell an agent destructive · confirm first
Delete step {stepId} from task {id}.
Remove pipeline step {stepId} of task {id}.
GET
/api/tasks/{id}/scoring-results
List a task's company scoring results · List scoring results for a task with pagination.
#
Ask an LLM
“What scores did each company get in my site-scoring task?”
“Can I see only the scoring results flagged as contradictory?”
Tell an agent
List scoring results of task {id} with status {status}.
Show contradictory scoring results for task {id}.
GET
/api/tasks/{id}/scoring-stats
Get aggregate scoring stats for a task · Get aggregate scoring statistics for a task
#
Ask an LLM
“How many companies scored above threshold versus below in my task?”
“What is the breakdown of scoring outcomes for a task?”
Tell an agent
Show scoring statistics for task {id}.
Summarize the scoring outcome counts for task {id}.
DELETE
/api/tasks/{id}/scoring-results/{resultId}
Delete one scoring result · Delete a single scoring result
#
Ask an LLM
“Can I remove a single company's scoring card from a task?”
“How do I get rid of one bad scoring result?”
Tell an agent destructive · confirm first
Delete scoring result {resultId} from task {id}.
Remove scoring card {resultId} in task {id}.
POST
/api/tasks/{id}/scoring-results/retry
Retry a selection of scoring results · #1099: retry SELECTION of scoring results — by statuses…
#
Ask an LLM
“Can I re-score companies that came back with errors or below threshold?”
“Is there a way to preview how many results a retry would pick before running it?”
Tell an agent
Retry scoring results of task {id} with statuses {statuses}.
Re-score companies {companyIds} in task {id}.
GET
/api/tasks/{id}/scoring-results/{resultId}/events
Get the step journal for a scoring card · #975: paginated step journal for a single scoring card…
#
Ask an LLM
“What steps ran on one company's scoring card, and in what order?”
“Did a scoring card get interrupted or resumed after a restart?”
Tell an agent
Show the step events for scoring result {resultId} in task {id}.
Page {page} of the step journal for card {resultId} in task {id}, {pageSize} per page.
GET
/api/tasks/{id}/scoring-results.csv
Download scoring results as CSV · Download a CSV of scoring results
#
Ask an LLM
“Can I export my scored companies to a CSV file?”
“How do I download only the scoring results with a given status as a spreadsheet?”
Tell an agent
Download scoring results of task {id} with status {status} as CSV.
Export task {id}'s scoring results matching {search} to a CSV.
GET
/api/tasks/{id}/error-settings
Get a task's error-handling settings · Get the error-handling settings for a task
#
Ask an LLM
“At what error rate will my task trip and stop?”
“What consecutive-error limit is set on a task?”
Tell an agent
Show the error-handling settings for task {id}.
Get the error thresholds configured on task {id}.
PATCH
/api/tasks/{id}/error-settings
Change a task's error thresholds · Update error-handling settings for a task
#
Ask an LLM
“Can I make a task tolerate more consecutive errors before it trips?”
“How do I set the error-rate percentage and window that halts a task?”
Tell an agent
Set the consecutive error limit of task {id} to {consecutiveErrorLimit}.
Trip task {id} at {errorRatePercent}% errors over {errorRateWindowMin} minutes.
GET
/api/tasks/{id}/memory
Get a task's AI memory instructions · Get AI memory instructions for a task
#
Ask an LLM
“What standing instructions has the AI been given for this task?”
“Where can I read the AI memory attached to a task?”
Tell an agent
Show the AI memory for task {id}.
Read the AI memory instructions saved on task {id}.
PATCH
/api/tasks/{id}/memory
Update a task's AI memory instructions · Update AI memory instructions for a task
#
Ask an LLM
“Can I give the AI on a task standing instructions it should remember?”
“How do I rewrite the memory the AI uses for one task?”
Tell an agent
Set the AI memory of task {id} to {memory}.
Tell the AI on task {id} to remember: {memory}.
GET
/api/tasks/{id}/ai-settings
Get a task's AI provider and model · Get the AI provider/model settings for a task
#
Ask an LLM
“Which AI provider and models is my task using?”
“What model settings are configured on a task?”
Tell an agent
Show the AI provider and model settings for task {id}.
Tell me which models task {id} runs on.
PATCH
/api/tasks/{id}/ai-settings
Change a task's AI provider and model · Update the AI provider/model settings for a task
#
Ask an LLM
“Can I switch the AI provider a task uses?”
“How do I change which models a task runs on?”
Tell an agent
Switch task {id} to AI provider {provider}.
Set task {id} to use provider {provider} with models {models}.
GET
/api/tasks/{id}/cron
Get a task's cron schedule settings · Get the cron scheduling settings for a task
#
Ask an LLM
“Is my task set to run on a schedule, and how often?”
“What batch size and interval does a task's cron use?”
Tell an agent
Show the cron settings for task {id}.
Get the scheduled-run interval and batch size of task {id}.
PATCH
/api/tasks/{id}/cron
Change a task's cron schedule · Update the cron scheduling settings for a task
#
Ask an LLM
“Can I make a task run automatically every few minutes?”
“How do I change the batch size a scheduled task processes each run?”
Tell an agent
Enable cron on task {id} every {cronInterval} minutes.
Set the cron batch size of task {id} to {batchSize}.
POST
/api/tasks/{id}/cron/trigger
Trigger a task's cron run now · Manually trigger a task cron run
#
Ask an LLM
“Can I fire a scheduled task's next batch right away instead of waiting?”
“How do I manually kick off one cron run of a task?”
Tell an agent
Trigger a cron run of task {id} now.
Run the next scheduled batch of task {id} immediately.
Documentation
📖
Documentation
https://developers.live-direct-marketing.online/
📖
APIReference
https://developers.live-direct-marketing.online/api-reference
📖
GettingStarted
https://developers.live-direct-marketing.online/quickstart
📖
Authentication
https://developers.live-direct-marketing.online/authentication
📖
Documentation
https://check.live-direct-marketing.online/docs
📖
APIReference
https://check.live-direct-marketing.online/api/docs