Send a message to an agent conversation

Send a message

curl --request POST \
  --url https://api.onecli.sh/v1/conversations/{conversationId}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "attachmentIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.onecli.sh/v1/conversations/{conversationId}/messages"

payload = {
    "message": "<string>",
    "attachmentIds": ["<string>"]
}
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({message: '<string>', attachmentIds: ['<string>']})
};

fetch('https://api.onecli.sh/v1/conversations/{conversationId}/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.onecli.sh/v1/conversations/{conversationId}/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([
    'message' => '<string>',
    'attachmentIds' => [
        '<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.onecli.sh/v1/conversations/{conversationId}/messages"

	payload := strings.NewReader("{\n  \"message\": \"<string>\",\n  \"attachmentIds\": [\n    \"<string>\"\n  ]\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.onecli.sh/v1/conversations/{conversationId}/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": \"<string>\",\n  \"attachmentIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/conversations/{conversationId}/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  \"message\": \"<string>\",\n  \"attachmentIds\": [\n    \"<string>\"\n  ]\n}"

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

{
  "kind": "turn",
  "turn": {
    "id": "<string>",
    "conversationId": "<string>",
    "status": "queued",
    "source": "<string>",
    "userId": "<string>",
    "message": "<string>",
    "error": "<string>",
    "errorCode": "<string>",
    "usage": {},
    "followUpOfTurnId": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "attachments": [
      {
        "id": "<string>",
        "name": "<string>",
        "mimeType": "<string>",
        "sizeBytes": 123,
        "status": "<string>",
        "direction": "inbound",
        "caption": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

conversations

{conversationId}

messages

Send a message

curl --request POST \
  --url https://api.onecli.sh/v1/conversations/{conversationId}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "attachmentIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.onecli.sh/v1/conversations/{conversationId}/messages"

payload = {
    "message": "<string>",
    "attachmentIds": ["<string>"]
}
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({message: '<string>', attachmentIds: ['<string>']})
};

fetch('https://api.onecli.sh/v1/conversations/{conversationId}/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.onecli.sh/v1/conversations/{conversationId}/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([
    'message' => '<string>',
    'attachmentIds' => [
        '<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.onecli.sh/v1/conversations/{conversationId}/messages"

	payload := strings.NewReader("{\n  \"message\": \"<string>\",\n  \"attachmentIds\": [\n    \"<string>\"\n  ]\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.onecli.sh/v1/conversations/{conversationId}/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": \"<string>\",\n  \"attachmentIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/conversations/{conversationId}/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  \"message\": \"<string>\",\n  \"attachmentIds\": [\n    \"<string>\"\n  ]\n}"

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

{
  "kind": "turn",
  "turn": {
    "id": "<string>",
    "conversationId": "<string>",
    "status": "queued",
    "source": "<string>",
    "userId": "<string>",
    "message": "<string>",
    "error": "<string>",
    "errorCode": "<string>",
    "usage": {},
    "followUpOfTurnId": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "finishedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "attachments": [
      {
        "id": "<string>",
        "name": "<string>",
        "mimeType": "<string>",
        "sizeBytes": 123,
        "status": "<string>",
        "direction": "inbound",
        "caption": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Sends your message whatever the agent is doing. Use it as the default way to talk to an agent: an idle agent gets a new turn, and a busy one gets a follow-up that steers its current work. Related guide: Agent access: grant credentials to agents. Says something whatever the agent is doing. A free conversation gets an ordinary turn; a turn in flight gets a follow-up that steers into it. The response says which. At most 10 follow-ups may wait on one conversation.

Availability: Cloud · Community (self-hosted) · Enterprise (self-hosted)

Authorizations

Authorization

string

header

required

A workspace API key (oc_…) or organization API key (oc_org_…). Workspace-scoped endpoints called with an organization key also need X-Workspace-Id.

Path Parameters

conversationId

string

required

Body

application/json

message

string

required

Maximum string length: 100000

attachmentIds

string[]

Ids of attachments staged with POST /conversations/{conversationId}/attachments.

Maximum array length: 5

Response

What the message became

kind

enum<string>

Available options:

turn,

followUp

turn

object

Show child attributes

Workspace

Organization

Enterprise

Platform

Send a message to an agent conversation

Authorizations

Path Parameters

Body

Response