Start churn agent run

Start a manual run for one configured legacy Outlit churn agent. Template and custom hosted agents run through automations.

POST /api/agents/{agentId}/runs

Start churn agent run

cURL

curl --request POST \
  --url https://app.outlit.ai/api/agents/{agentId}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientRequestId": "smoke-123"
}
'

import requests

url = "https://app.outlit.ai/api/agents/{agentId}/runs"

payload = { "clientRequestId": "smoke-123" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({clientRequestId: 'smoke-123'})
};

fetch('https://app.outlit.ai/api/agents/{agentId}/runs', 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://app.outlit.ai/api/agents/{agentId}/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'clientRequestId' => 'smoke-123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.outlit.ai/api/agents/{agentId}/runs"

	payload := strings.NewReader("{\n  \"clientRequestId\": \"smoke-123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.outlit.ai/api/agents/{agentId}/runs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clientRequestId\": \"smoke-123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.outlit.ai/api/agents/{agentId}/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clientRequestId\": \"smoke-123\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 123,
  "correlationId": "<string>",
  "result": {
    "operationId": "<string>",
    "status": "<string>",
    "resources": [
      {
        "type": "<string>",
        "id": "<string>"
      }
    ],
    "data": {
      "run": {
        "id": "<string>",
        "runId": "<string>",
        "agentId": "<string>",
        "summary": "<string>",
        "errorSummary": "<string>",
        "sandboxStatus": "<string>",
        "startedAt": "2023-11-07T05:31:56Z",
        "endedAt": "2023-11-07T05:31:56Z",
        "durationMs": 1,
        "counts": {
          "candidates": 1,
          "tools": 1,
          "artifacts": 1,
          "outputs": 1
        },
        "outputs": [
          {
            "id": "<string>",
            "deliveredAt": "2023-11-07T05:31:56Z",
            "createdAt": "2023-11-07T05:31:56Z"
          }
        ]
      },
      "agentRunId": "<string>",
      "runId": "<string>",
      "startedSandbox": true,
      "startupError": {
        "message": "<string>",
        "code": "<string>",
        "retryable": true
      }
    },
    "warnings": [
      "<string>"
    ],
    "auditId": "<string>"
  }
}

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

{
  "error": "Invalid credentials"
}

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

{
  "error": "Internal server error"
}

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

Authorizations

Authorization · string · header · required

Outlit API key using the Bearer ok_... format.

Path Parameters

agentId · string · required

Agent ID.

Minimum string length: 1

Body

application/json

clientRequestId · string

Required string length: 1 - 191

Response

200

application/json

Agent run was started or an idempotent prior run was returned.

ok · boolean · required

commandId · string · required

Allowed value: "agent.run.start"

commandVersion · integer · required

correlationId · string · required

result · object · required

Show child attributes