Update Conversation Endpoint

Update a conversation’s title or discard status.

• conversation_id: The ID of the conversation to update
• title: New title for the conversation (optional)
• discarded: Whether the conversation is discarded (optional)

PATCH /v1/dev/user/conversations/{conversation_id}

Update Conversation Endpoint

cURL

curl --request PATCH \
  --url https://api.omi.me/v1/dev/user/conversations/{conversation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "discarded": true,
  "title": "<string>"
}
'

import requests

url = "https://api.omi.me/v1/dev/user/conversations/{conversation_id}"

payload = {
    "discarded": True,
    "title": "<string>"
}
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({discarded: true, title: '<string>'})
};

fetch('https://api.omi.me/v1/dev/user/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.omi.me/v1/dev/user/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([
    'discarded' => true,
    'title' => '<string>'
  ]),
  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.omi.me/v1/dev/user/conversations/{conversation_id}"

	payload := strings.NewReader("{\n  \"discarded\": true,\n  \"title\": \"<string>\"\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.omi.me/v1/dev/user/conversations/{conversation_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"discarded\": true,\n  \"title\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.omi.me/v1/dev/user/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  \"discarded\": true,\n  \"title\": \"<string>\"\n}"

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

200

{
  "created_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "structured": {
    "overview": "<string>",
    "title": "<string>",
    "action_items": [],
    "emoji": "🧠",
    "events": []
  },
  "folder_id": "<string>",
  "folder_name": "<string>",
  "geolocation": {
    "latitude": 123,
    "longitude": 123,
    "address": "<string>",
    "google_place_id": "<string>",
    "location_type": "<string>"
  },
  "language": "<string>",
  "source": "<string>",
  "transcript_segments": [
    {
      "end": 123,
      "start": 123,
      "text": "<string>",
      "id": "<string>",
      "speaker_id": 123,
      "speaker_name": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

Authorizations

Authorization · string · header · required

Send Authorization: Bearer <omi_developer_api_key>.

Path Parameters

conversation_id · string · required

Body

application/json

discarded · boolean | null

Whether the conversation is discarded

title · string | null

New title for the conversation

Required string length: 1 - 500

Response

200

application/json

Successful Response

created_at · string<date-time> · required

finished_at · string<date-time> | null · required

id · string · required

started_at · string<date-time> | null · required

structured · DeveloperConversationStructured · object · required

Show child attributes

folder_id · string | null

folder_name · string | null

geolocation · Geolocation · object | null

Show child attributes

language · string | null

source · string | null

transcript_segments · DeveloperTranscriptSegment · object[] | null

Show child attributes