Create Message

Create one or more messages. Accepts either: - Single message object: { message object } - Array of message objects: [ { message object }, ... ] The workspace_id will be automatically set from the current session context.

POST /api/v1/messages

Create Message

cURL

curl --request POST \
  --url https://api.example.com/api/v1/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": {
    "content": "<string>",
    "sender_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "role": "user",
    "message_type": "text",
    "tool_calls": [
      {}
    ],
    "parent_message_id": "<string>",
    "tags": [
      "<string>"
    ],
    "meta_data": {},
    "attachments": [
      {}
    ]
  },
  "conversation_id": "<string>",
  "enable_memories": false
}
'

import requests

url = "https://api.example.com/api/v1/messages"

payload = {
    "content": {
        "content": "<string>",
        "sender_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "role": "user",
        "message_type": "text",
        "tool_calls": [{}],
        "parent_message_id": "<string>",
        "tags": ["<string>"],
        "meta_data": {},
        "attachments": [{}]
    },
    "conversation_id": "<string>",
    "enable_memories": False
}
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({
    content: {
      content: '<string>',
      sender_id: '<string>',
      created_at: '2023-11-07T05:31:56Z',
      role: 'user',
      message_type: 'text',
      tool_calls: [{}],
      parent_message_id: '<string>',
      tags: ['<string>'],
      meta_data: {},
      attachments: [{}]
    },
    conversation_id: '<string>',
    enable_memories: false
  })
};

fetch('https://api.example.com/api/v1/messages', 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",
  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([
    'content' => [
        'content' => '<string>',
        'sender_id' => '<string>',
        'created_at' => '2023-11-07T05:31:56Z',
        'role' => 'user',
        'message_type' => 'text',
        'tool_calls' => [
                [
                                
                ]
        ],
        'parent_message_id' => '<string>',
        'tags' => [
                '<string>'
        ],
        'meta_data' => [
                
        ],
        'attachments' => [
                [
                                
                ]
        ]
    ],
    'conversation_id' => '<string>',
    'enable_memories' => false
  ]),
  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/api/v1/messages"

	payload := strings.NewReader("{\n  \"content\": {\n    \"content\": \"<string>\",\n    \"sender_id\": \"<string>\",\n    \"created_at\": \"2023-11-07T05:31:56Z\",\n    \"role\": \"user\",\n    \"message_type\": \"text\",\n    \"tool_calls\": [\n      {}\n    ],\n    \"parent_message_id\": \"<string>\",\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"meta_data\": {},\n    \"attachments\": [\n      {}\n    ]\n  },\n  \"conversation_id\": \"<string>\",\n  \"enable_memories\": false\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://api.example.com/api/v1/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"content\": {\n    \"content\": \"<string>\",\n    \"sender_id\": \"<string>\",\n    \"created_at\": \"2023-11-07T05:31:56Z\",\n    \"role\": \"user\",\n    \"message_type\": \"text\",\n    \"tool_calls\": [\n      {}\n    ],\n    \"parent_message_id\": \"<string>\",\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"meta_data\": {},\n    \"attachments\": [\n      {}\n    ]\n  },\n  \"conversation_id\": \"<string>\",\n  \"enable_memories\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"content\": {\n    \"content\": \"<string>\",\n    \"sender_id\": \"<string>\",\n    \"created_at\": \"2023-11-07T05:31:56Z\",\n    \"role\": \"user\",\n    \"message_type\": \"text\",\n    \"tool_calls\": [\n      {}\n    ],\n    \"parent_message_id\": \"<string>\",\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"meta_data\": {},\n    \"attachments\": [\n      {}\n    ]\n  },\n  \"conversation_id\": \"<string>\",\n  \"enable_memories\": false\n}"

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

201

[
  {
    "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

Body

application/json

Schema for creating messages.

content · MessageCreateRequest · object · required

Schema for message creation request.

MessageCreateRequest · object

MessageCreateRequest · object[]

Show child attributes

conversation_id · string | null

Conversation ID

enable_memories · boolean | null · default: false

Enable memories

Response

201

application/json

Successful Response

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

id · 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

tags · string[] | null

Message tags

checksum · string | null

Message checksum

attachments · Attachments · object[] | null

Message attachments

parent_message_id · string | null

Parent message ID for threading

meta_data · Meta Data · object | null

Additional metadata

sent_at · string<date-time> | null

When the message was sent

owner_id · string | null

Owner ID