Send message

Durably admit one session input and schedule agent-loop execution unless resume is false.

POST /api/session/{sessionID}/prompt

Send message

cURL

curl --request POST \
  --url https://api.example.com/api/session/{sessionID}/prompt \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": {
    "text": "<string>",
    "files": [
      {
        "uri": "<string>",
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "agents": [
      {
        "name": "<string>"
      }
    ]
  },
  "id": "<string>",
  "resume": true
}
'

import requests

url = "https://api.example.com/api/session/{sessionID}/prompt"

payload = {
    "prompt": {
        "text": "<string>",
        "files": [
            {
                "uri": "<string>",
                "name": "<string>",
                "description": "<string>"
            }
        ],
        "agents": [{ "name": "<string>" }]
    },
    "id": "<string>",
    "resume": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompt: {
      text: '<string>',
      files: [{uri: '<string>', name: '<string>', description: '<string>'}],
      agents: [{name: '<string>'}]
    },
    id: '<string>',
    resume: true
  })
};

fetch('https://api.example.com/api/session/{sessionID}/prompt', 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/session/{sessionID}/prompt",
  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([
    'prompt' => [
        'text' => '<string>',
        'files' => [
                [
                                'uri' => '<string>',
                                'name' => '<string>',
                                'description' => '<string>'
                ]
        ],
        'agents' => [
                [
                                'name' => '<string>'
                ]
        ]
    ],
    'id' => '<string>',
    'resume' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "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/session/{sessionID}/prompt"

	payload := strings.NewReader("{\n  \"prompt\": {\n    \"text\": \"<string>\",\n    \"files\": [\n      {\n        \"uri\": \"<string>\",\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"agents\": [\n      {\n        \"name\": \"<string>\"\n      }\n    ]\n  },\n  \"id\": \"<string>\",\n  \"resume\": true\n}")

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

	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/session/{sessionID}/prompt")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": {\n    \"text\": \"<string>\",\n    \"files\": [\n      {\n        \"uri\": \"<string>\",\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"agents\": [\n      {\n        \"name\": \"<string>\"\n      }\n    ]\n  },\n  \"id\": \"<string>\",\n  \"resume\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/session/{sessionID}/prompt")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": {\n    \"text\": \"<string>\",\n    \"files\": [\n      {\n        \"uri\": \"<string>\",\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"agents\": [\n      {\n        \"name\": \"<string>\"\n      }\n    ]\n  },\n  \"id\": \"<string>\",\n  \"resume\": true\n}"

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

200

{
  "data": {
    "admittedSeq": 1,
    "id": "<string>",
    "sessionID": "<string>",
    "prompt": {
      "text": "<string>",
      "files": [
        {
          "data": "<string>",
          "mime": "<string>",
          "source": {
            "type": "inline"
          },
          "name": "<string>",
          "description": "<string>",
          "mention": {
            "start": 123,
            "end": 123,
            "text": "<string>"
          }
        }
      ],
      "agents": [
        {
          "name": "<string>",
          "mention": {
            "start": 123,
            "end": 123,
            "text": "<string>"
          }
        }
      ]
    },
    "timeCreated": 123,
    "promotedSeq": 1
  }
}

{
  "_tag": "InvalidRequestError",
  "message": "<string>",
  "kind": "<string>",
  "field": "<string>"
}

{
  "_tag": "UnauthorizedError",
  "message": "<string>"
}

{
  "_tag": "SessionNotFoundError",
  "sessionID": "<string>",
  "message": "<string>"
}

{
  "_tag": "ConflictError",
  "message": "<string>",
  "resource": "<string>"
}

Path Parameters

sessionID · string · required

Pattern: ^ses

Body

application/json

prompt · object · required

Show child attributes

id · string | null

Pattern: ^msg_

delivery · enum<string> | null

Available options: steer, queue

resume · boolean | null

Response

200

application/json

Success

data · object · required

Show child attributes