Get Message

Get Message

curl --request GET \
  --url https://api.example.com/api/v1/messages/{message_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/messages/{message_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/api/v1/messages/{message_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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.example.com/api/v1/messages/{message_id}"

	req, _ := http.NewRequest("GET", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/messages/{message_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "conversation_id": "<string>",
  "sender_id": "<string>",
  "content": "<string>",
  "workspace_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "id": "<string>",
  "role": "user",
  "tool_calls": [
    {}
  ],
  "message_type": "text",
  "tags": [
    "<string>"
  ],
  "checksum": "<string>",
  "attachments": [
    {}
  ],
  "parent_message_id": "<string>",
  "meta_data": {},
  "sent_at": "2023-11-07T05:31:56Z",
  "owner_id": "<string>"
}

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

GET

api

messages

{message_id}

Get Message

curl --request GET \
  --url https://api.example.com/api/v1/messages/{message_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/messages/{message_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/api/v1/messages/{message_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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.example.com/api/v1/messages/{message_id}"

	req, _ := http.NewRequest("GET", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/messages/{message_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "conversation_id": "<string>",
  "sender_id": "<string>",
  "content": "<string>",
  "workspace_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "id": "<string>",
  "role": "user",
  "tool_calls": [
    {}
  ],
  "message_type": "text",
  "tags": [
    "<string>"
  ],
  "checksum": "<string>",
  "attachments": [
    {}
  ],
  "parent_message_id": "<string>",
  "meta_data": {},
  "sent_at": "2023-11-07T05:31:56Z",
  "owner_id": "<string>"
}

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

Authorizations

Authorization

string

header

required

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

Headers

X-Workspace-Id

string | null

The workspace ID

Path Parameters

message_id

string

required

Response

Successful Response

Schema for reading message data.

conversation_id

string

required

Reference to conversation

sender_id

string

required

ID of the message sender

content

string

required

Message content

workspace_id

string

required

Reference to workspace

created_at

string | null

updated_at

string | null

string

role

string

default:user

Message role (user, assistant, system, etc.)

tool_calls

Tool Calls · object[] | null

Tool calls made in this message

message_type

string

default:text

Type of message

Compression

API Keys

Collections

Contents

Conversations

Messages

OpenAI Compatible Endpoint

Memory

Content Upload

Chunks

Credentials

Connections

Integrations

OAuth

Authorizations

Headers

Path Parameters

Response