Add a message to a session

Adds a user message and optionally waits for agent completion. Supports text, images, and file attachments. This feature is enabled for selected organizations only.

POST /api/v0/sessions/{sessionId}/messages

Add a message to a session

cURL

curl --request POST \
  --url https://api.factory.ai/api/v0/sessions/{sessionId}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "images": [
    {
      "type": "base64",
      "data": "<string>"
    }
  ],
  "files": [
    {
      "type": "base64",
      "mediaType": "application/pdf",
      "data": "<string>",
      "parsedData": "<string>",
      "name": "<string>",
      "path": "<string>"
    }
  ],
  "computerId": "<string>"
}
'

import requests

url = "https://api.factory.ai/api/v0/sessions/{sessionId}/messages"

payload = {
    "text": "<string>",
    "images": [
        {
            "type": "base64",
            "data": "<string>"
        }
    ],
    "files": [
        {
            "type": "base64",
            "mediaType": "application/pdf",
            "data": "<string>",
            "parsedData": "<string>",
            "name": "<string>",
            "path": "<string>"
        }
    ],
    "computerId": "<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({
    text: '<string>',
    images: [{type: 'base64', data: '<string>'}],
    files: [
      {
        type: 'base64',
        mediaType: 'application/pdf',
        data: '<string>',
        parsedData: '<string>',
        name: '<string>',
        path: '<string>'
      }
    ],
    computerId: '<string>'
  })
};

fetch('https://api.factory.ai/api/v0/sessions/{sessionId}/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.factory.ai/api/v0/sessions/{sessionId}/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([
    'text' => '<string>',
    'images' => [
        [
                'type' => 'base64',
                'data' => '<string>'
        ]
    ],
    'files' => [
        [
                'type' => 'base64',
                'mediaType' => 'application/pdf',
                'data' => '<string>',
                'parsedData' => '<string>',
                'name' => '<string>',
                'path' => '<string>'
        ]
    ],
    'computerId' => '<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.factory.ai/api/v0/sessions/{sessionId}/messages"

	payload := strings.NewReader("{\n  \"text\": \"<string>\",\n  \"images\": [\n    {\n      \"type\": \"base64\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"files\": [\n    {\n      \"type\": \"base64\",\n      \"mediaType\": \"application/pdf\",\n      \"data\": \"<string>\",\n      \"parsedData\": \"<string>\",\n      \"name\": \"<string>\",\n      \"path\": \"<string>\"\n    }\n  ],\n  \"computerId\": \"<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.factory.ai/api/v0/sessions/{sessionId}/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"<string>\",\n  \"images\": [\n    {\n      \"type\": \"base64\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"files\": [\n    {\n      \"type\": \"base64\",\n      \"mediaType\": \"application/pdf\",\n      \"data\": \"<string>\",\n      \"parsedData\": \"<string>\",\n      \"name\": \"<string>\",\n      \"path\": \"<string>\"\n    }\n  ],\n  \"computerId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.factory.ai/api/v0/sessions/{sessionId}/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  \"text\": \"<string>\",\n  \"images\": [\n    {\n      \"type\": \"base64\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"files\": [\n    {\n      \"type\": \"base64\",\n      \"mediaType\": \"application/pdf\",\n      \"data\": \"<string>\",\n      \"parsedData\": \"<string>\",\n      \"name\": \"<string>\",\n      \"path\": \"<string>\"\n    }\n  ],\n  \"computerId\": \"<string>\"\n}"

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

200

{
  "messageId": "<string>"
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

Authorizations

Authorization · string · header · required

Factory API key or JWT token for authentication

Path Parameters

sessionId · string · required

Body

application/json

text · string · required

Message text content

images · object[]

Optional base64-encoded images

Show child attributes

files · object[]

Optional file attachments (PDFs, text files)

Option 1

Option 2

Show child attributes

computerId · string

Computer ID to route the message to; falls back to the session.computerId if omitted

Response

200

application/json

Response for status 200

messageId · string · required

ID of the created user message

status · enum<string> · required

Agent status after message submission

Available options: idle, pending, running