Submit To Assistant

curl --request POST \
  --url https://api.example.com/agents/submit-to-assistant/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_name": "<string>",
  "new_message": "<string>",
  "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "client_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversation_ctx": {
    "entities": [],
    "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "current_directory": "<string>",
    "workspace_ref": "<string>",
    "visible_items": [],
    "selected_names": []
  },
  "image_urls": [
    "<string>"
  ],
  "effort": "<string>",
  "selected_components": [
    {
      "dashboard_id": "<string>",
      "element": "<string>",
      "base_version_id": "<string>",
      "text_head": "<string>",
      "from_line": 123,
      "to_line": 123,
      "query": "<string>",
      "query_is_draft": false
    }
  ],
  "existing_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mode": "auto"
}
'

import requests

url = "https://api.example.com/agents/submit-to-assistant/"

payload = {
    "assistant_name": "<string>",
    "new_message": "<string>",
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "client_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "conversation_ctx": {
        "entities": [],
        "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "current_directory": "<string>",
        "workspace_ref": "<string>",
        "visible_items": [],
        "selected_names": []
    },
    "image_urls": ["<string>"],
    "effort": "<string>",
    "selected_components": [
        {
            "dashboard_id": "<string>",
            "element": "<string>",
            "base_version_id": "<string>",
            "text_head": "<string>",
            "from_line": 123,
            "to_line": 123,
            "query": "<string>",
            "query_is_draft": False
        }
    ],
    "existing_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mode": "auto"
}
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({
    assistant_name: '<string>',
    new_message: '<string>',
    conversation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    client_message_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    conversation_ctx: {
      entities: [],
      folder_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      current_directory: '<string>',
      workspace_ref: '<string>',
      visible_items: [],
      selected_names: []
    },
    image_urls: ['<string>'],
    effort: '<string>',
    selected_components: [
      {
        dashboard_id: '<string>',
        element: '<string>',
        base_version_id: '<string>',
        text_head: '<string>',
        from_line: 123,
        to_line: 123,
        query: '<string>',
        query_is_draft: false
      }
    ],
    existing_message_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    mode: 'auto'
  })
};

fetch('https://api.example.com/agents/submit-to-assistant/', 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/agents/submit-to-assistant/",
  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([
    'assistant_name' => '<string>',
    'new_message' => '<string>',
    'conversation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'client_message_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'conversation_ctx' => [
        'entities' => [
                
        ],
        'folder_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'current_directory' => '<string>',
        'workspace_ref' => '<string>',
        'visible_items' => [
                
        ],
        'selected_names' => [
                
        ]
    ],
    'image_urls' => [
        '<string>'
    ],
    'effort' => '<string>',
    'selected_components' => [
        [
                'dashboard_id' => '<string>',
                'element' => '<string>',
                'base_version_id' => '<string>',
                'text_head' => '<string>',
                'from_line' => 123,
                'to_line' => 123,
                'query' => '<string>',
                'query_is_draft' => false
        ]
    ],
    'existing_message_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'mode' => 'auto'
  ]),
  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.example.com/agents/submit-to-assistant/"

	payload := strings.NewReader("{\n  \"assistant_name\": \"<string>\",\n  \"new_message\": \"<string>\",\n  \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"client_message_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"conversation_ctx\": {\n    \"entities\": [],\n    \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"current_directory\": \"<string>\",\n    \"workspace_ref\": \"<string>\",\n    \"visible_items\": [],\n    \"selected_names\": []\n  },\n  \"image_urls\": [\n    \"<string>\"\n  ],\n  \"effort\": \"<string>\",\n  \"selected_components\": [\n    {\n      \"dashboard_id\": \"<string>\",\n      \"element\": \"<string>\",\n      \"base_version_id\": \"<string>\",\n      \"text_head\": \"<string>\",\n      \"from_line\": 123,\n      \"to_line\": 123,\n      \"query\": \"<string>\",\n      \"query_is_draft\": false\n    }\n  ],\n  \"existing_message_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"mode\": \"auto\"\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.example.com/agents/submit-to-assistant/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"assistant_name\": \"<string>\",\n  \"new_message\": \"<string>\",\n  \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"client_message_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"conversation_ctx\": {\n    \"entities\": [],\n    \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"current_directory\": \"<string>\",\n    \"workspace_ref\": \"<string>\",\n    \"visible_items\": [],\n    \"selected_names\": []\n  },\n  \"image_urls\": [\n    \"<string>\"\n  ],\n  \"effort\": \"<string>\",\n  \"selected_components\": [\n    {\n      \"dashboard_id\": \"<string>\",\n      \"element\": \"<string>\",\n      \"base_version_id\": \"<string>\",\n      \"text_head\": \"<string>\",\n      \"from_line\": 123,\n      \"to_line\": 123,\n      \"query\": \"<string>\",\n      \"query_is_draft\": false\n    }\n  ],\n  \"existing_message_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"mode\": \"auto\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/submit-to-assistant/")

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  \"assistant_name\": \"<string>\",\n  \"new_message\": \"<string>\",\n  \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"client_message_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"conversation_ctx\": {\n    \"entities\": [],\n    \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"current_directory\": \"<string>\",\n    \"workspace_ref\": \"<string>\",\n    \"visible_items\": [],\n    \"selected_names\": []\n  },\n  \"image_urls\": [\n    \"<string>\"\n  ],\n  \"effort\": \"<string>\",\n  \"selected_components\": [\n    {\n      \"dashboard_id\": \"<string>\",\n      \"element\": \"<string>\",\n      \"base_version_id\": \"<string>\",\n      \"text_head\": \"<string>\",\n      \"from_line\": 123,\n      \"to_line\": 123,\n      \"query\": \"<string>\",\n      \"query_is_draft\": false\n    }\n  ],\n  \"existing_message_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"mode\": \"auto\"\n}"

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

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

agents

submit-to-assistant

Submit To Assistant

curl --request POST \
  --url https://api.example.com/agents/submit-to-assistant/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_name": "<string>",
  "new_message": "<string>",
  "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "client_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversation_ctx": {
    "entities": [],
    "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "current_directory": "<string>",
    "workspace_ref": "<string>",
    "visible_items": [],
    "selected_names": []
  },
  "image_urls": [
    "<string>"
  ],
  "effort": "<string>",
  "selected_components": [
    {
      "dashboard_id": "<string>",
      "element": "<string>",
      "base_version_id": "<string>",
      "text_head": "<string>",
      "from_line": 123,
      "to_line": 123,
      "query": "<string>",
      "query_is_draft": false
    }
  ],
  "existing_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mode": "auto"
}
'

import requests

url = "https://api.example.com/agents/submit-to-assistant/"

payload = {
    "assistant_name": "<string>",
    "new_message": "<string>",
    "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "client_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "conversation_ctx": {
        "entities": [],
        "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "current_directory": "<string>",
        "workspace_ref": "<string>",
        "visible_items": [],
        "selected_names": []
    },
    "image_urls": ["<string>"],
    "effort": "<string>",
    "selected_components": [
        {
            "dashboard_id": "<string>",
            "element": "<string>",
            "base_version_id": "<string>",
            "text_head": "<string>",
            "from_line": 123,
            "to_line": 123,
            "query": "<string>",
            "query_is_draft": False
        }
    ],
    "existing_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mode": "auto"
}
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({
    assistant_name: '<string>',
    new_message: '<string>',
    conversation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    client_message_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    conversation_ctx: {
      entities: [],
      folder_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      current_directory: '<string>',
      workspace_ref: '<string>',
      visible_items: [],
      selected_names: []
    },
    image_urls: ['<string>'],
    effort: '<string>',
    selected_components: [
      {
        dashboard_id: '<string>',
        element: '<string>',
        base_version_id: '<string>',
        text_head: '<string>',
        from_line: 123,
        to_line: 123,
        query: '<string>',
        query_is_draft: false
      }
    ],
    existing_message_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    mode: 'auto'
  })
};

fetch('https://api.example.com/agents/submit-to-assistant/', 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/agents/submit-to-assistant/",
  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([
    'assistant_name' => '<string>',
    'new_message' => '<string>',
    'conversation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'client_message_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'conversation_ctx' => [
        'entities' => [
                
        ],
        'folder_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'current_directory' => '<string>',
        'workspace_ref' => '<string>',
        'visible_items' => [
                
        ],
        'selected_names' => [
                
        ]
    ],
    'image_urls' => [
        '<string>'
    ],
    'effort' => '<string>',
    'selected_components' => [
        [
                'dashboard_id' => '<string>',
                'element' => '<string>',
                'base_version_id' => '<string>',
                'text_head' => '<string>',
                'from_line' => 123,
                'to_line' => 123,
                'query' => '<string>',
                'query_is_draft' => false
        ]
    ],
    'existing_message_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'mode' => 'auto'
  ]),
  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.example.com/agents/submit-to-assistant/"

	payload := strings.NewReader("{\n  \"assistant_name\": \"<string>\",\n  \"new_message\": \"<string>\",\n  \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"client_message_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"conversation_ctx\": {\n    \"entities\": [],\n    \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"current_directory\": \"<string>\",\n    \"workspace_ref\": \"<string>\",\n    \"visible_items\": [],\n    \"selected_names\": []\n  },\n  \"image_urls\": [\n    \"<string>\"\n  ],\n  \"effort\": \"<string>\",\n  \"selected_components\": [\n    {\n      \"dashboard_id\": \"<string>\",\n      \"element\": \"<string>\",\n      \"base_version_id\": \"<string>\",\n      \"text_head\": \"<string>\",\n      \"from_line\": 123,\n      \"to_line\": 123,\n      \"query\": \"<string>\",\n      \"query_is_draft\": false\n    }\n  ],\n  \"existing_message_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"mode\": \"auto\"\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.example.com/agents/submit-to-assistant/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"assistant_name\": \"<string>\",\n  \"new_message\": \"<string>\",\n  \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"client_message_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"conversation_ctx\": {\n    \"entities\": [],\n    \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"current_directory\": \"<string>\",\n    \"workspace_ref\": \"<string>\",\n    \"visible_items\": [],\n    \"selected_names\": []\n  },\n  \"image_urls\": [\n    \"<string>\"\n  ],\n  \"effort\": \"<string>\",\n  \"selected_components\": [\n    {\n      \"dashboard_id\": \"<string>\",\n      \"element\": \"<string>\",\n      \"base_version_id\": \"<string>\",\n      \"text_head\": \"<string>\",\n      \"from_line\": 123,\n      \"to_line\": 123,\n      \"query\": \"<string>\",\n      \"query_is_draft\": false\n    }\n  ],\n  \"existing_message_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"mode\": \"auto\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/agents/submit-to-assistant/")

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  \"assistant_name\": \"<string>\",\n  \"new_message\": \"<string>\",\n  \"conversation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"client_message_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"conversation_ctx\": {\n    \"entities\": [],\n    \"folder_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"current_directory\": \"<string>\",\n    \"workspace_ref\": \"<string>\",\n    \"visible_items\": [],\n    \"selected_names\": []\n  },\n  \"image_urls\": [\n    \"<string>\"\n  ],\n  \"effort\": \"<string>\",\n  \"selected_components\": [\n    {\n      \"dashboard_id\": \"<string>\",\n      \"element\": \"<string>\",\n      \"base_version_id\": \"<string>\",\n      \"text_head\": \"<string>\",\n      \"from_line\": 123,\n      \"to_line\": 123,\n      \"query\": \"<string>\",\n      \"query_is_draft\": false\n    }\n  ],\n  \"existing_message_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"mode\": \"auto\"\n}"

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

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Api-key

string | null

Body

application/json

assistant_name

string

required

new_message

string

required

conversation_id

string<uuid>

required

client_message_id

string<uuid>

required

conversation_ctx

ConversationContext · object | null

Show child attributes

image_urls

string[] | null

model

enum<string> | null

Available options:

truestate,

gemini-embedding-001,

gemini-2.0-flash,

gemini-2.5-flash,

gemini-2.5-flash-lite,

gemini-2.5-pro,

gemini-3-pro-preview,

gemini-3-flash-preview,

gemini-3.5-flash,

gemini-3.5-flash-lite,

gemini-3.7-flash,

gpt-4.1,

gpt-realtime-2.1,

gpt-realtime-2.1-mini,

gpt-realtime,

gpt-4o-mini-transcribe,

gpt-5-2025-08-07,

gpt-5-mini-2025-08-07,

gpt-5-nano-2025-08-07,

gpt-5.1-2025-11-13,

gpt-5.2-2025-12-11,

gpt-5.5,

gpt-5.4,

gpt-5.4-mini,

gpt-5.6-sol,

gpt-5.6-terra,

gpt-5.6-luna,

o4-mini-2025-04-16,

claude-3-5-sonnet-latest,

claude-3-5-haiku-latest,

claude-opus-4-8,

claude-opus-4-7,

claude-sonnet-5,

claude-fable-5,

claude-haiku-4-5,

grok-beta,

grok-3,

grok-3-mini,

grok-4,

grok-4.5,

z-ai/glm-5.2,

moonshotai/kimi-k2-instruct-0905,

openai/gpt-oss-120b,

whisper-1

effort

string | null

selected_components

SelectedComponent · object[] | null

Show child attributes

existing_message_id

string<uuid> | null

mode

enum<string>

default:auto

Available options:

auto,

replace

Response

Successful Response

The response is of type Response Submit To Assistant Agents Submit To Assistant Post · object.