Start a conversation with a hosted agent

Start a conversation

curl --request POST \
  --url https://api.onecli.sh/v1/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "<string>",
  "source": "web",
  "title": "<string>",
  "externalRef": "<string>"
}
'

import requests

url = "https://api.onecli.sh/v1/conversations"

payload = {
    "agentId": "<string>",
    "source": "web",
    "title": "<string>",
    "externalRef": "<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({agentId: '<string>', source: 'web', title: '<string>', externalRef: '<string>'})
};

fetch('https://api.onecli.sh/v1/conversations', 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",
  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([
    'agentId' => '<string>',
    'source' => 'web',
    'title' => '<string>',
    'externalRef' => '<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"

	payload := strings.NewReader("{\n  \"agentId\": \"<string>\",\n  \"source\": \"web\",\n  \"title\": \"<string>\",\n  \"externalRef\": \"<string>\"\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agentId\": \"<string>\",\n  \"source\": \"web\",\n  \"title\": \"<string>\",\n  \"externalRef\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/conversations")

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  \"agentId\": \"<string>\",\n  \"source\": \"web\",\n  \"title\": \"<string>\",\n  \"externalRef\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "agentId": "<string>",
  "source": "<string>",
  "externalRef": "<string>",
  "direct": true,
  "userId": "<string>",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

conversations

Start a conversation

curl --request POST \
  --url https://api.onecli.sh/v1/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "<string>",
  "source": "web",
  "title": "<string>",
  "externalRef": "<string>"
}
'

import requests

url = "https://api.onecli.sh/v1/conversations"

payload = {
    "agentId": "<string>",
    "source": "web",
    "title": "<string>",
    "externalRef": "<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({agentId: '<string>', source: 'web', title: '<string>', externalRef: '<string>'})
};

fetch('https://api.onecli.sh/v1/conversations', 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",
  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([
    'agentId' => '<string>',
    'source' => 'web',
    'title' => '<string>',
    'externalRef' => '<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"

	payload := strings.NewReader("{\n  \"agentId\": \"<string>\",\n  \"source\": \"web\",\n  \"title\": \"<string>\",\n  \"externalRef\": \"<string>\"\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agentId\": \"<string>\",\n  \"source\": \"web\",\n  \"title\": \"<string>\",\n  \"externalRef\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/conversations")

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  \"agentId\": \"<string>\",\n  \"source\": \"web\",\n  \"title\": \"<string>\",\n  \"externalRef\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "agentId": "<string>",
  "source": "<string>",
  "externalRef": "<string>",
  "direct": true,
  "userId": "<string>",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Opens a new shared thread with a hosted agent. Use it when you want a separate thread per task. For a private one-to-one thread, use the agent’s direct conversation instead. Related guide: Agent access: grant credentials to agents. Opens a new, non-direct conversation with a hosted agent. For a private thread with the agent use PUT /agents/{agentId}/conversations/direct instead.

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.

Body

application/json

agentId

string

required

source

enum<string>

default:web

Where the conversation is born. Defaults to web.

Available options:

web,

slack,

cron,

watch,

agent

title

string

Maximum string length: 200

externalRef

string

Your own reference for the thread.

Maximum string length: 500

Response

The conversation

string

agentId

string

source

string

Where the conversation was born: web, a channel provider (slack), cron, watch, or agent (an agent-to-agent pair).

externalRef

string | null

The provider-side thread reference for channel conversations.

direct

boolean

True for a person's private direct thread with the agent. Direct threads are visible only to their owner.

userId

string | null

The owner of a direct thread.

title

string | null

createdAt

string<date-time>

updatedAt

string<date-time>

Workspace

Organization

Enterprise

Platform

Start a conversation with a hosted agent

Authorizations

Body

Response