Update Conversation

curl --request PATCH \
  --url https://api.example.com/conversations/{conversation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "context": {
    "entities": [],
    "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "current_directory": "<string>",
    "workspace_ref": "<string>",
    "visible_items": [],
    "selected_names": []
  }
}
'

import requests

url = "https://api.example.com/conversations/{conversation_id}"

payload = {
    "title": "<string>",
    "context": {
        "entities": [],
        "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "current_directory": "<string>",
        "workspace_ref": "<string>",
        "visible_items": [],
        "selected_names": []
    }
}
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({
    title: '<string>',
    context: {
      entities: [],
      folder_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      current_directory: '<string>',
      workspace_ref: '<string>',
      visible_items: [],
      selected_names: []
    }
  })
};

fetch('https://api.example.com/conversations/{conversation_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://api.example.com/conversations/{conversation_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([
    'title' => '<string>',
    'context' => [
        'entities' => [
                
        ],
        'folder_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'current_directory' => '<string>',
        'workspace_ref' => '<string>',
        'visible_items' => [
                
        ],
        'selected_names' => [
                
        ]
    ]
  ]),
  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://api.example.com/conversations/{conversation_id}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"context\": {\n    \"entities\": [],\n    \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"current_directory\": \"<string>\",\n    \"workspace_ref\": \"<string>\",\n    \"visible_items\": [],\n    \"selected_names\": []\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://api.example.com/conversations/{conversation_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"context\": {\n    \"entities\": [],\n    \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"current_directory\": \"<string>\",\n    \"workspace_ref\": \"<string>\",\n    \"visible_items\": [],\n    \"selected_names\": []\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/conversations/{conversation_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  \"title\": \"<string>\",\n  \"context\": {\n    \"entities\": [],\n    \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"current_directory\": \"<string>\",\n    \"workspace_ref\": \"<string>\",\n    \"visible_items\": [],\n    \"selected_names\": []\n  }\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversation_type": "USER_CHAT",
  "title": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "context": {
    "entities": [],
    "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "current_directory": "<string>",
    "workspace_ref": "<string>",
    "visible_items": [],
    "selected_names": []
  },
  "last_assistant": "<string>",
  "associated_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "associated_entity_type": "DASHBOARD",
  "lease_epoch": 123,
  "last_user_message_at": "2023-11-07T05:31:56Z",
  "summary": "<string>",
  "pipeline_plan": {},
  "skill_run_state": {},
  "work_order": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

PATCH

conversations

{conversation_id}

Update Conversation

curl --request PATCH \
  --url https://api.example.com/conversations/{conversation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "context": {
    "entities": [],
    "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "current_directory": "<string>",
    "workspace_ref": "<string>",
    "visible_items": [],
    "selected_names": []
  }
}
'

import requests

url = "https://api.example.com/conversations/{conversation_id}"

payload = {
    "title": "<string>",
    "context": {
        "entities": [],
        "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "current_directory": "<string>",
        "workspace_ref": "<string>",
        "visible_items": [],
        "selected_names": []
    }
}
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({
    title: '<string>',
    context: {
      entities: [],
      folder_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      current_directory: '<string>',
      workspace_ref: '<string>',
      visible_items: [],
      selected_names: []
    }
  })
};

fetch('https://api.example.com/conversations/{conversation_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://api.example.com/conversations/{conversation_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([
    'title' => '<string>',
    'context' => [
        'entities' => [
                
        ],
        'folder_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'current_directory' => '<string>',
        'workspace_ref' => '<string>',
        'visible_items' => [
                
        ],
        'selected_names' => [
                
        ]
    ]
  ]),
  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://api.example.com/conversations/{conversation_id}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"context\": {\n    \"entities\": [],\n    \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"current_directory\": \"<string>\",\n    \"workspace_ref\": \"<string>\",\n    \"visible_items\": [],\n    \"selected_names\": []\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://api.example.com/conversations/{conversation_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"context\": {\n    \"entities\": [],\n    \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"current_directory\": \"<string>\",\n    \"workspace_ref\": \"<string>\",\n    \"visible_items\": [],\n    \"selected_names\": []\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/conversations/{conversation_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  \"title\": \"<string>\",\n  \"context\": {\n    \"entities\": [],\n    \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"current_directory\": \"<string>\",\n    \"workspace_ref\": \"<string>\",\n    \"visible_items\": [],\n    \"selected_names\": []\n  }\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversation_type": "USER_CHAT",
  "title": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "context": {
    "entities": [],
    "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "current_directory": "<string>",
    "workspace_ref": "<string>",
    "visible_items": [],
    "selected_names": []
  },
  "last_assistant": "<string>",
  "associated_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "associated_entity_type": "DASHBOARD",
  "lease_epoch": 123,
  "last_user_message_at": "2023-11-07T05:31:56Z",
  "summary": "<string>",
  "pipeline_plan": {},
  "skill_run_state": {},
  "work_order": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Api-key

string | null

Path Parameters

conversation_id

string

required

Body

application/json

title

string | null

context

ConversationContext · object | null

Show child attributes

Response

Successful Response

string<uuid>

required

conversation_type

enum<string>

required

Available options:

USER_CHAT,

TASK_RUN,

TRAINING_SUPERVISION

title

string

required

created_at

string<date-time>

required

context

ConversationContext · object | null

required

Show child attributes

last_assistant

string | null

required

associated_entity_id

string<uuid> | null

associated_entity_type

enum<string> | null

Available options:

DASHBOARD,

PIPELINE,

AUTOMATION,

REPORT

lease_epoch

integer | null

last_user_message_at

string<date-time> | null

summary

string | null

pipeline_plan

Pipeline Plan · object | null

skill_run_state

Skill Run State · object | null

work_order

Work Order · object | null