Run a scheduled task
curl --request POST \
--url https://api.langdock.com/automations/v1/{automationId}/run \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.langdock.com/automations/v1/{automationId}/run"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.langdock.com/automations/v1/{automationId}/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.langdock.com/automations/v1/{automationId}/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.langdock.com/automations/v1/{automationId}/run"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.langdock.com/automations/v1/{automationId}/run")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.langdock.com/automations/v1/{automationId}/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyScheduled Tasks API
Run Scheduled Task
Enqueue one run of a scheduled task owned by the workspace API key
POST
/
automations
/
v1
/
{automationId}
/
run
Run a scheduled task
curl --request POST \
--url https://api.langdock.com/automations/v1/{automationId}/run \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.langdock.com/automations/v1/{automationId}/run"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.langdock.com/automations/v1/{automationId}/run', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.langdock.com/automations/v1/{automationId}/run",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.langdock.com/automations/v1/{automationId}/run"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.langdock.com/automations/v1/{automationId}/run")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.langdock.com/automations/v1/{automationId}/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyEnqueues one run of a scheduled task owned by this workspace API key. The call returns when the run is queued. It does not wait for the conversation.
This endpoint has no body. You can run a paused task. The run does not by itself set
conversationId in this response is always null. Use runId to identify the queued run.
Base URL
https://api.langdock.com/automations/v1/{automationId}/run
Dedicated deploymentsReplace
api.langdock.com with <your-deployment-url>/api/public in all requests.Required scopes
This endpoint requires theAUTOMATION_API scope (Scheduled Tasks API) on a workspace API key.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
automationId | Path | string | Yes | UUID of the scheduled task. |
active back to true.
Example
const axios = require("axios");
async function runScheduledTask(automationId) {
const response = await axios.post(
`https://api.langdock.com/automations/v1/${automationId}/run`,
null,
{
headers: {
Authorization: "Bearer YOUR_API_KEY"
}
}
);
console.log(response.data.runId);
}
runScheduledTask("550e8400-e29b-41d4-a716-446655440000");
Response format
Success response (200 OK)
{
runId: string;
conversationId: null;
}
Error handling
| Status code | Description |
|---|---|
| 400 | Invalid task id |
| 401 | Invalid or missing API key, or the key user was not found |
| 403 | Missing AUTOMATION_API, a personal API key, Scheduled Tasks disabled, no product access, or code TRIAL_EXPIRED |
| 404 | AUTOMATION_NOT_FOUND |
| 405 | Method not allowed |
| 429 | Rate limit exceeded |
| 500 | Internal server error |
Langdock intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on API Key Best Practices.
Was this page helpful?