Update agent

Patch one configured Outlit agent. Only provided fields are changed.

PATCH /api/agents/{id}

Update agent

cURL

curl --request PATCH \
  --url https://app.outlit.ai/api/agents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "Renewal risk",
  "instructions": "Prioritize recent support escalations.",
  "actionKeys": [
    "send_slack_notification"
  ]
}
'

import requests

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

payload = {
    "displayName": "Renewal risk",
    "instructions": "Prioritize recent support escalations.",
    "actionKeys": ["send_slack_notification"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    displayName: 'Renewal risk',
    instructions: 'Prioritize recent support escalations.',
    actionKeys: ['send_slack_notification']
  })
};

fetch('https://app.outlit.ai/api/agents/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => 'Renewal risk',
    'instructions' => 'Prioritize recent support escalations.',
    'actionKeys' => [
        'send_slack_notification'
    ]
  ]),
  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/{id}"

	payload := strings.NewReader("{\n  \"displayName\": \"Renewal risk\",\n  \"instructions\": \"Prioritize recent support escalations.\",\n  \"actionKeys\": [\n    \"send_slack_notification\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.outlit.ai/api/agents/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayName\": \"Renewal risk\",\n  \"instructions\": \"Prioritize recent support escalations.\",\n  \"actionKeys\": [\n    \"send_slack_notification\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayName\": \"Renewal risk\",\n  \"instructions\": \"Prioritize recent support escalations.\",\n  \"actionKeys\": [\n    \"send_slack_notification\"\n  ]\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": {
      "agent": {
        "id": "<string>",
        "agentKey": "<string>",
        "displayName": "<string>",
        "templateVersion": "<string>",
        "actionKeys": [
          "<string>"
        ],
        "schedule": {
          "enabled": true,
          "nextRunAt": "2023-11-07T05:31:56Z",
          "lastRunAt": "2023-11-07T05:31:56Z",
          "lastSuccessfulRunAt": "2023-11-07T05:31:56Z"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    },
    "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

id · string · required

Agent ID.

Minimum string length: 1

Body

application/json

displayName · string

Required string length: 1 - 120

instructions · string

Required string length: 1 - 10000

actionKeys · string[]

Minimum string length: 1

Response

200

application/json

Agent was updated.

ok · boolean · required

commandId · string · required

Allowed value: "agent.update"

commandVersion · integer · required

correlationId · string · required

result · object · required

Show child attributes