Upload a file attachment to a conversation

Upload an attachment

curl --request POST \
  --url https://api.onecli.sh/v1/conversations/{conversationId}/attachments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/octet-stream' \
  --data '<string>'

import requests

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

payload = "<string>"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/octet-stream"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/octet-stream'},
  body: '<string>'
};

fetch('https://api.onecli.sh/v1/conversations/{conversationId}/attachments', 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}/attachments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "<string>",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/octet-stream"
  ],
]);

$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}/attachments"

	payload := strings.NewReader("<string>")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/octet-stream")

	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}/attachments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/octet-stream")
  .body("<string>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/conversations/{conversationId}/attachments")

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/octet-stream'
request.body = "<string>"

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

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

attachments

Upload an attachment

curl --request POST \
  --url https://api.onecli.sh/v1/conversations/{conversationId}/attachments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/octet-stream' \
  --data '<string>'

import requests

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

payload = "<string>"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/octet-stream"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/octet-stream'},
  body: '<string>'
};

fetch('https://api.onecli.sh/v1/conversations/{conversationId}/attachments', 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}/attachments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "<string>",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/octet-stream"
  ],
]);

$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}/attachments"

	payload := strings.NewReader("<string>")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/octet-stream")

	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}/attachments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/octet-stream")
  .body("<string>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/conversations/{conversationId}/attachments")

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/octet-stream'
request.body = "<string>"

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

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

Stages a file for a message. Use it to hand the agent a document, image, or data file, then reference the attachment in the message you send next. Related guide: Agent access: grant credentials to agents. Stages one file for a message. Raw bytes in the body with the file’s own Content-Type; name it with ?name=. Capped at 10 MB. The attachment stays pending until a message references it in attachmentIds; unbound attachments are swept after 24 hours.

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

Query Parameters

name

string

required

The file name.

Body

application/octet-stream

The body is of type file.

Response

The staged attachment

string

name

string

mimeType

string

sizeBytes

integer

status

string

pending until a message binds the attachment; bound attachments carry the message's lifecycle.

direction

enum<string>

inbound = the person's message; outbound = the agent's reply.

Available options:

inbound,

outbound

caption

string | null

createdAt

string<date-time>

Workspace

Organization

Enterprise

Platform

Upload a file attachment to a conversation

Authorizations

Path Parameters

Query Parameters

Body

Response