Run a scope
curl --request POST \
--url https://agent.getmodus.com/agent/v1/scopes/{id}/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"sessionId": "<string>",
"organizationId": "<string>",
"fileThreadId": "<string>",
"config": {
"model": "<string>",
"modelSettings": {
"contextWindow": 2
},
"contextSelections": [
{}
],
"connectionSelections": [
{}
],
"connectionSet": [
{}
],
"connectionAllModeIds": [
"<string>"
],
"guardrails": [
"<string>"
],
"toolset": {},
"strategies": [
"<string>"
],
"experimentalFeatures": true,
"debug": true,
"composerFileOffload": true
},
"attachments": {
"images": [
{
"data": "<string>",
"mimeType": "<string>",
"name": "<string>",
"s3Key": "<string>",
"uploadId": "<string>"
}
],
"documents": [
{
"fileName": "<string>",
"parsedContent": "<string>",
"uploadId": "<string>",
"mimeType": "<string>",
"originalSize": 123,
"storageFileName": "<string>",
"rawContentS3Key": "<string>",
"sizeBytes": 123,
"summary": "<string>"
}
]
},
"userContext": {
"email": "<string>",
"name": "<string>",
"timezone": "<string>",
"userId": "<string>"
},
"runId": "<string>",
"streamProtocolVersion": 2,
"experimentalFeatures": true,
"debug": true,
"subordinateSkillIds": [
123
]
}
'import requests
url = "https://agent.getmodus.com/agent/v1/scopes/{id}/runs"
payload = {
"message": "<string>",
"sessionId": "<string>",
"organizationId": "<string>",
"fileThreadId": "<string>",
"config": {
"model": "<string>",
"modelSettings": { "contextWindow": 2 },
"contextSelections": [{}],
"connectionSelections": [{}],
"connectionSet": [{}],
"connectionAllModeIds": ["<string>"],
"guardrails": ["<string>"],
"toolset": {},
"strategies": ["<string>"],
"experimentalFeatures": True,
"debug": True,
"composerFileOffload": True
},
"attachments": {
"images": [
{
"data": "<string>",
"mimeType": "<string>",
"name": "<string>",
"s3Key": "<string>",
"uploadId": "<string>"
}
],
"documents": [
{
"fileName": "<string>",
"parsedContent": "<string>",
"uploadId": "<string>",
"mimeType": "<string>",
"originalSize": 123,
"storageFileName": "<string>",
"rawContentS3Key": "<string>",
"sizeBytes": 123,
"summary": "<string>"
}
]
},
"userContext": {
"email": "<string>",
"name": "<string>",
"timezone": "<string>",
"userId": "<string>"
},
"runId": "<string>",
"streamProtocolVersion": 2,
"experimentalFeatures": True,
"debug": True,
"subordinateSkillIds": [123]
}
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>',
sessionId: '<string>',
organizationId: '<string>',
fileThreadId: '<string>',
config: {
model: '<string>',
modelSettings: {contextWindow: 2},
contextSelections: [{}],
connectionSelections: [{}],
connectionSet: [{}],
connectionAllModeIds: ['<string>'],
guardrails: ['<string>'],
toolset: {},
strategies: ['<string>'],
experimentalFeatures: true,
debug: true,
composerFileOffload: true
},
attachments: {
images: [
{
data: '<string>',
mimeType: '<string>',
name: '<string>',
s3Key: '<string>',
uploadId: '<string>'
}
],
documents: [
{
fileName: '<string>',
parsedContent: '<string>',
uploadId: '<string>',
mimeType: '<string>',
originalSize: 123,
storageFileName: '<string>',
rawContentS3Key: '<string>',
sizeBytes: 123,
summary: '<string>'
}
]
},
userContext: {email: '<string>', name: '<string>', timezone: '<string>', userId: '<string>'},
runId: '<string>',
streamProtocolVersion: 2,
experimentalFeatures: true,
debug: true,
subordinateSkillIds: [123]
})
};
fetch('https://agent.getmodus.com/agent/v1/scopes/{id}/runs', 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://agent.getmodus.com/agent/v1/scopes/{id}/runs",
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>',
'sessionId' => '<string>',
'organizationId' => '<string>',
'fileThreadId' => '<string>',
'config' => [
'model' => '<string>',
'modelSettings' => [
'contextWindow' => 2
],
'contextSelections' => [
[
]
],
'connectionSelections' => [
[
]
],
'connectionSet' => [
[
]
],
'connectionAllModeIds' => [
'<string>'
],
'guardrails' => [
'<string>'
],
'toolset' => [
],
'strategies' => [
'<string>'
],
'experimentalFeatures' => true,
'debug' => true,
'composerFileOffload' => true
],
'attachments' => [
'images' => [
[
'data' => '<string>',
'mimeType' => '<string>',
'name' => '<string>',
's3Key' => '<string>',
'uploadId' => '<string>'
]
],
'documents' => [
[
'fileName' => '<string>',
'parsedContent' => '<string>',
'uploadId' => '<string>',
'mimeType' => '<string>',
'originalSize' => 123,
'storageFileName' => '<string>',
'rawContentS3Key' => '<string>',
'sizeBytes' => 123,
'summary' => '<string>'
]
]
],
'userContext' => [
'email' => '<string>',
'name' => '<string>',
'timezone' => '<string>',
'userId' => '<string>'
],
'runId' => '<string>',
'streamProtocolVersion' => 2,
'experimentalFeatures' => true,
'debug' => true,
'subordinateSkillIds' => [
123
]
]),
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://agent.getmodus.com/agent/v1/scopes/{id}/runs"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"fileThreadId\": \"<string>\",\n \"config\": {\n \"model\": \"<string>\",\n \"modelSettings\": {\n \"contextWindow\": 2\n },\n \"contextSelections\": [\n {}\n ],\n \"connectionSelections\": [\n {}\n ],\n \"connectionSet\": [\n {}\n ],\n \"connectionAllModeIds\": [\n \"<string>\"\n ],\n \"guardrails\": [\n \"<string>\"\n ],\n \"toolset\": {},\n \"strategies\": [\n \"<string>\"\n ],\n \"experimentalFeatures\": true,\n \"debug\": true,\n \"composerFileOffload\": true\n },\n \"attachments\": {\n \"images\": [\n {\n \"data\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"name\": \"<string>\",\n \"s3Key\": \"<string>\",\n \"uploadId\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"fileName\": \"<string>\",\n \"parsedContent\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"originalSize\": 123,\n \"storageFileName\": \"<string>\",\n \"rawContentS3Key\": \"<string>\",\n \"sizeBytes\": 123,\n \"summary\": \"<string>\"\n }\n ]\n },\n \"userContext\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"userId\": \"<string>\"\n },\n \"runId\": \"<string>\",\n \"streamProtocolVersion\": 2,\n \"experimentalFeatures\": true,\n \"debug\": true,\n \"subordinateSkillIds\": [\n 123\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://agent.getmodus.com/agent/v1/scopes/{id}/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"fileThreadId\": \"<string>\",\n \"config\": {\n \"model\": \"<string>\",\n \"modelSettings\": {\n \"contextWindow\": 2\n },\n \"contextSelections\": [\n {}\n ],\n \"connectionSelections\": [\n {}\n ],\n \"connectionSet\": [\n {}\n ],\n \"connectionAllModeIds\": [\n \"<string>\"\n ],\n \"guardrails\": [\n \"<string>\"\n ],\n \"toolset\": {},\n \"strategies\": [\n \"<string>\"\n ],\n \"experimentalFeatures\": true,\n \"debug\": true,\n \"composerFileOffload\": true\n },\n \"attachments\": {\n \"images\": [\n {\n \"data\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"name\": \"<string>\",\n \"s3Key\": \"<string>\",\n \"uploadId\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"fileName\": \"<string>\",\n \"parsedContent\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"originalSize\": 123,\n \"storageFileName\": \"<string>\",\n \"rawContentS3Key\": \"<string>\",\n \"sizeBytes\": 123,\n \"summary\": \"<string>\"\n }\n ]\n },\n \"userContext\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"userId\": \"<string>\"\n },\n \"runId\": \"<string>\",\n \"streamProtocolVersion\": 2,\n \"experimentalFeatures\": true,\n \"debug\": true,\n \"subordinateSkillIds\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agent.getmodus.com/agent/v1/scopes/{id}/runs")
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 \"sessionId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"fileThreadId\": \"<string>\",\n \"config\": {\n \"model\": \"<string>\",\n \"modelSettings\": {\n \"contextWindow\": 2\n },\n \"contextSelections\": [\n {}\n ],\n \"connectionSelections\": [\n {}\n ],\n \"connectionSet\": [\n {}\n ],\n \"connectionAllModeIds\": [\n \"<string>\"\n ],\n \"guardrails\": [\n \"<string>\"\n ],\n \"toolset\": {},\n \"strategies\": [\n \"<string>\"\n ],\n \"experimentalFeatures\": true,\n \"debug\": true,\n \"composerFileOffload\": true\n },\n \"attachments\": {\n \"images\": [\n {\n \"data\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"name\": \"<string>\",\n \"s3Key\": \"<string>\",\n \"uploadId\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"fileName\": \"<string>\",\n \"parsedContent\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"originalSize\": 123,\n \"storageFileName\": \"<string>\",\n \"rawContentS3Key\": \"<string>\",\n \"sizeBytes\": 123,\n \"summary\": \"<string>\"\n }\n ]\n },\n \"userContext\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"userId\": \"<string>\"\n },\n \"runId\": \"<string>\",\n \"streamProtocolVersion\": 2,\n \"experimentalFeatures\": true,\n \"debug\": true,\n \"subordinateSkillIds\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body"<string>"{
"runId": "<string>",
"status": "<string>"
}Scopes · Runs
Run a scope
Starts a streaming run of a scope and returns Server-Sent Events. Send Accept: application/json for the polling transport.
Requires: scopes:invoke
POST
/
agent
/
v1
/
scopes
/
{id}
/
runs
Run a scope
curl --request POST \
--url https://agent.getmodus.com/agent/v1/scopes/{id}/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"sessionId": "<string>",
"organizationId": "<string>",
"fileThreadId": "<string>",
"config": {
"model": "<string>",
"modelSettings": {
"contextWindow": 2
},
"contextSelections": [
{}
],
"connectionSelections": [
{}
],
"connectionSet": [
{}
],
"connectionAllModeIds": [
"<string>"
],
"guardrails": [
"<string>"
],
"toolset": {},
"strategies": [
"<string>"
],
"experimentalFeatures": true,
"debug": true,
"composerFileOffload": true
},
"attachments": {
"images": [
{
"data": "<string>",
"mimeType": "<string>",
"name": "<string>",
"s3Key": "<string>",
"uploadId": "<string>"
}
],
"documents": [
{
"fileName": "<string>",
"parsedContent": "<string>",
"uploadId": "<string>",
"mimeType": "<string>",
"originalSize": 123,
"storageFileName": "<string>",
"rawContentS3Key": "<string>",
"sizeBytes": 123,
"summary": "<string>"
}
]
},
"userContext": {
"email": "<string>",
"name": "<string>",
"timezone": "<string>",
"userId": "<string>"
},
"runId": "<string>",
"streamProtocolVersion": 2,
"experimentalFeatures": true,
"debug": true,
"subordinateSkillIds": [
123
]
}
'import requests
url = "https://agent.getmodus.com/agent/v1/scopes/{id}/runs"
payload = {
"message": "<string>",
"sessionId": "<string>",
"organizationId": "<string>",
"fileThreadId": "<string>",
"config": {
"model": "<string>",
"modelSettings": { "contextWindow": 2 },
"contextSelections": [{}],
"connectionSelections": [{}],
"connectionSet": [{}],
"connectionAllModeIds": ["<string>"],
"guardrails": ["<string>"],
"toolset": {},
"strategies": ["<string>"],
"experimentalFeatures": True,
"debug": True,
"composerFileOffload": True
},
"attachments": {
"images": [
{
"data": "<string>",
"mimeType": "<string>",
"name": "<string>",
"s3Key": "<string>",
"uploadId": "<string>"
}
],
"documents": [
{
"fileName": "<string>",
"parsedContent": "<string>",
"uploadId": "<string>",
"mimeType": "<string>",
"originalSize": 123,
"storageFileName": "<string>",
"rawContentS3Key": "<string>",
"sizeBytes": 123,
"summary": "<string>"
}
]
},
"userContext": {
"email": "<string>",
"name": "<string>",
"timezone": "<string>",
"userId": "<string>"
},
"runId": "<string>",
"streamProtocolVersion": 2,
"experimentalFeatures": True,
"debug": True,
"subordinateSkillIds": [123]
}
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>',
sessionId: '<string>',
organizationId: '<string>',
fileThreadId: '<string>',
config: {
model: '<string>',
modelSettings: {contextWindow: 2},
contextSelections: [{}],
connectionSelections: [{}],
connectionSet: [{}],
connectionAllModeIds: ['<string>'],
guardrails: ['<string>'],
toolset: {},
strategies: ['<string>'],
experimentalFeatures: true,
debug: true,
composerFileOffload: true
},
attachments: {
images: [
{
data: '<string>',
mimeType: '<string>',
name: '<string>',
s3Key: '<string>',
uploadId: '<string>'
}
],
documents: [
{
fileName: '<string>',
parsedContent: '<string>',
uploadId: '<string>',
mimeType: '<string>',
originalSize: 123,
storageFileName: '<string>',
rawContentS3Key: '<string>',
sizeBytes: 123,
summary: '<string>'
}
]
},
userContext: {email: '<string>', name: '<string>', timezone: '<string>', userId: '<string>'},
runId: '<string>',
streamProtocolVersion: 2,
experimentalFeatures: true,
debug: true,
subordinateSkillIds: [123]
})
};
fetch('https://agent.getmodus.com/agent/v1/scopes/{id}/runs', 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://agent.getmodus.com/agent/v1/scopes/{id}/runs",
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>',
'sessionId' => '<string>',
'organizationId' => '<string>',
'fileThreadId' => '<string>',
'config' => [
'model' => '<string>',
'modelSettings' => [
'contextWindow' => 2
],
'contextSelections' => [
[
]
],
'connectionSelections' => [
[
]
],
'connectionSet' => [
[
]
],
'connectionAllModeIds' => [
'<string>'
],
'guardrails' => [
'<string>'
],
'toolset' => [
],
'strategies' => [
'<string>'
],
'experimentalFeatures' => true,
'debug' => true,
'composerFileOffload' => true
],
'attachments' => [
'images' => [
[
'data' => '<string>',
'mimeType' => '<string>',
'name' => '<string>',
's3Key' => '<string>',
'uploadId' => '<string>'
]
],
'documents' => [
[
'fileName' => '<string>',
'parsedContent' => '<string>',
'uploadId' => '<string>',
'mimeType' => '<string>',
'originalSize' => 123,
'storageFileName' => '<string>',
'rawContentS3Key' => '<string>',
'sizeBytes' => 123,
'summary' => '<string>'
]
]
],
'userContext' => [
'email' => '<string>',
'name' => '<string>',
'timezone' => '<string>',
'userId' => '<string>'
],
'runId' => '<string>',
'streamProtocolVersion' => 2,
'experimentalFeatures' => true,
'debug' => true,
'subordinateSkillIds' => [
123
]
]),
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://agent.getmodus.com/agent/v1/scopes/{id}/runs"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"fileThreadId\": \"<string>\",\n \"config\": {\n \"model\": \"<string>\",\n \"modelSettings\": {\n \"contextWindow\": 2\n },\n \"contextSelections\": [\n {}\n ],\n \"connectionSelections\": [\n {}\n ],\n \"connectionSet\": [\n {}\n ],\n \"connectionAllModeIds\": [\n \"<string>\"\n ],\n \"guardrails\": [\n \"<string>\"\n ],\n \"toolset\": {},\n \"strategies\": [\n \"<string>\"\n ],\n \"experimentalFeatures\": true,\n \"debug\": true,\n \"composerFileOffload\": true\n },\n \"attachments\": {\n \"images\": [\n {\n \"data\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"name\": \"<string>\",\n \"s3Key\": \"<string>\",\n \"uploadId\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"fileName\": \"<string>\",\n \"parsedContent\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"originalSize\": 123,\n \"storageFileName\": \"<string>\",\n \"rawContentS3Key\": \"<string>\",\n \"sizeBytes\": 123,\n \"summary\": \"<string>\"\n }\n ]\n },\n \"userContext\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"userId\": \"<string>\"\n },\n \"runId\": \"<string>\",\n \"streamProtocolVersion\": 2,\n \"experimentalFeatures\": true,\n \"debug\": true,\n \"subordinateSkillIds\": [\n 123\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://agent.getmodus.com/agent/v1/scopes/{id}/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"fileThreadId\": \"<string>\",\n \"config\": {\n \"model\": \"<string>\",\n \"modelSettings\": {\n \"contextWindow\": 2\n },\n \"contextSelections\": [\n {}\n ],\n \"connectionSelections\": [\n {}\n ],\n \"connectionSet\": [\n {}\n ],\n \"connectionAllModeIds\": [\n \"<string>\"\n ],\n \"guardrails\": [\n \"<string>\"\n ],\n \"toolset\": {},\n \"strategies\": [\n \"<string>\"\n ],\n \"experimentalFeatures\": true,\n \"debug\": true,\n \"composerFileOffload\": true\n },\n \"attachments\": {\n \"images\": [\n {\n \"data\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"name\": \"<string>\",\n \"s3Key\": \"<string>\",\n \"uploadId\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"fileName\": \"<string>\",\n \"parsedContent\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"originalSize\": 123,\n \"storageFileName\": \"<string>\",\n \"rawContentS3Key\": \"<string>\",\n \"sizeBytes\": 123,\n \"summary\": \"<string>\"\n }\n ]\n },\n \"userContext\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"userId\": \"<string>\"\n },\n \"runId\": \"<string>\",\n \"streamProtocolVersion\": 2,\n \"experimentalFeatures\": true,\n \"debug\": true,\n \"subordinateSkillIds\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agent.getmodus.com/agent/v1/scopes/{id}/runs")
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 \"sessionId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"fileThreadId\": \"<string>\",\n \"config\": {\n \"model\": \"<string>\",\n \"modelSettings\": {\n \"contextWindow\": 2\n },\n \"contextSelections\": [\n {}\n ],\n \"connectionSelections\": [\n {}\n ],\n \"connectionSet\": [\n {}\n ],\n \"connectionAllModeIds\": [\n \"<string>\"\n ],\n \"guardrails\": [\n \"<string>\"\n ],\n \"toolset\": {},\n \"strategies\": [\n \"<string>\"\n ],\n \"experimentalFeatures\": true,\n \"debug\": true,\n \"composerFileOffload\": true\n },\n \"attachments\": {\n \"images\": [\n {\n \"data\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"name\": \"<string>\",\n \"s3Key\": \"<string>\",\n \"uploadId\": \"<string>\"\n }\n ],\n \"documents\": [\n {\n \"fileName\": \"<string>\",\n \"parsedContent\": \"<string>\",\n \"uploadId\": \"<string>\",\n \"mimeType\": \"<string>\",\n \"originalSize\": 123,\n \"storageFileName\": \"<string>\",\n \"rawContentS3Key\": \"<string>\",\n \"sizeBytes\": 123,\n \"summary\": \"<string>\"\n }\n ]\n },\n \"userContext\": {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"timezone\": \"<string>\",\n \"userId\": \"<string>\"\n },\n \"runId\": \"<string>\",\n \"streamProtocolVersion\": 2,\n \"experimentalFeatures\": true,\n \"debug\": true,\n \"subordinateSkillIds\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body"<string>"{
"runId": "<string>",
"status": "<string>"
}Authorizations
A Modus personal access token (modus_<orgUuid>_<prefix>_<secret>) or an OAuth 2.1 access token, sent as Authorization: Bearer <token>.
Path Parameters
Scope id.
Body
application/json
The user message to send.
Opaque client-generated conversation token for continuity. The server NEVER derives the run target identity (scope/workflow/modus) from this string — target identity comes only from the request path and DTO (see RunTarget). It is used solely to thread successive turns of the same conversation together.
Organization id. Ignored for authenticated callers — the server uses the principal's org.
Saved version to run (scope/workflow; ignored for Modus).
Available options:
published, draft Document-scoped conversation thread id.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Origin of the run.
Available options:
home, agent_settings, agent, api, modus_api, mcp, slack, slack_dm, teams, context_chat, other Client-supplied run id (Idempotency-Key header wins).
Streaming protocol version. Version 2 supports assistant-content replacement events.
Available options:
2 Subordinate scope ids for an unsaved supervisor-scope draft test.
Response
SSE stream of run events.
The response is of type string.
⌘I