Add Agent
curl --request POST \
--url https://api.example.com/v1/agents \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"image_url": "<string>",
"visible": true,
"author_name": "<string>",
"definition": {
"pii_banner": "",
"pii_info": "",
"pii_lock": false,
"pii_anonimization": [
{
"value": "PERSON",
"label": "Name"
},
{
"value": "EMAIL_ADDRESS",
"label": "Email"
},
{
"value": "PHONE_NUMBER",
"label": "Phone Number"
},
{
"value": "CREDIT_CARD",
"label": "Credit Card"
}
],
"divider1": "",
"guardrail_info": "",
"guardrail_lock": false,
"guardrail_latency_banner": "",
"violence_and_hate": {
"value": "Off",
"context": ""
},
"sexual_content": {
"value": "Off",
"context": ""
},
"guns_and_weapons": {
"value": "Off",
"context": ""
},
"suicide": {
"value": "Off",
"context": ""
},
"crime": {
"value": "Off",
"context": ""
},
"toxicity": {
"value": "Off",
"context": ""
},
"bias": {
"value": "Off",
"context": ""
},
"profanity": {
"value": "Off",
"context": ""
},
"guardrails_scan_output": false,
"guardrails_output_mode": "post_stream",
"divider2": "",
"guardrail_action": {
"value": "fail",
"label": "Fail/block run"
},
"guardrail_action_replace": "",
"guardrail_action_human": "",
"block_after_violations": 0,
"block_message": "This conversation has been locked due to repeated safety violations. Please start a new conversation.",
"divider3": "",
"prompt_defense": "",
"prompt_lock": false,
"jailbreak": false,
"prompt_injection": false,
"context_leak": false,
"auto_model_pick": false,
"auto_model_preference": "cost",
"model": [
"preset:cost"
],
"parameter_preset": "default",
"intro": "",
"basic_params_section": "",
"max_tokens": 64000,
"temperature": 0.7,
"top_p": 1,
"top_k": 40,
"timeout": 120,
"divider_7": "",
"penalty_section": "",
"presence_penalty": 0.3,
"frequency_penalty": 0.6,
"stop_sequences": [],
"divider_8": "",
"reasoning_section": "",
"enable_reasoning": true,
"reasoning_effort": "Low",
"divider": "",
"reliability_section": "",
"max_retries_per_model": 3,
"retry_on_status_codes": [
429,
500,
502,
503,
504
],
"datacenter_fallback": true,
"exclude_user_identity_from_prompt": false,
"enable_prompt_caching": true,
"protect_instructions_in_preview": false,
"usage_limits_section": "",
"usage_limits_maximum_request": 1000,
"usage_limits_maximum_tokens": 2000000,
"usage_limits_max_messages": 100,
"usage_limits_agent_timeout": 120,
"divider_11": "",
"compaction_enabled": true,
"compaction_strategy": "auto",
"compaction_threshold": 0.75,
"compaction_tool_enabled": false,
"tool_calling_section": "",
"parallel_tool_calls": true,
"tool_timeout": 15,
"visuals_section": "",
"hide_reasoning": false,
"group_into_chain_of_thought": true,
"chain_of_thought_final_answer_only": false,
"hide_workflow_progress": false,
"hide_error_banners": true,
"tool_display_preset": "execution",
"minimal_caret_only": true,
"message_footer_enabled": false,
"message_footer": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"minimal_tool_message": "Thinking...",
"citation_style": "text",
"deduplicate_sources_by_url": false,
"omit_citation_quotes": false,
"show_source_images": false,
"chat_input_placeholder": "Ask me anything...",
"divider_visuals": "",
"transport_show_tool_calls": false,
"transport_show_sources": true,
"transport_show_thinking": false,
"transport_allow_noop": false,
"transport_thinking_text": "",
"conversation_title_section": "",
"agent_title_mode": "generate",
"agent_title_prompt": "",
"divider_conversation_title": "",
"feedback_section": "",
"feedback_placeholder": "Add details (optional)",
"feedback_submit_label": "Submit",
"feedback_cancel_label": "Cancel",
"capability_versions": {},
"is_coworker": true,
"preset_selector": "<string>",
"languages": [],
"default_language": "<string>",
"persona": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tone": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"extra_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tools": [],
"workflows_parallel_enabled": false,
"mcp_servers": [],
"convert_unsupported_files_to_text": true,
"skills": [],
"subagents_enabled": false,
"subagents": [],
"guidelines_enabled": false,
"guidelines": [],
"glossary": [],
"memories": [],
"hidden_tools": [
"todos_read_todos",
"todos_add_todo",
"todos_write_todos",
"todos_update_todo_status",
"todos_remove_todo"
],
"deployment_custom_instructions": "<string>",
"variables_enabled": false,
"variables": [],
"workflows": [],
"knowledge_bases": [],
"multi_kb_search": false,
"citation_instructions_enabled": false,
"citation_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"agent_files": [],
"databases": [],
"tables": [],
"coworkers": [],
"base_tools": [
{
"title": "Human in the Loop",
"description": "Human in the Loop",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "PersonStanding",
"tool_display_message_start": "Escalating to human operator...",
"tool_display_message_end": "Escalated to human operator",
"requires_approval": false,
"visible": true,
"icon": "PersonStanding",
"bg_color": "blue.50",
"icon_color": "blue.500",
"deprecated": false,
"type": "human_in_the_loop",
"has_timeout": false,
"handover_message": "You are now talking to the co-worker."
},
{
"title": "Web Research",
"description": "Search the web for information",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "Globe",
"tool_display_message_start": "Searching the web...",
"tool_display_message_end": "Searched the web",
"requires_approval": false,
"visible": true,
"icon": "Globe",
"bg_color": "#D1FADF",
"icon_color": "#027A48",
"deprecated": false,
"type": "web_research"
},
{
"title": "Files",
"description": "Attach, generate, and work with files.",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "Files",
"tool_display_message_start": "Working with files...",
"tool_display_message_end": "Done",
"requires_approval": false,
"visible": true,
"icon": "Files",
"bg_color": "#EFF6FF",
"icon_color": "#2B7FFF",
"deprecated": false,
"type": "files",
"allow_html_graphs": true,
"show_inline": true,
"custom_author_name": false,
"author_name": "",
"enable_python_sandbox": false,
"enable_formula_eval": false,
"experimental": false
},
{
"title": "Memory",
"description": "Persistent memory during a single conversation",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "Brain",
"tool_display_message_start": "Accessing memory...",
"tool_display_message_end": "Memory operation complete",
"requires_approval": false,
"visible": true,
"icon": "Brain",
"bg_color": "#f5f3ff",
"icon_color": "#8e51ff",
"deprecated": false,
"type": "memory"
},
{
"title": "File System",
"description": "Access and read files in the current session",
"category": "QuickAction",
"enabled": true,
"tool_display_icon": "FolderOpen",
"tool_display_message_start": "Accessing file system...",
"tool_display_message_end": "File system operation complete",
"requires_approval": false,
"visible": false,
"icon": "FolderOpen",
"bg_color": "#fef3c7",
"icon_color": "#f59e0b",
"deprecated": false,
"type": "filesystem"
},
{
"title": "Code Execution",
"description": "Run Python code in a sandboxed environment",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "Terminal",
"tool_display_message_start": "Running code...",
"tool_display_message_end": "Code executed",
"requires_approval": false,
"visible": true,
"icon": "Terminal",
"bg_color": "#fef9c3",
"icon_color": "#ca8a04",
"deprecated": false,
"type": "code_execution",
"timeout": 60
},
{
"title": "Agent Memory",
"description": "Persistent memory across all conversations",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "BookOpen",
"tool_display_message_start": "Accessing agent memory...",
"tool_display_message_end": "Memory operation complete",
"requires_approval": false,
"visible": false,
"icon": "BookOpen",
"bg_color": "#fef3c7",
"icon_color": "#d97706",
"deprecated": false,
"type": "agent_memory"
},
{
"title": "Documentation",
"description": "Search and read Noxus platform documentation",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "BookOpen",
"tool_display_message_start": "Searching documentation...",
"tool_display_message_end": "Documentation found",
"requires_approval": false,
"visible": true,
"icon": "BookOpen",
"bg_color": "#EFF6FF",
"icon_color": "#2B7FFF",
"deprecated": false,
"type": "documentation"
},
{
"title": "Task Tracking",
"description": "Track and manage tasks during the conversation",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "ListTodo",
"tool_display_message_start": "Managing tasks...",
"tool_display_message_end": "Tasks updated",
"requires_approval": false,
"visible": true,
"icon": "ListTodo",
"bg_color": "#f0fdf4",
"icon_color": "#16a34a",
"deprecated": false,
"type": "todos",
"enable_subtasks": false
},
{
"title": "Image Generation",
"description": "Generate images from text prompts, shown inline in the chat.",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "ImagePlus",
"tool_display_message_start": "Generating image...",
"tool_display_message_end": "Image generated",
"requires_approval": false,
"visible": true,
"icon": "ImagePlus",
"bg_color": "#FDF4FF",
"icon_color": "#C026D3",
"deprecated": false,
"type": "image_generation"
}
],
"actions": [],
"insights_enabled": false,
"insights_csat_enabled": false,
"insights_csat_sampling_rate": 1,
"insights_csat_agent_tool_enabled": false,
"insights_csat_agent_tool_instructions": "",
"insights_csat_auto_enabled": false,
"insights_csat_auto_min_messages": 2,
"insights_custom_definitions": [],
"tool_grant_scope": "workspace"
}
}
'import requests
url = "https://api.example.com/v1/agents"
payload = {
"name": "<string>",
"description": "<string>",
"image_url": "<string>",
"visible": True,
"author_name": "<string>",
"definition": {
"pii_banner": "",
"pii_info": "",
"pii_lock": False,
"pii_anonimization": [
{
"value": "PERSON",
"label": "Name"
},
{
"value": "EMAIL_ADDRESS",
"label": "Email"
},
{
"value": "PHONE_NUMBER",
"label": "Phone Number"
},
{
"value": "CREDIT_CARD",
"label": "Credit Card"
}
],
"divider1": "",
"guardrail_info": "",
"guardrail_lock": False,
"guardrail_latency_banner": "",
"violence_and_hate": {
"value": "Off",
"context": ""
},
"sexual_content": {
"value": "Off",
"context": ""
},
"guns_and_weapons": {
"value": "Off",
"context": ""
},
"suicide": {
"value": "Off",
"context": ""
},
"crime": {
"value": "Off",
"context": ""
},
"toxicity": {
"value": "Off",
"context": ""
},
"bias": {
"value": "Off",
"context": ""
},
"profanity": {
"value": "Off",
"context": ""
},
"guardrails_scan_output": False,
"guardrails_output_mode": "post_stream",
"divider2": "",
"guardrail_action": {
"value": "fail",
"label": "Fail/block run"
},
"guardrail_action_replace": "",
"guardrail_action_human": "",
"block_after_violations": 0,
"block_message": "This conversation has been locked due to repeated safety violations. Please start a new conversation.",
"divider3": "",
"prompt_defense": "",
"prompt_lock": False,
"jailbreak": False,
"prompt_injection": False,
"context_leak": False,
"auto_model_pick": False,
"auto_model_preference": "cost",
"model": ["preset:cost"],
"parameter_preset": "default",
"intro": "",
"basic_params_section": "",
"max_tokens": 64000,
"temperature": 0.7,
"top_p": 1,
"top_k": 40,
"timeout": 120,
"divider_7": "",
"penalty_section": "",
"presence_penalty": 0.3,
"frequency_penalty": 0.6,
"stop_sequences": [],
"divider_8": "",
"reasoning_section": "",
"enable_reasoning": True,
"reasoning_effort": "Low",
"divider": "",
"reliability_section": "",
"max_retries_per_model": 3,
"retry_on_status_codes": [429, 500, 502, 503, 504],
"datacenter_fallback": True,
"exclude_user_identity_from_prompt": False,
"enable_prompt_caching": True,
"protect_instructions_in_preview": False,
"usage_limits_section": "",
"usage_limits_maximum_request": 1000,
"usage_limits_maximum_tokens": 2000000,
"usage_limits_max_messages": 100,
"usage_limits_agent_timeout": 120,
"divider_11": "",
"compaction_enabled": True,
"compaction_strategy": "auto",
"compaction_threshold": 0.75,
"compaction_tool_enabled": False,
"tool_calling_section": "",
"parallel_tool_calls": True,
"tool_timeout": 15,
"visuals_section": "",
"hide_reasoning": False,
"group_into_chain_of_thought": True,
"chain_of_thought_final_answer_only": False,
"hide_workflow_progress": False,
"hide_error_banners": True,
"tool_display_preset": "execution",
"minimal_caret_only": True,
"message_footer_enabled": False,
"message_footer": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"minimal_tool_message": "Thinking...",
"citation_style": "text",
"deduplicate_sources_by_url": False,
"omit_citation_quotes": False,
"show_source_images": False,
"chat_input_placeholder": "Ask me anything...",
"divider_visuals": "",
"transport_show_tool_calls": False,
"transport_show_sources": True,
"transport_show_thinking": False,
"transport_allow_noop": False,
"transport_thinking_text": "",
"conversation_title_section": "",
"agent_title_mode": "generate",
"agent_title_prompt": "",
"divider_conversation_title": "",
"feedback_section": "",
"feedback_placeholder": "Add details (optional)",
"feedback_submit_label": "Submit",
"feedback_cancel_label": "Cancel",
"capability_versions": {},
"is_coworker": True,
"preset_selector": "<string>",
"languages": [],
"default_language": "<string>",
"persona": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tone": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"extra_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tools": [],
"workflows_parallel_enabled": False,
"mcp_servers": [],
"convert_unsupported_files_to_text": True,
"skills": [],
"subagents_enabled": False,
"subagents": [],
"guidelines_enabled": False,
"guidelines": [],
"glossary": [],
"memories": [],
"hidden_tools": ["todos_read_todos", "todos_add_todo", "todos_write_todos", "todos_update_todo_status", "todos_remove_todo"],
"deployment_custom_instructions": "<string>",
"variables_enabled": False,
"variables": [],
"workflows": [],
"knowledge_bases": [],
"multi_kb_search": False,
"citation_instructions_enabled": False,
"citation_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"agent_files": [],
"databases": [],
"tables": [],
"coworkers": [],
"base_tools": [
{
"title": "Human in the Loop",
"description": "Human in the Loop",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "PersonStanding",
"tool_display_message_start": "Escalating to human operator...",
"tool_display_message_end": "Escalated to human operator",
"requires_approval": False,
"visible": True,
"icon": "PersonStanding",
"bg_color": "blue.50",
"icon_color": "blue.500",
"deprecated": False,
"type": "human_in_the_loop",
"has_timeout": False,
"handover_message": "You are now talking to the co-worker."
},
{
"title": "Web Research",
"description": "Search the web for information",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "Globe",
"tool_display_message_start": "Searching the web...",
"tool_display_message_end": "Searched the web",
"requires_approval": False,
"visible": True,
"icon": "Globe",
"bg_color": "#D1FADF",
"icon_color": "#027A48",
"deprecated": False,
"type": "web_research"
},
{
"title": "Files",
"description": "Attach, generate, and work with files.",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "Files",
"tool_display_message_start": "Working with files...",
"tool_display_message_end": "Done",
"requires_approval": False,
"visible": True,
"icon": "Files",
"bg_color": "#EFF6FF",
"icon_color": "#2B7FFF",
"deprecated": False,
"type": "files",
"allow_html_graphs": True,
"show_inline": True,
"custom_author_name": False,
"author_name": "",
"enable_python_sandbox": False,
"enable_formula_eval": False,
"experimental": False
},
{
"title": "Memory",
"description": "Persistent memory during a single conversation",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "Brain",
"tool_display_message_start": "Accessing memory...",
"tool_display_message_end": "Memory operation complete",
"requires_approval": False,
"visible": True,
"icon": "Brain",
"bg_color": "#f5f3ff",
"icon_color": "#8e51ff",
"deprecated": False,
"type": "memory"
},
{
"title": "File System",
"description": "Access and read files in the current session",
"category": "QuickAction",
"enabled": True,
"tool_display_icon": "FolderOpen",
"tool_display_message_start": "Accessing file system...",
"tool_display_message_end": "File system operation complete",
"requires_approval": False,
"visible": False,
"icon": "FolderOpen",
"bg_color": "#fef3c7",
"icon_color": "#f59e0b",
"deprecated": False,
"type": "filesystem"
},
{
"title": "Code Execution",
"description": "Run Python code in a sandboxed environment",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "Terminal",
"tool_display_message_start": "Running code...",
"tool_display_message_end": "Code executed",
"requires_approval": False,
"visible": True,
"icon": "Terminal",
"bg_color": "#fef9c3",
"icon_color": "#ca8a04",
"deprecated": False,
"type": "code_execution",
"timeout": 60
},
{
"title": "Agent Memory",
"description": "Persistent memory across all conversations",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "BookOpen",
"tool_display_message_start": "Accessing agent memory...",
"tool_display_message_end": "Memory operation complete",
"requires_approval": False,
"visible": False,
"icon": "BookOpen",
"bg_color": "#fef3c7",
"icon_color": "#d97706",
"deprecated": False,
"type": "agent_memory"
},
{
"title": "Documentation",
"description": "Search and read Noxus platform documentation",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "BookOpen",
"tool_display_message_start": "Searching documentation...",
"tool_display_message_end": "Documentation found",
"requires_approval": False,
"visible": True,
"icon": "BookOpen",
"bg_color": "#EFF6FF",
"icon_color": "#2B7FFF",
"deprecated": False,
"type": "documentation"
},
{
"title": "Task Tracking",
"description": "Track and manage tasks during the conversation",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "ListTodo",
"tool_display_message_start": "Managing tasks...",
"tool_display_message_end": "Tasks updated",
"requires_approval": False,
"visible": True,
"icon": "ListTodo",
"bg_color": "#f0fdf4",
"icon_color": "#16a34a",
"deprecated": False,
"type": "todos",
"enable_subtasks": False
},
{
"title": "Image Generation",
"description": "Generate images from text prompts, shown inline in the chat.",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "ImagePlus",
"tool_display_message_start": "Generating image...",
"tool_display_message_end": "Image generated",
"requires_approval": False,
"visible": True,
"icon": "ImagePlus",
"bg_color": "#FDF4FF",
"icon_color": "#C026D3",
"deprecated": False,
"type": "image_generation"
}
],
"actions": [],
"insights_enabled": False,
"insights_csat_enabled": False,
"insights_csat_sampling_rate": 1,
"insights_csat_agent_tool_enabled": False,
"insights_csat_agent_tool_instructions": "",
"insights_csat_auto_enabled": False,
"insights_csat_auto_min_messages": 2,
"insights_custom_definitions": [],
"tool_grant_scope": "workspace"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
image_url: '<string>',
visible: true,
author_name: '<string>',
definition: {
pii_banner: '',
pii_info: '',
pii_lock: false,
pii_anonimization: [
{value: 'PERSON', label: 'Name'},
{value: 'EMAIL_ADDRESS', label: 'Email'},
{value: 'PHONE_NUMBER', label: 'Phone Number'},
{value: 'CREDIT_CARD', label: 'Credit Card'}
],
divider1: '',
guardrail_info: '',
guardrail_lock: false,
guardrail_latency_banner: '',
violence_and_hate: {value: 'Off', context: ''},
sexual_content: {value: 'Off', context: ''},
guns_and_weapons: {value: 'Off', context: ''},
suicide: {value: 'Off', context: ''},
crime: {value: 'Off', context: ''},
toxicity: {value: 'Off', context: ''},
bias: {value: 'Off', context: ''},
profanity: {value: 'Off', context: ''},
guardrails_scan_output: false,
guardrails_output_mode: 'post_stream',
divider2: '',
guardrail_action: {value: 'fail', label: 'Fail/block run'},
guardrail_action_replace: '',
guardrail_action_human: '',
block_after_violations: 0,
block_message: 'This conversation has been locked due to repeated safety violations. Please start a new conversation.',
divider3: '',
prompt_defense: '',
prompt_lock: false,
jailbreak: false,
prompt_injection: false,
context_leak: false,
auto_model_pick: false,
auto_model_preference: 'cost',
model: ['preset:cost'],
parameter_preset: 'default',
intro: '',
basic_params_section: '',
max_tokens: 64000,
temperature: 0.7,
top_p: 1,
top_k: 40,
timeout: 120,
divider_7: '',
penalty_section: '',
presence_penalty: 0.3,
frequency_penalty: 0.6,
stop_sequences: [],
divider_8: '',
reasoning_section: '',
enable_reasoning: true,
reasoning_effort: 'Low',
divider: '',
reliability_section: '',
max_retries_per_model: 3,
retry_on_status_codes: [429, 500, 502, 503, 504],
datacenter_fallback: true,
exclude_user_identity_from_prompt: false,
enable_prompt_caching: true,
protect_instructions_in_preview: false,
usage_limits_section: '',
usage_limits_maximum_request: 1000,
usage_limits_maximum_tokens: 2000000,
usage_limits_max_messages: 100,
usage_limits_agent_timeout: 120,
divider_11: '',
compaction_enabled: true,
compaction_strategy: 'auto',
compaction_threshold: 0.75,
compaction_tool_enabled: false,
tool_calling_section: '',
parallel_tool_calls: true,
tool_timeout: 15,
visuals_section: '',
hide_reasoning: false,
group_into_chain_of_thought: true,
chain_of_thought_final_answer_only: false,
hide_workflow_progress: false,
hide_error_banners: true,
tool_display_preset: 'execution',
minimal_caret_only: true,
message_footer_enabled: false,
message_footer: [{text: '<string>', definition: {type: 'doc', content: []}}],
minimal_tool_message: 'Thinking...',
citation_style: 'text',
deduplicate_sources_by_url: false,
omit_citation_quotes: false,
show_source_images: false,
chat_input_placeholder: 'Ask me anything...',
divider_visuals: '',
transport_show_tool_calls: false,
transport_show_sources: true,
transport_show_thinking: false,
transport_allow_noop: false,
transport_thinking_text: '',
conversation_title_section: '',
agent_title_mode: 'generate',
agent_title_prompt: '',
divider_conversation_title: '',
feedback_section: '',
feedback_placeholder: 'Add details (optional)',
feedback_submit_label: 'Submit',
feedback_cancel_label: 'Cancel',
capability_versions: {},
is_coworker: true,
preset_selector: '<string>',
languages: [],
default_language: '<string>',
persona: [{text: '<string>', definition: {type: 'doc', content: []}}],
tone: [{text: '<string>', definition: {type: 'doc', content: []}}],
extra_instructions: [{text: '<string>', definition: {type: 'doc', content: []}}],
tools: [],
workflows_parallel_enabled: false,
mcp_servers: [],
convert_unsupported_files_to_text: true,
skills: [],
subagents_enabled: false,
subagents: [],
guidelines_enabled: false,
guidelines: [],
glossary: [],
memories: [],
hidden_tools: [
'todos_read_todos',
'todos_add_todo',
'todos_write_todos',
'todos_update_todo_status',
'todos_remove_todo'
],
deployment_custom_instructions: '<string>',
variables_enabled: false,
variables: [],
workflows: [],
knowledge_bases: [],
multi_kb_search: false,
citation_instructions_enabled: false,
citation_instructions: [{text: '<string>', definition: {type: 'doc', content: []}}],
agent_files: [],
databases: [],
tables: [],
coworkers: [],
base_tools: [
{
title: 'Human in the Loop',
description: 'Human in the Loop',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'PersonStanding',
tool_display_message_start: 'Escalating to human operator...',
tool_display_message_end: 'Escalated to human operator',
requires_approval: false,
visible: true,
icon: 'PersonStanding',
bg_color: 'blue.50',
icon_color: 'blue.500',
deprecated: false,
type: 'human_in_the_loop',
has_timeout: false,
handover_message: 'You are now talking to the co-worker.'
},
{
title: 'Web Research',
description: 'Search the web for information',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'Globe',
tool_display_message_start: 'Searching the web...',
tool_display_message_end: 'Searched the web',
requires_approval: false,
visible: true,
icon: 'Globe',
bg_color: '#D1FADF',
icon_color: '#027A48',
deprecated: false,
type: 'web_research'
},
{
title: 'Files',
description: 'Attach, generate, and work with files.',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'Files',
tool_display_message_start: 'Working with files...',
tool_display_message_end: 'Done',
requires_approval: false,
visible: true,
icon: 'Files',
bg_color: '#EFF6FF',
icon_color: '#2B7FFF',
deprecated: false,
type: 'files',
allow_html_graphs: true,
show_inline: true,
custom_author_name: false,
author_name: '',
enable_python_sandbox: false,
enable_formula_eval: false,
experimental: false
},
{
title: 'Memory',
description: 'Persistent memory during a single conversation',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'Brain',
tool_display_message_start: 'Accessing memory...',
tool_display_message_end: 'Memory operation complete',
requires_approval: false,
visible: true,
icon: 'Brain',
bg_color: '#f5f3ff',
icon_color: '#8e51ff',
deprecated: false,
type: 'memory'
},
{
title: 'File System',
description: 'Access and read files in the current session',
category: 'QuickAction',
enabled: true,
tool_display_icon: 'FolderOpen',
tool_display_message_start: 'Accessing file system...',
tool_display_message_end: 'File system operation complete',
requires_approval: false,
visible: false,
icon: 'FolderOpen',
bg_color: '#fef3c7',
icon_color: '#f59e0b',
deprecated: false,
type: 'filesystem'
},
{
title: 'Code Execution',
description: 'Run Python code in a sandboxed environment',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'Terminal',
tool_display_message_start: 'Running code...',
tool_display_message_end: 'Code executed',
requires_approval: false,
visible: true,
icon: 'Terminal',
bg_color: '#fef9c3',
icon_color: '#ca8a04',
deprecated: false,
type: 'code_execution',
timeout: 60
},
{
title: 'Agent Memory',
description: 'Persistent memory across all conversations',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'BookOpen',
tool_display_message_start: 'Accessing agent memory...',
tool_display_message_end: 'Memory operation complete',
requires_approval: false,
visible: false,
icon: 'BookOpen',
bg_color: '#fef3c7',
icon_color: '#d97706',
deprecated: false,
type: 'agent_memory'
},
{
title: 'Documentation',
description: 'Search and read Noxus platform documentation',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'BookOpen',
tool_display_message_start: 'Searching documentation...',
tool_display_message_end: 'Documentation found',
requires_approval: false,
visible: true,
icon: 'BookOpen',
bg_color: '#EFF6FF',
icon_color: '#2B7FFF',
deprecated: false,
type: 'documentation'
},
{
title: 'Task Tracking',
description: 'Track and manage tasks during the conversation',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'ListTodo',
tool_display_message_start: 'Managing tasks...',
tool_display_message_end: 'Tasks updated',
requires_approval: false,
visible: true,
icon: 'ListTodo',
bg_color: '#f0fdf4',
icon_color: '#16a34a',
deprecated: false,
type: 'todos',
enable_subtasks: false
},
{
title: 'Image Generation',
description: 'Generate images from text prompts, shown inline in the chat.',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'ImagePlus',
tool_display_message_start: 'Generating image...',
tool_display_message_end: 'Image generated',
requires_approval: false,
visible: true,
icon: 'ImagePlus',
bg_color: '#FDF4FF',
icon_color: '#C026D3',
deprecated: false,
type: 'image_generation'
}
],
actions: [],
insights_enabled: false,
insights_csat_enabled: false,
insights_csat_sampling_rate: 1,
insights_csat_agent_tool_enabled: false,
insights_csat_agent_tool_instructions: '',
insights_csat_auto_enabled: false,
insights_csat_auto_min_messages: 2,
insights_custom_definitions: [],
tool_grant_scope: 'workspace'
}
})
};
fetch('https://api.example.com/v1/agents', 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/v1/agents",
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([
'name' => '<string>',
'description' => '<string>',
'image_url' => '<string>',
'visible' => true,
'author_name' => '<string>',
'definition' => [
'pii_banner' => '',
'pii_info' => '',
'pii_lock' => false,
'pii_anonimization' => [
[
'value' => 'PERSON',
'label' => 'Name'
],
[
'value' => 'EMAIL_ADDRESS',
'label' => 'Email'
],
[
'value' => 'PHONE_NUMBER',
'label' => 'Phone Number'
],
[
'value' => 'CREDIT_CARD',
'label' => 'Credit Card'
]
],
'divider1' => '',
'guardrail_info' => '',
'guardrail_lock' => false,
'guardrail_latency_banner' => '',
'violence_and_hate' => [
'value' => 'Off',
'context' => ''
],
'sexual_content' => [
'value' => 'Off',
'context' => ''
],
'guns_and_weapons' => [
'value' => 'Off',
'context' => ''
],
'suicide' => [
'value' => 'Off',
'context' => ''
],
'crime' => [
'value' => 'Off',
'context' => ''
],
'toxicity' => [
'value' => 'Off',
'context' => ''
],
'bias' => [
'value' => 'Off',
'context' => ''
],
'profanity' => [
'value' => 'Off',
'context' => ''
],
'guardrails_scan_output' => false,
'guardrails_output_mode' => 'post_stream',
'divider2' => '',
'guardrail_action' => [
'value' => 'fail',
'label' => 'Fail/block run'
],
'guardrail_action_replace' => '',
'guardrail_action_human' => '',
'block_after_violations' => 0,
'block_message' => 'This conversation has been locked due to repeated safety violations. Please start a new conversation.',
'divider3' => '',
'prompt_defense' => '',
'prompt_lock' => false,
'jailbreak' => false,
'prompt_injection' => false,
'context_leak' => false,
'auto_model_pick' => false,
'auto_model_preference' => 'cost',
'model' => [
'preset:cost'
],
'parameter_preset' => 'default',
'intro' => '',
'basic_params_section' => '',
'max_tokens' => 64000,
'temperature' => 0.7,
'top_p' => 1,
'top_k' => 40,
'timeout' => 120,
'divider_7' => '',
'penalty_section' => '',
'presence_penalty' => 0.3,
'frequency_penalty' => 0.6,
'stop_sequences' => [
],
'divider_8' => '',
'reasoning_section' => '',
'enable_reasoning' => true,
'reasoning_effort' => 'Low',
'divider' => '',
'reliability_section' => '',
'max_retries_per_model' => 3,
'retry_on_status_codes' => [
429,
500,
502,
503,
504
],
'datacenter_fallback' => true,
'exclude_user_identity_from_prompt' => false,
'enable_prompt_caching' => true,
'protect_instructions_in_preview' => false,
'usage_limits_section' => '',
'usage_limits_maximum_request' => 1000,
'usage_limits_maximum_tokens' => 2000000,
'usage_limits_max_messages' => 100,
'usage_limits_agent_timeout' => 120,
'divider_11' => '',
'compaction_enabled' => true,
'compaction_strategy' => 'auto',
'compaction_threshold' => 0.75,
'compaction_tool_enabled' => false,
'tool_calling_section' => '',
'parallel_tool_calls' => true,
'tool_timeout' => 15,
'visuals_section' => '',
'hide_reasoning' => false,
'group_into_chain_of_thought' => true,
'chain_of_thought_final_answer_only' => false,
'hide_workflow_progress' => false,
'hide_error_banners' => true,
'tool_display_preset' => 'execution',
'minimal_caret_only' => true,
'message_footer_enabled' => false,
'message_footer' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'minimal_tool_message' => 'Thinking...',
'citation_style' => 'text',
'deduplicate_sources_by_url' => false,
'omit_citation_quotes' => false,
'show_source_images' => false,
'chat_input_placeholder' => 'Ask me anything...',
'divider_visuals' => '',
'transport_show_tool_calls' => false,
'transport_show_sources' => true,
'transport_show_thinking' => false,
'transport_allow_noop' => false,
'transport_thinking_text' => '',
'conversation_title_section' => '',
'agent_title_mode' => 'generate',
'agent_title_prompt' => '',
'divider_conversation_title' => '',
'feedback_section' => '',
'feedback_placeholder' => 'Add details (optional)',
'feedback_submit_label' => 'Submit',
'feedback_cancel_label' => 'Cancel',
'capability_versions' => [
],
'is_coworker' => true,
'preset_selector' => '<string>',
'languages' => [
],
'default_language' => '<string>',
'persona' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'tone' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'extra_instructions' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'tools' => [
],
'workflows_parallel_enabled' => false,
'mcp_servers' => [
],
'convert_unsupported_files_to_text' => true,
'skills' => [
],
'subagents_enabled' => false,
'subagents' => [
],
'guidelines_enabled' => false,
'guidelines' => [
],
'glossary' => [
],
'memories' => [
],
'hidden_tools' => [
'todos_read_todos',
'todos_add_todo',
'todos_write_todos',
'todos_update_todo_status',
'todos_remove_todo'
],
'deployment_custom_instructions' => '<string>',
'variables_enabled' => false,
'variables' => [
],
'workflows' => [
],
'knowledge_bases' => [
],
'multi_kb_search' => false,
'citation_instructions_enabled' => false,
'citation_instructions' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'agent_files' => [
],
'databases' => [
],
'tables' => [
],
'coworkers' => [
],
'base_tools' => [
[
'title' => 'Human in the Loop',
'description' => 'Human in the Loop',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'PersonStanding',
'tool_display_message_start' => 'Escalating to human operator...',
'tool_display_message_end' => 'Escalated to human operator',
'requires_approval' => false,
'visible' => true,
'icon' => 'PersonStanding',
'bg_color' => 'blue.50',
'icon_color' => 'blue.500',
'deprecated' => false,
'type' => 'human_in_the_loop',
'has_timeout' => false,
'handover_message' => 'You are now talking to the co-worker.'
],
[
'title' => 'Web Research',
'description' => 'Search the web for information',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'Globe',
'tool_display_message_start' => 'Searching the web...',
'tool_display_message_end' => 'Searched the web',
'requires_approval' => false,
'visible' => true,
'icon' => 'Globe',
'bg_color' => '#D1FADF',
'icon_color' => '#027A48',
'deprecated' => false,
'type' => 'web_research'
],
[
'title' => 'Files',
'description' => 'Attach, generate, and work with files.',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'Files',
'tool_display_message_start' => 'Working with files...',
'tool_display_message_end' => 'Done',
'requires_approval' => false,
'visible' => true,
'icon' => 'Files',
'bg_color' => '#EFF6FF',
'icon_color' => '#2B7FFF',
'deprecated' => false,
'type' => 'files',
'allow_html_graphs' => true,
'show_inline' => true,
'custom_author_name' => false,
'author_name' => '',
'enable_python_sandbox' => false,
'enable_formula_eval' => false,
'experimental' => false
],
[
'title' => 'Memory',
'description' => 'Persistent memory during a single conversation',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'Brain',
'tool_display_message_start' => 'Accessing memory...',
'tool_display_message_end' => 'Memory operation complete',
'requires_approval' => false,
'visible' => true,
'icon' => 'Brain',
'bg_color' => '#f5f3ff',
'icon_color' => '#8e51ff',
'deprecated' => false,
'type' => 'memory'
],
[
'title' => 'File System',
'description' => 'Access and read files in the current session',
'category' => 'QuickAction',
'enabled' => true,
'tool_display_icon' => 'FolderOpen',
'tool_display_message_start' => 'Accessing file system...',
'tool_display_message_end' => 'File system operation complete',
'requires_approval' => false,
'visible' => false,
'icon' => 'FolderOpen',
'bg_color' => '#fef3c7',
'icon_color' => '#f59e0b',
'deprecated' => false,
'type' => 'filesystem'
],
[
'title' => 'Code Execution',
'description' => 'Run Python code in a sandboxed environment',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'Terminal',
'tool_display_message_start' => 'Running code...',
'tool_display_message_end' => 'Code executed',
'requires_approval' => false,
'visible' => true,
'icon' => 'Terminal',
'bg_color' => '#fef9c3',
'icon_color' => '#ca8a04',
'deprecated' => false,
'type' => 'code_execution',
'timeout' => 60
],
[
'title' => 'Agent Memory',
'description' => 'Persistent memory across all conversations',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'BookOpen',
'tool_display_message_start' => 'Accessing agent memory...',
'tool_display_message_end' => 'Memory operation complete',
'requires_approval' => false,
'visible' => false,
'icon' => 'BookOpen',
'bg_color' => '#fef3c7',
'icon_color' => '#d97706',
'deprecated' => false,
'type' => 'agent_memory'
],
[
'title' => 'Documentation',
'description' => 'Search and read Noxus platform documentation',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'BookOpen',
'tool_display_message_start' => 'Searching documentation...',
'tool_display_message_end' => 'Documentation found',
'requires_approval' => false,
'visible' => true,
'icon' => 'BookOpen',
'bg_color' => '#EFF6FF',
'icon_color' => '#2B7FFF',
'deprecated' => false,
'type' => 'documentation'
],
[
'title' => 'Task Tracking',
'description' => 'Track and manage tasks during the conversation',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'ListTodo',
'tool_display_message_start' => 'Managing tasks...',
'tool_display_message_end' => 'Tasks updated',
'requires_approval' => false,
'visible' => true,
'icon' => 'ListTodo',
'bg_color' => '#f0fdf4',
'icon_color' => '#16a34a',
'deprecated' => false,
'type' => 'todos',
'enable_subtasks' => false
],
[
'title' => 'Image Generation',
'description' => 'Generate images from text prompts, shown inline in the chat.',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'ImagePlus',
'tool_display_message_start' => 'Generating image...',
'tool_display_message_end' => 'Image generated',
'requires_approval' => false,
'visible' => true,
'icon' => 'ImagePlus',
'bg_color' => '#FDF4FF',
'icon_color' => '#C026D3',
'deprecated' => false,
'type' => 'image_generation'
]
],
'actions' => [
],
'insights_enabled' => false,
'insights_csat_enabled' => false,
'insights_csat_sampling_rate' => 1,
'insights_csat_agent_tool_enabled' => false,
'insights_csat_agent_tool_instructions' => '',
'insights_csat_auto_enabled' => false,
'insights_csat_auto_min_messages' => 2,
'insights_custom_definitions' => [
],
'tool_grant_scope' => 'workspace'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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/v1/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"visible\": true,\n \"author_name\": \"<string>\",\n \"definition\": {\n \"pii_banner\": \"\",\n \"pii_info\": \"\",\n \"pii_lock\": false,\n \"pii_anonimization\": [\n {\n \"value\": \"PERSON\",\n \"label\": \"Name\"\n },\n {\n \"value\": \"EMAIL_ADDRESS\",\n \"label\": \"Email\"\n },\n {\n \"value\": \"PHONE_NUMBER\",\n \"label\": \"Phone Number\"\n },\n {\n \"value\": \"CREDIT_CARD\",\n \"label\": \"Credit Card\"\n }\n ],\n \"divider1\": \"\",\n \"guardrail_info\": \"\",\n \"guardrail_lock\": false,\n \"guardrail_latency_banner\": \"\",\n \"violence_and_hate\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"sexual_content\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guns_and_weapons\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"suicide\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"crime\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"toxicity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"bias\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"profanity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guardrails_scan_output\": false,\n \"guardrails_output_mode\": \"post_stream\",\n \"divider2\": \"\",\n \"guardrail_action\": {\n \"value\": \"fail\",\n \"label\": \"Fail/block run\"\n },\n \"guardrail_action_replace\": \"\",\n \"guardrail_action_human\": \"\",\n \"block_after_violations\": 0,\n \"block_message\": \"This conversation has been locked due to repeated safety violations. Please start a new conversation.\",\n \"divider3\": \"\",\n \"prompt_defense\": \"\",\n \"prompt_lock\": false,\n \"jailbreak\": false,\n \"prompt_injection\": false,\n \"context_leak\": false,\n \"auto_model_pick\": false,\n \"auto_model_preference\": \"cost\",\n \"model\": [\n \"preset:cost\"\n ],\n \"parameter_preset\": \"default\",\n \"intro\": \"\",\n \"basic_params_section\": \"\",\n \"max_tokens\": 64000,\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"top_k\": 40,\n \"timeout\": 120,\n \"divider_7\": \"\",\n \"penalty_section\": \"\",\n \"presence_penalty\": 0.3,\n \"frequency_penalty\": 0.6,\n \"stop_sequences\": [],\n \"divider_8\": \"\",\n \"reasoning_section\": \"\",\n \"enable_reasoning\": true,\n \"reasoning_effort\": \"Low\",\n \"divider\": \"\",\n \"reliability_section\": \"\",\n \"max_retries_per_model\": 3,\n \"retry_on_status_codes\": [\n 429,\n 500,\n 502,\n 503,\n 504\n ],\n \"datacenter_fallback\": true,\n \"exclude_user_identity_from_prompt\": false,\n \"enable_prompt_caching\": true,\n \"protect_instructions_in_preview\": false,\n \"usage_limits_section\": \"\",\n \"usage_limits_maximum_request\": 1000,\n \"usage_limits_maximum_tokens\": 2000000,\n \"usage_limits_max_messages\": 100,\n \"usage_limits_agent_timeout\": 120,\n \"divider_11\": \"\",\n \"compaction_enabled\": true,\n \"compaction_strategy\": \"auto\",\n \"compaction_threshold\": 0.75,\n \"compaction_tool_enabled\": false,\n \"tool_calling_section\": \"\",\n \"parallel_tool_calls\": true,\n \"tool_timeout\": 15,\n \"visuals_section\": \"\",\n \"hide_reasoning\": false,\n \"group_into_chain_of_thought\": true,\n \"chain_of_thought_final_answer_only\": false,\n \"hide_workflow_progress\": false,\n \"hide_error_banners\": true,\n \"tool_display_preset\": \"execution\",\n \"minimal_caret_only\": true,\n \"message_footer_enabled\": false,\n \"message_footer\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"minimal_tool_message\": \"Thinking...\",\n \"citation_style\": \"text\",\n \"deduplicate_sources_by_url\": false,\n \"omit_citation_quotes\": false,\n \"show_source_images\": false,\n \"chat_input_placeholder\": \"Ask me anything...\",\n \"divider_visuals\": \"\",\n \"transport_show_tool_calls\": false,\n \"transport_show_sources\": true,\n \"transport_show_thinking\": false,\n \"transport_allow_noop\": false,\n \"transport_thinking_text\": \"\",\n \"conversation_title_section\": \"\",\n \"agent_title_mode\": \"generate\",\n \"agent_title_prompt\": \"\",\n \"divider_conversation_title\": \"\",\n \"feedback_section\": \"\",\n \"feedback_placeholder\": \"Add details (optional)\",\n \"feedback_submit_label\": \"Submit\",\n \"feedback_cancel_label\": \"Cancel\",\n \"capability_versions\": {},\n \"is_coworker\": true,\n \"preset_selector\": \"<string>\",\n \"languages\": [],\n \"default_language\": \"<string>\",\n \"persona\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tone\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"extra_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tools\": [],\n \"workflows_parallel_enabled\": false,\n \"mcp_servers\": [],\n \"convert_unsupported_files_to_text\": true,\n \"skills\": [],\n \"subagents_enabled\": false,\n \"subagents\": [],\n \"guidelines_enabled\": false,\n \"guidelines\": [],\n \"glossary\": [],\n \"memories\": [],\n \"hidden_tools\": [\n \"todos_read_todos\",\n \"todos_add_todo\",\n \"todos_write_todos\",\n \"todos_update_todo_status\",\n \"todos_remove_todo\"\n ],\n \"deployment_custom_instructions\": \"<string>\",\n \"variables_enabled\": false,\n \"variables\": [],\n \"workflows\": [],\n \"knowledge_bases\": [],\n \"multi_kb_search\": false,\n \"citation_instructions_enabled\": false,\n \"citation_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"agent_files\": [],\n \"databases\": [],\n \"tables\": [],\n \"coworkers\": [],\n \"base_tools\": [\n {\n \"title\": \"Human in the Loop\",\n \"description\": \"Human in the Loop\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"PersonStanding\",\n \"tool_display_message_start\": \"Escalating to human operator...\",\n \"tool_display_message_end\": \"Escalated to human operator\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"PersonStanding\",\n \"bg_color\": \"blue.50\",\n \"icon_color\": \"blue.500\",\n \"deprecated\": false,\n \"type\": \"human_in_the_loop\",\n \"has_timeout\": false,\n \"handover_message\": \"You are now talking to the co-worker.\"\n },\n {\n \"title\": \"Web Research\",\n \"description\": \"Search the web for information\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Globe\",\n \"tool_display_message_start\": \"Searching the web...\",\n \"tool_display_message_end\": \"Searched the web\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Globe\",\n \"bg_color\": \"#D1FADF\",\n \"icon_color\": \"#027A48\",\n \"deprecated\": false,\n \"type\": \"web_research\"\n },\n {\n \"title\": \"Files\",\n \"description\": \"Attach, generate, and work with files.\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Files\",\n \"tool_display_message_start\": \"Working with files...\",\n \"tool_display_message_end\": \"Done\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Files\",\n \"bg_color\": \"#EFF6FF\",\n \"icon_color\": \"#2B7FFF\",\n \"deprecated\": false,\n \"type\": \"files\",\n \"allow_html_graphs\": true,\n \"show_inline\": true,\n \"custom_author_name\": false,\n \"author_name\": \"\",\n \"enable_python_sandbox\": false,\n \"enable_formula_eval\": false,\n \"experimental\": false\n },\n {\n \"title\": \"Memory\",\n \"description\": \"Persistent memory during a single conversation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Brain\",\n \"tool_display_message_start\": \"Accessing memory...\",\n \"tool_display_message_end\": \"Memory operation complete\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Brain\",\n \"bg_color\": \"#f5f3ff\",\n \"icon_color\": \"#8e51ff\",\n \"deprecated\": false,\n \"type\": \"memory\"\n },\n {\n \"title\": \"File System\",\n \"description\": \"Access and read files in the current session\",\n \"category\": \"QuickAction\",\n \"enabled\": true,\n \"tool_display_icon\": \"FolderOpen\",\n \"tool_display_message_start\": \"Accessing file system...\",\n \"tool_display_message_end\": \"File system operation complete\",\n \"requires_approval\": false,\n \"visible\": false,\n \"icon\": \"FolderOpen\",\n \"bg_color\": \"#fef3c7\",\n \"icon_color\": \"#f59e0b\",\n \"deprecated\": false,\n \"type\": \"filesystem\"\n },\n {\n \"title\": \"Code Execution\",\n \"description\": \"Run Python code in a sandboxed environment\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Terminal\",\n \"tool_display_message_start\": \"Running code...\",\n \"tool_display_message_end\": \"Code executed\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Terminal\",\n \"bg_color\": \"#fef9c3\",\n \"icon_color\": \"#ca8a04\",\n \"deprecated\": false,\n \"type\": \"code_execution\",\n \"timeout\": 60\n },\n {\n \"title\": \"Agent Memory\",\n \"description\": \"Persistent memory across all conversations\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"BookOpen\",\n \"tool_display_message_start\": \"Accessing agent memory...\",\n \"tool_display_message_end\": \"Memory operation complete\",\n \"requires_approval\": false,\n \"visible\": false,\n \"icon\": \"BookOpen\",\n \"bg_color\": \"#fef3c7\",\n \"icon_color\": \"#d97706\",\n \"deprecated\": false,\n \"type\": \"agent_memory\"\n },\n {\n \"title\": \"Documentation\",\n \"description\": \"Search and read Noxus platform documentation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"BookOpen\",\n \"tool_display_message_start\": \"Searching documentation...\",\n \"tool_display_message_end\": \"Documentation found\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"BookOpen\",\n \"bg_color\": \"#EFF6FF\",\n \"icon_color\": \"#2B7FFF\",\n \"deprecated\": false,\n \"type\": \"documentation\"\n },\n {\n \"title\": \"Task Tracking\",\n \"description\": \"Track and manage tasks during the conversation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"ListTodo\",\n \"tool_display_message_start\": \"Managing tasks...\",\n \"tool_display_message_end\": \"Tasks updated\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"ListTodo\",\n \"bg_color\": \"#f0fdf4\",\n \"icon_color\": \"#16a34a\",\n \"deprecated\": false,\n \"type\": \"todos\",\n \"enable_subtasks\": false\n },\n {\n \"title\": \"Image Generation\",\n \"description\": \"Generate images from text prompts, shown inline in the chat.\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"ImagePlus\",\n \"tool_display_message_start\": \"Generating image...\",\n \"tool_display_message_end\": \"Image generated\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"ImagePlus\",\n \"bg_color\": \"#FDF4FF\",\n \"icon_color\": \"#C026D3\",\n \"deprecated\": false,\n \"type\": \"image_generation\"\n }\n ],\n \"actions\": [],\n \"insights_enabled\": false,\n \"insights_csat_enabled\": false,\n \"insights_csat_sampling_rate\": 1,\n \"insights_csat_agent_tool_enabled\": false,\n \"insights_csat_agent_tool_instructions\": \"\",\n \"insights_csat_auto_enabled\": false,\n \"insights_csat_auto_min_messages\": 2,\n \"insights_custom_definitions\": [],\n \"tool_grant_scope\": \"workspace\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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/v1/agents")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"visible\": true,\n \"author_name\": \"<string>\",\n \"definition\": {\n \"pii_banner\": \"\",\n \"pii_info\": \"\",\n \"pii_lock\": false,\n \"pii_anonimization\": [\n {\n \"value\": \"PERSON\",\n \"label\": \"Name\"\n },\n {\n \"value\": \"EMAIL_ADDRESS\",\n \"label\": \"Email\"\n },\n {\n \"value\": \"PHONE_NUMBER\",\n \"label\": \"Phone Number\"\n },\n {\n \"value\": \"CREDIT_CARD\",\n \"label\": \"Credit Card\"\n }\n ],\n \"divider1\": \"\",\n \"guardrail_info\": \"\",\n \"guardrail_lock\": false,\n \"guardrail_latency_banner\": \"\",\n \"violence_and_hate\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"sexual_content\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guns_and_weapons\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"suicide\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"crime\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"toxicity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"bias\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"profanity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guardrails_scan_output\": false,\n \"guardrails_output_mode\": \"post_stream\",\n \"divider2\": \"\",\n \"guardrail_action\": {\n \"value\": \"fail\",\n \"label\": \"Fail/block run\"\n },\n \"guardrail_action_replace\": \"\",\n \"guardrail_action_human\": \"\",\n \"block_after_violations\": 0,\n \"block_message\": \"This conversation has been locked due to repeated safety violations. Please start a new conversation.\",\n \"divider3\": \"\",\n \"prompt_defense\": \"\",\n \"prompt_lock\": false,\n \"jailbreak\": false,\n \"prompt_injection\": false,\n \"context_leak\": false,\n \"auto_model_pick\": false,\n \"auto_model_preference\": \"cost\",\n \"model\": [\n \"preset:cost\"\n ],\n \"parameter_preset\": \"default\",\n \"intro\": \"\",\n \"basic_params_section\": \"\",\n \"max_tokens\": 64000,\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"top_k\": 40,\n \"timeout\": 120,\n \"divider_7\": \"\",\n \"penalty_section\": \"\",\n \"presence_penalty\": 0.3,\n \"frequency_penalty\": 0.6,\n \"stop_sequences\": [],\n \"divider_8\": \"\",\n \"reasoning_section\": \"\",\n \"enable_reasoning\": true,\n \"reasoning_effort\": \"Low\",\n \"divider\": \"\",\n \"reliability_section\": \"\",\n \"max_retries_per_model\": 3,\n \"retry_on_status_codes\": [\n 429,\n 500,\n 502,\n 503,\n 504\n ],\n \"datacenter_fallback\": true,\n \"exclude_user_identity_from_prompt\": false,\n \"enable_prompt_caching\": true,\n \"protect_instructions_in_preview\": false,\n \"usage_limits_section\": \"\",\n \"usage_limits_maximum_request\": 1000,\n \"usage_limits_maximum_tokens\": 2000000,\n \"usage_limits_max_messages\": 100,\n \"usage_limits_agent_timeout\": 120,\n \"divider_11\": \"\",\n \"compaction_enabled\": true,\n \"compaction_strategy\": \"auto\",\n \"compaction_threshold\": 0.75,\n \"compaction_tool_enabled\": false,\n \"tool_calling_section\": \"\",\n \"parallel_tool_calls\": true,\n \"tool_timeout\": 15,\n \"visuals_section\": \"\",\n \"hide_reasoning\": false,\n \"group_into_chain_of_thought\": true,\n \"chain_of_thought_final_answer_only\": false,\n \"hide_workflow_progress\": false,\n \"hide_error_banners\": true,\n \"tool_display_preset\": \"execution\",\n \"minimal_caret_only\": true,\n \"message_footer_enabled\": false,\n \"message_footer\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"minimal_tool_message\": \"Thinking...\",\n \"citation_style\": \"text\",\n \"deduplicate_sources_by_url\": false,\n \"omit_citation_quotes\": false,\n \"show_source_images\": false,\n \"chat_input_placeholder\": \"Ask me anything...\",\n \"divider_visuals\": \"\",\n \"transport_show_tool_calls\": false,\n \"transport_show_sources\": true,\n \"transport_show_thinking\": false,\n \"transport_allow_noop\": false,\n \"transport_thinking_text\": \"\",\n \"conversation_title_section\": \"\",\n \"agent_title_mode\": \"generate\",\n \"agent_title_prompt\": \"\",\n \"divider_conversation_title\": \"\",\n \"feedback_section\": \"\",\n \"feedback_placeholder\": \"Add details (optional)\",\n \"feedback_submit_label\": \"Submit\",\n \"feedback_cancel_label\": \"Cancel\",\n \"capability_versions\": {},\n \"is_coworker\": true,\n \"preset_selector\": \"<string>\",\n \"languages\": [],\n \"default_language\": \"<string>\",\n \"persona\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tone\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"extra_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tools\": [],\n \"workflows_parallel_enabled\": false,\n \"mcp_servers\": [],\n \"convert_unsupported_files_to_text\": true,\n \"skills\": [],\n \"subagents_enabled\": false,\n \"subagents\": [],\n \"guidelines_enabled\": false,\n \"guidelines\": [],\n \"glossary\": [],\n \"memories\": [],\n \"hidden_tools\": [\n \"todos_read_todos\",\n \"todos_add_todo\",\n \"todos_write_todos\",\n \"todos_update_todo_status\",\n \"todos_remove_todo\"\n ],\n \"deployment_custom_instructions\": \"<string>\",\n \"variables_enabled\": false,\n \"variables\": [],\n \"workflows\": [],\n \"knowledge_bases\": [],\n \"multi_kb_search\": false,\n \"citation_instructions_enabled\": false,\n \"citation_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"agent_files\": [],\n \"databases\": [],\n \"tables\": [],\n \"coworkers\": [],\n \"base_tools\": [\n {\n \"title\": \"Human in the Loop\",\n \"description\": \"Human in the Loop\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"PersonStanding\",\n \"tool_display_message_start\": \"Escalating to human operator...\",\n \"tool_display_message_end\": \"Escalated to human operator\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"PersonStanding\",\n \"bg_color\": \"blue.50\",\n \"icon_color\": \"blue.500\",\n \"deprecated\": false,\n \"type\": \"human_in_the_loop\",\n \"has_timeout\": false,\n \"handover_message\": \"You are now talking to the co-worker.\"\n },\n {\n \"title\": \"Web Research\",\n \"description\": \"Search the web for information\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Globe\",\n \"tool_display_message_start\": \"Searching the web...\",\n \"tool_display_message_end\": \"Searched the web\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Globe\",\n \"bg_color\": \"#D1FADF\",\n \"icon_color\": \"#027A48\",\n \"deprecated\": false,\n \"type\": \"web_research\"\n },\n {\n \"title\": \"Files\",\n \"description\": \"Attach, generate, and work with files.\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Files\",\n \"tool_display_message_start\": \"Working with files...\",\n \"tool_display_message_end\": \"Done\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Files\",\n \"bg_color\": \"#EFF6FF\",\n \"icon_color\": \"#2B7FFF\",\n \"deprecated\": false,\n \"type\": \"files\",\n \"allow_html_graphs\": true,\n \"show_inline\": true,\n \"custom_author_name\": false,\n \"author_name\": \"\",\n \"enable_python_sandbox\": false,\n \"enable_formula_eval\": false,\n \"experimental\": false\n },\n {\n \"title\": \"Memory\",\n \"description\": \"Persistent memory during a single conversation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Brain\",\n \"tool_display_message_start\": \"Accessing memory...\",\n \"tool_display_message_end\": \"Memory operation complete\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Brain\",\n \"bg_color\": \"#f5f3ff\",\n \"icon_color\": \"#8e51ff\",\n \"deprecated\": false,\n \"type\": \"memory\"\n },\n {\n \"title\": \"File System\",\n \"description\": \"Access and read files in the current session\",\n \"category\": \"QuickAction\",\n \"enabled\": true,\n \"tool_display_icon\": \"FolderOpen\",\n \"tool_display_message_start\": \"Accessing file system...\",\n \"tool_display_message_end\": \"File system operation complete\",\n \"requires_approval\": false,\n \"visible\": false,\n \"icon\": \"FolderOpen\",\n \"bg_color\": \"#fef3c7\",\n \"icon_color\": \"#f59e0b\",\n \"deprecated\": false,\n \"type\": \"filesystem\"\n },\n {\n \"title\": \"Code Execution\",\n \"description\": \"Run Python code in a sandboxed environment\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Terminal\",\n \"tool_display_message_start\": \"Running code...\",\n \"tool_display_message_end\": \"Code executed\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Terminal\",\n \"bg_color\": \"#fef9c3\",\n \"icon_color\": \"#ca8a04\",\n \"deprecated\": false,\n \"type\": \"code_execution\",\n \"timeout\": 60\n },\n {\n \"title\": \"Agent Memory\",\n \"description\": \"Persistent memory across all conversations\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"BookOpen\",\n \"tool_display_message_start\": \"Accessing agent memory...\",\n \"tool_display_message_end\": \"Memory operation complete\",\n \"requires_approval\": false,\n \"visible\": false,\n \"icon\": \"BookOpen\",\n \"bg_color\": \"#fef3c7\",\n \"icon_color\": \"#d97706\",\n \"deprecated\": false,\n \"type\": \"agent_memory\"\n },\n {\n \"title\": \"Documentation\",\n \"description\": \"Search and read Noxus platform documentation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"BookOpen\",\n \"tool_display_message_start\": \"Searching documentation...\",\n \"tool_display_message_end\": \"Documentation found\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"BookOpen\",\n \"bg_color\": \"#EFF6FF\",\n \"icon_color\": \"#2B7FFF\",\n \"deprecated\": false,\n \"type\": \"documentation\"\n },\n {\n \"title\": \"Task Tracking\",\n \"description\": \"Track and manage tasks during the conversation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"ListTodo\",\n \"tool_display_message_start\": \"Managing tasks...\",\n \"tool_display_message_end\": \"Tasks updated\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"ListTodo\",\n \"bg_color\": \"#f0fdf4\",\n \"icon_color\": \"#16a34a\",\n \"deprecated\": false,\n \"type\": \"todos\",\n \"enable_subtasks\": false\n },\n {\n \"title\": \"Image Generation\",\n \"description\": \"Generate images from text prompts, shown inline in the chat.\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"ImagePlus\",\n \"tool_display_message_start\": \"Generating image...\",\n \"tool_display_message_end\": \"Image generated\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"ImagePlus\",\n \"bg_color\": \"#FDF4FF\",\n \"icon_color\": \"#C026D3\",\n \"deprecated\": false,\n \"type\": \"image_generation\"\n }\n ],\n \"actions\": [],\n \"insights_enabled\": false,\n \"insights_csat_enabled\": false,\n \"insights_csat_sampling_rate\": 1,\n \"insights_csat_agent_tool_enabled\": false,\n \"insights_csat_agent_tool_instructions\": \"\",\n \"insights_csat_auto_enabled\": false,\n \"insights_csat_auto_min_messages\": 2,\n \"insights_custom_definitions\": [],\n \"tool_grant_scope\": \"workspace\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"visible\": true,\n \"author_name\": \"<string>\",\n \"definition\": {\n \"pii_banner\": \"\",\n \"pii_info\": \"\",\n \"pii_lock\": false,\n \"pii_anonimization\": [\n {\n \"value\": \"PERSON\",\n \"label\": \"Name\"\n },\n {\n \"value\": \"EMAIL_ADDRESS\",\n \"label\": \"Email\"\n },\n {\n \"value\": \"PHONE_NUMBER\",\n \"label\": \"Phone Number\"\n },\n {\n \"value\": \"CREDIT_CARD\",\n \"label\": \"Credit Card\"\n }\n ],\n \"divider1\": \"\",\n \"guardrail_info\": \"\",\n \"guardrail_lock\": false,\n \"guardrail_latency_banner\": \"\",\n \"violence_and_hate\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"sexual_content\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guns_and_weapons\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"suicide\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"crime\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"toxicity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"bias\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"profanity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guardrails_scan_output\": false,\n \"guardrails_output_mode\": \"post_stream\",\n \"divider2\": \"\",\n \"guardrail_action\": {\n \"value\": \"fail\",\n \"label\": \"Fail/block run\"\n },\n \"guardrail_action_replace\": \"\",\n \"guardrail_action_human\": \"\",\n \"block_after_violations\": 0,\n \"block_message\": \"This conversation has been locked due to repeated safety violations. Please start a new conversation.\",\n \"divider3\": \"\",\n \"prompt_defense\": \"\",\n \"prompt_lock\": false,\n \"jailbreak\": false,\n \"prompt_injection\": false,\n \"context_leak\": false,\n \"auto_model_pick\": false,\n \"auto_model_preference\": \"cost\",\n \"model\": [\n \"preset:cost\"\n ],\n \"parameter_preset\": \"default\",\n \"intro\": \"\",\n \"basic_params_section\": \"\",\n \"max_tokens\": 64000,\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"top_k\": 40,\n \"timeout\": 120,\n \"divider_7\": \"\",\n \"penalty_section\": \"\",\n \"presence_penalty\": 0.3,\n \"frequency_penalty\": 0.6,\n \"stop_sequences\": [],\n \"divider_8\": \"\",\n \"reasoning_section\": \"\",\n \"enable_reasoning\": true,\n \"reasoning_effort\": \"Low\",\n \"divider\": \"\",\n \"reliability_section\": \"\",\n \"max_retries_per_model\": 3,\n \"retry_on_status_codes\": [\n 429,\n 500,\n 502,\n 503,\n 504\n ],\n \"datacenter_fallback\": true,\n \"exclude_user_identity_from_prompt\": false,\n \"enable_prompt_caching\": true,\n \"protect_instructions_in_preview\": false,\n \"usage_limits_section\": \"\",\n \"usage_limits_maximum_request\": 1000,\n \"usage_limits_maximum_tokens\": 2000000,\n \"usage_limits_max_messages\": 100,\n \"usage_limits_agent_timeout\": 120,\n \"divider_11\": \"\",\n \"compaction_enabled\": true,\n \"compaction_strategy\": \"auto\",\n \"compaction_threshold\": 0.75,\n \"compaction_tool_enabled\": false,\n \"tool_calling_section\": \"\",\n \"parallel_tool_calls\": true,\n \"tool_timeout\": 15,\n \"visuals_section\": \"\",\n \"hide_reasoning\": false,\n \"group_into_chain_of_thought\": true,\n \"chain_of_thought_final_answer_only\": false,\n \"hide_workflow_progress\": false,\n \"hide_error_banners\": true,\n \"tool_display_preset\": \"execution\",\n \"minimal_caret_only\": true,\n \"message_footer_enabled\": false,\n \"message_footer\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"minimal_tool_message\": \"Thinking...\",\n \"citation_style\": \"text\",\n \"deduplicate_sources_by_url\": false,\n \"omit_citation_quotes\": false,\n \"show_source_images\": false,\n \"chat_input_placeholder\": \"Ask me anything...\",\n \"divider_visuals\": \"\",\n \"transport_show_tool_calls\": false,\n \"transport_show_sources\": true,\n \"transport_show_thinking\": false,\n \"transport_allow_noop\": false,\n \"transport_thinking_text\": \"\",\n \"conversation_title_section\": \"\",\n \"agent_title_mode\": \"generate\",\n \"agent_title_prompt\": \"\",\n \"divider_conversation_title\": \"\",\n \"feedback_section\": \"\",\n \"feedback_placeholder\": \"Add details (optional)\",\n \"feedback_submit_label\": \"Submit\",\n \"feedback_cancel_label\": \"Cancel\",\n \"capability_versions\": {},\n \"is_coworker\": true,\n \"preset_selector\": \"<string>\",\n \"languages\": [],\n \"default_language\": \"<string>\",\n \"persona\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tone\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"extra_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tools\": [],\n \"workflows_parallel_enabled\": false,\n \"mcp_servers\": [],\n \"convert_unsupported_files_to_text\": true,\n \"skills\": [],\n \"subagents_enabled\": false,\n \"subagents\": [],\n \"guidelines_enabled\": false,\n \"guidelines\": [],\n \"glossary\": [],\n \"memories\": [],\n \"hidden_tools\": [\n \"todos_read_todos\",\n \"todos_add_todo\",\n \"todos_write_todos\",\n \"todos_update_todo_status\",\n \"todos_remove_todo\"\n ],\n \"deployment_custom_instructions\": \"<string>\",\n \"variables_enabled\": false,\n \"variables\": [],\n \"workflows\": [],\n \"knowledge_bases\": [],\n \"multi_kb_search\": false,\n \"citation_instructions_enabled\": false,\n \"citation_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"agent_files\": [],\n \"databases\": [],\n \"tables\": [],\n \"coworkers\": [],\n \"base_tools\": [\n {\n \"title\": \"Human in the Loop\",\n \"description\": \"Human in the Loop\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"PersonStanding\",\n \"tool_display_message_start\": \"Escalating to human operator...\",\n \"tool_display_message_end\": \"Escalated to human operator\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"PersonStanding\",\n \"bg_color\": \"blue.50\",\n \"icon_color\": \"blue.500\",\n \"deprecated\": false,\n \"type\": \"human_in_the_loop\",\n \"has_timeout\": false,\n \"handover_message\": \"You are now talking to the co-worker.\"\n },\n {\n \"title\": \"Web Research\",\n \"description\": \"Search the web for information\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Globe\",\n \"tool_display_message_start\": \"Searching the web...\",\n \"tool_display_message_end\": \"Searched the web\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Globe\",\n \"bg_color\": \"#D1FADF\",\n \"icon_color\": \"#027A48\",\n \"deprecated\": false,\n \"type\": \"web_research\"\n },\n {\n \"title\": \"Files\",\n \"description\": \"Attach, generate, and work with files.\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Files\",\n \"tool_display_message_start\": \"Working with files...\",\n \"tool_display_message_end\": \"Done\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Files\",\n \"bg_color\": \"#EFF6FF\",\n \"icon_color\": \"#2B7FFF\",\n \"deprecated\": false,\n \"type\": \"files\",\n \"allow_html_graphs\": true,\n \"show_inline\": true,\n \"custom_author_name\": false,\n \"author_name\": \"\",\n \"enable_python_sandbox\": false,\n \"enable_formula_eval\": false,\n \"experimental\": false\n },\n {\n \"title\": \"Memory\",\n \"description\": \"Persistent memory during a single conversation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Brain\",\n \"tool_display_message_start\": \"Accessing memory...\",\n \"tool_display_message_end\": \"Memory operation complete\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Brain\",\n \"bg_color\": \"#f5f3ff\",\n \"icon_color\": \"#8e51ff\",\n \"deprecated\": false,\n \"type\": \"memory\"\n },\n {\n \"title\": \"File System\",\n \"description\": \"Access and read files in the current session\",\n \"category\": \"QuickAction\",\n \"enabled\": true,\n \"tool_display_icon\": \"FolderOpen\",\n \"tool_display_message_start\": \"Accessing file system...\",\n \"tool_display_message_end\": \"File system operation complete\",\n \"requires_approval\": false,\n \"visible\": false,\n \"icon\": \"FolderOpen\",\n \"bg_color\": \"#fef3c7\",\n \"icon_color\": \"#f59e0b\",\n \"deprecated\": false,\n \"type\": \"filesystem\"\n },\n {\n \"title\": \"Code Execution\",\n \"description\": \"Run Python code in a sandboxed environment\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Terminal\",\n \"tool_display_message_start\": \"Running code...\",\n \"tool_display_message_end\": \"Code executed\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Terminal\",\n \"bg_color\": \"#fef9c3\",\n \"icon_color\": \"#ca8a04\",\n \"deprecated\": false,\n \"type\": \"code_execution\",\n \"timeout\": 60\n },\n {\n \"title\": \"Agent Memory\",\n \"description\": \"Persistent memory across all conversations\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"BookOpen\",\n \"tool_display_message_start\": \"Accessing agent memory...\",\n \"tool_display_message_end\": \"Memory operation complete\",\n \"requires_approval\": false,\n \"visible\": false,\n \"icon\": \"BookOpen\",\n \"bg_color\": \"#fef3c7\",\n \"icon_color\": \"#d97706\",\n \"deprecated\": false,\n \"type\": \"agent_memory\"\n },\n {\n \"title\": \"Documentation\",\n \"description\": \"Search and read Noxus platform documentation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"BookOpen\",\n \"tool_display_message_start\": \"Searching documentation...\",\n \"tool_display_message_end\": \"Documentation found\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"BookOpen\",\n \"bg_color\": \"#EFF6FF\",\n \"icon_color\": \"#2B7FFF\",\n \"deprecated\": false,\n \"type\": \"documentation\"\n },\n {\n \"title\": \"Task Tracking\",\n \"description\": \"Track and manage tasks during the conversation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"ListTodo\",\n \"tool_display_message_start\": \"Managing tasks...\",\n \"tool_display_message_end\": \"Tasks updated\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"ListTodo\",\n \"bg_color\": \"#f0fdf4\",\n \"icon_color\": \"#16a34a\",\n \"deprecated\": false,\n \"type\": \"todos\",\n \"enable_subtasks\": false\n },\n {\n \"title\": \"Image Generation\",\n \"description\": \"Generate images from text prompts, shown inline in the chat.\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"ImagePlus\",\n \"tool_display_message_start\": \"Generating image...\",\n \"tool_display_message_end\": \"Image generated\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"ImagePlus\",\n \"bg_color\": \"#FDF4FF\",\n \"icon_color\": \"#C026D3\",\n \"deprecated\": false,\n \"type\": \"image_generation\"\n }\n ],\n \"actions\": [],\n \"insights_enabled\": false,\n \"insights_csat_enabled\": false,\n \"insights_csat_sampling_rate\": 1,\n \"insights_csat_agent_tool_enabled\": false,\n \"insights_csat_agent_tool_instructions\": \"\",\n \"insights_csat_auto_enabled\": false,\n \"insights_csat_auto_min_messages\": 2,\n \"insights_custom_definitions\": [],\n \"tool_grant_scope\": \"workspace\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"definition": {},
"description": "<string>",
"visible": true,
"image_url": "<string>",
"last_updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"app_settings_v2": {
"is_active": false,
"version_id": "<string>",
"interface_type": "slack",
"extra_settings": {},
"published_at": "2023-11-07T05:31:56Z"
},
"is_app_published": true,
"allow_public_access": false,
"meta": {
"template_id": "<string>",
"is_genie": true,
"source": "genie"
},
"draft_definition": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Add Agent
Add Agent to the platform
POST
/
v1
/
agents
Add Agent
curl --request POST \
--url https://api.example.com/v1/agents \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"image_url": "<string>",
"visible": true,
"author_name": "<string>",
"definition": {
"pii_banner": "",
"pii_info": "",
"pii_lock": false,
"pii_anonimization": [
{
"value": "PERSON",
"label": "Name"
},
{
"value": "EMAIL_ADDRESS",
"label": "Email"
},
{
"value": "PHONE_NUMBER",
"label": "Phone Number"
},
{
"value": "CREDIT_CARD",
"label": "Credit Card"
}
],
"divider1": "",
"guardrail_info": "",
"guardrail_lock": false,
"guardrail_latency_banner": "",
"violence_and_hate": {
"value": "Off",
"context": ""
},
"sexual_content": {
"value": "Off",
"context": ""
},
"guns_and_weapons": {
"value": "Off",
"context": ""
},
"suicide": {
"value": "Off",
"context": ""
},
"crime": {
"value": "Off",
"context": ""
},
"toxicity": {
"value": "Off",
"context": ""
},
"bias": {
"value": "Off",
"context": ""
},
"profanity": {
"value": "Off",
"context": ""
},
"guardrails_scan_output": false,
"guardrails_output_mode": "post_stream",
"divider2": "",
"guardrail_action": {
"value": "fail",
"label": "Fail/block run"
},
"guardrail_action_replace": "",
"guardrail_action_human": "",
"block_after_violations": 0,
"block_message": "This conversation has been locked due to repeated safety violations. Please start a new conversation.",
"divider3": "",
"prompt_defense": "",
"prompt_lock": false,
"jailbreak": false,
"prompt_injection": false,
"context_leak": false,
"auto_model_pick": false,
"auto_model_preference": "cost",
"model": [
"preset:cost"
],
"parameter_preset": "default",
"intro": "",
"basic_params_section": "",
"max_tokens": 64000,
"temperature": 0.7,
"top_p": 1,
"top_k": 40,
"timeout": 120,
"divider_7": "",
"penalty_section": "",
"presence_penalty": 0.3,
"frequency_penalty": 0.6,
"stop_sequences": [],
"divider_8": "",
"reasoning_section": "",
"enable_reasoning": true,
"reasoning_effort": "Low",
"divider": "",
"reliability_section": "",
"max_retries_per_model": 3,
"retry_on_status_codes": [
429,
500,
502,
503,
504
],
"datacenter_fallback": true,
"exclude_user_identity_from_prompt": false,
"enable_prompt_caching": true,
"protect_instructions_in_preview": false,
"usage_limits_section": "",
"usage_limits_maximum_request": 1000,
"usage_limits_maximum_tokens": 2000000,
"usage_limits_max_messages": 100,
"usage_limits_agent_timeout": 120,
"divider_11": "",
"compaction_enabled": true,
"compaction_strategy": "auto",
"compaction_threshold": 0.75,
"compaction_tool_enabled": false,
"tool_calling_section": "",
"parallel_tool_calls": true,
"tool_timeout": 15,
"visuals_section": "",
"hide_reasoning": false,
"group_into_chain_of_thought": true,
"chain_of_thought_final_answer_only": false,
"hide_workflow_progress": false,
"hide_error_banners": true,
"tool_display_preset": "execution",
"minimal_caret_only": true,
"message_footer_enabled": false,
"message_footer": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"minimal_tool_message": "Thinking...",
"citation_style": "text",
"deduplicate_sources_by_url": false,
"omit_citation_quotes": false,
"show_source_images": false,
"chat_input_placeholder": "Ask me anything...",
"divider_visuals": "",
"transport_show_tool_calls": false,
"transport_show_sources": true,
"transport_show_thinking": false,
"transport_allow_noop": false,
"transport_thinking_text": "",
"conversation_title_section": "",
"agent_title_mode": "generate",
"agent_title_prompt": "",
"divider_conversation_title": "",
"feedback_section": "",
"feedback_placeholder": "Add details (optional)",
"feedback_submit_label": "Submit",
"feedback_cancel_label": "Cancel",
"capability_versions": {},
"is_coworker": true,
"preset_selector": "<string>",
"languages": [],
"default_language": "<string>",
"persona": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tone": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"extra_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tools": [],
"workflows_parallel_enabled": false,
"mcp_servers": [],
"convert_unsupported_files_to_text": true,
"skills": [],
"subagents_enabled": false,
"subagents": [],
"guidelines_enabled": false,
"guidelines": [],
"glossary": [],
"memories": [],
"hidden_tools": [
"todos_read_todos",
"todos_add_todo",
"todos_write_todos",
"todos_update_todo_status",
"todos_remove_todo"
],
"deployment_custom_instructions": "<string>",
"variables_enabled": false,
"variables": [],
"workflows": [],
"knowledge_bases": [],
"multi_kb_search": false,
"citation_instructions_enabled": false,
"citation_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"agent_files": [],
"databases": [],
"tables": [],
"coworkers": [],
"base_tools": [
{
"title": "Human in the Loop",
"description": "Human in the Loop",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "PersonStanding",
"tool_display_message_start": "Escalating to human operator...",
"tool_display_message_end": "Escalated to human operator",
"requires_approval": false,
"visible": true,
"icon": "PersonStanding",
"bg_color": "blue.50",
"icon_color": "blue.500",
"deprecated": false,
"type": "human_in_the_loop",
"has_timeout": false,
"handover_message": "You are now talking to the co-worker."
},
{
"title": "Web Research",
"description": "Search the web for information",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "Globe",
"tool_display_message_start": "Searching the web...",
"tool_display_message_end": "Searched the web",
"requires_approval": false,
"visible": true,
"icon": "Globe",
"bg_color": "#D1FADF",
"icon_color": "#027A48",
"deprecated": false,
"type": "web_research"
},
{
"title": "Files",
"description": "Attach, generate, and work with files.",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "Files",
"tool_display_message_start": "Working with files...",
"tool_display_message_end": "Done",
"requires_approval": false,
"visible": true,
"icon": "Files",
"bg_color": "#EFF6FF",
"icon_color": "#2B7FFF",
"deprecated": false,
"type": "files",
"allow_html_graphs": true,
"show_inline": true,
"custom_author_name": false,
"author_name": "",
"enable_python_sandbox": false,
"enable_formula_eval": false,
"experimental": false
},
{
"title": "Memory",
"description": "Persistent memory during a single conversation",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "Brain",
"tool_display_message_start": "Accessing memory...",
"tool_display_message_end": "Memory operation complete",
"requires_approval": false,
"visible": true,
"icon": "Brain",
"bg_color": "#f5f3ff",
"icon_color": "#8e51ff",
"deprecated": false,
"type": "memory"
},
{
"title": "File System",
"description": "Access and read files in the current session",
"category": "QuickAction",
"enabled": true,
"tool_display_icon": "FolderOpen",
"tool_display_message_start": "Accessing file system...",
"tool_display_message_end": "File system operation complete",
"requires_approval": false,
"visible": false,
"icon": "FolderOpen",
"bg_color": "#fef3c7",
"icon_color": "#f59e0b",
"deprecated": false,
"type": "filesystem"
},
{
"title": "Code Execution",
"description": "Run Python code in a sandboxed environment",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "Terminal",
"tool_display_message_start": "Running code...",
"tool_display_message_end": "Code executed",
"requires_approval": false,
"visible": true,
"icon": "Terminal",
"bg_color": "#fef9c3",
"icon_color": "#ca8a04",
"deprecated": false,
"type": "code_execution",
"timeout": 60
},
{
"title": "Agent Memory",
"description": "Persistent memory across all conversations",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "BookOpen",
"tool_display_message_start": "Accessing agent memory...",
"tool_display_message_end": "Memory operation complete",
"requires_approval": false,
"visible": false,
"icon": "BookOpen",
"bg_color": "#fef3c7",
"icon_color": "#d97706",
"deprecated": false,
"type": "agent_memory"
},
{
"title": "Documentation",
"description": "Search and read Noxus platform documentation",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "BookOpen",
"tool_display_message_start": "Searching documentation...",
"tool_display_message_end": "Documentation found",
"requires_approval": false,
"visible": true,
"icon": "BookOpen",
"bg_color": "#EFF6FF",
"icon_color": "#2B7FFF",
"deprecated": false,
"type": "documentation"
},
{
"title": "Task Tracking",
"description": "Track and manage tasks during the conversation",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "ListTodo",
"tool_display_message_start": "Managing tasks...",
"tool_display_message_end": "Tasks updated",
"requires_approval": false,
"visible": true,
"icon": "ListTodo",
"bg_color": "#f0fdf4",
"icon_color": "#16a34a",
"deprecated": false,
"type": "todos",
"enable_subtasks": false
},
{
"title": "Image Generation",
"description": "Generate images from text prompts, shown inline in the chat.",
"category": "QuickAction",
"enabled": false,
"tool_display_icon": "ImagePlus",
"tool_display_message_start": "Generating image...",
"tool_display_message_end": "Image generated",
"requires_approval": false,
"visible": true,
"icon": "ImagePlus",
"bg_color": "#FDF4FF",
"icon_color": "#C026D3",
"deprecated": false,
"type": "image_generation"
}
],
"actions": [],
"insights_enabled": false,
"insights_csat_enabled": false,
"insights_csat_sampling_rate": 1,
"insights_csat_agent_tool_enabled": false,
"insights_csat_agent_tool_instructions": "",
"insights_csat_auto_enabled": false,
"insights_csat_auto_min_messages": 2,
"insights_custom_definitions": [],
"tool_grant_scope": "workspace"
}
}
'import requests
url = "https://api.example.com/v1/agents"
payload = {
"name": "<string>",
"description": "<string>",
"image_url": "<string>",
"visible": True,
"author_name": "<string>",
"definition": {
"pii_banner": "",
"pii_info": "",
"pii_lock": False,
"pii_anonimization": [
{
"value": "PERSON",
"label": "Name"
},
{
"value": "EMAIL_ADDRESS",
"label": "Email"
},
{
"value": "PHONE_NUMBER",
"label": "Phone Number"
},
{
"value": "CREDIT_CARD",
"label": "Credit Card"
}
],
"divider1": "",
"guardrail_info": "",
"guardrail_lock": False,
"guardrail_latency_banner": "",
"violence_and_hate": {
"value": "Off",
"context": ""
},
"sexual_content": {
"value": "Off",
"context": ""
},
"guns_and_weapons": {
"value": "Off",
"context": ""
},
"suicide": {
"value": "Off",
"context": ""
},
"crime": {
"value": "Off",
"context": ""
},
"toxicity": {
"value": "Off",
"context": ""
},
"bias": {
"value": "Off",
"context": ""
},
"profanity": {
"value": "Off",
"context": ""
},
"guardrails_scan_output": False,
"guardrails_output_mode": "post_stream",
"divider2": "",
"guardrail_action": {
"value": "fail",
"label": "Fail/block run"
},
"guardrail_action_replace": "",
"guardrail_action_human": "",
"block_after_violations": 0,
"block_message": "This conversation has been locked due to repeated safety violations. Please start a new conversation.",
"divider3": "",
"prompt_defense": "",
"prompt_lock": False,
"jailbreak": False,
"prompt_injection": False,
"context_leak": False,
"auto_model_pick": False,
"auto_model_preference": "cost",
"model": ["preset:cost"],
"parameter_preset": "default",
"intro": "",
"basic_params_section": "",
"max_tokens": 64000,
"temperature": 0.7,
"top_p": 1,
"top_k": 40,
"timeout": 120,
"divider_7": "",
"penalty_section": "",
"presence_penalty": 0.3,
"frequency_penalty": 0.6,
"stop_sequences": [],
"divider_8": "",
"reasoning_section": "",
"enable_reasoning": True,
"reasoning_effort": "Low",
"divider": "",
"reliability_section": "",
"max_retries_per_model": 3,
"retry_on_status_codes": [429, 500, 502, 503, 504],
"datacenter_fallback": True,
"exclude_user_identity_from_prompt": False,
"enable_prompt_caching": True,
"protect_instructions_in_preview": False,
"usage_limits_section": "",
"usage_limits_maximum_request": 1000,
"usage_limits_maximum_tokens": 2000000,
"usage_limits_max_messages": 100,
"usage_limits_agent_timeout": 120,
"divider_11": "",
"compaction_enabled": True,
"compaction_strategy": "auto",
"compaction_threshold": 0.75,
"compaction_tool_enabled": False,
"tool_calling_section": "",
"parallel_tool_calls": True,
"tool_timeout": 15,
"visuals_section": "",
"hide_reasoning": False,
"group_into_chain_of_thought": True,
"chain_of_thought_final_answer_only": False,
"hide_workflow_progress": False,
"hide_error_banners": True,
"tool_display_preset": "execution",
"minimal_caret_only": True,
"message_footer_enabled": False,
"message_footer": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"minimal_tool_message": "Thinking...",
"citation_style": "text",
"deduplicate_sources_by_url": False,
"omit_citation_quotes": False,
"show_source_images": False,
"chat_input_placeholder": "Ask me anything...",
"divider_visuals": "",
"transport_show_tool_calls": False,
"transport_show_sources": True,
"transport_show_thinking": False,
"transport_allow_noop": False,
"transport_thinking_text": "",
"conversation_title_section": "",
"agent_title_mode": "generate",
"agent_title_prompt": "",
"divider_conversation_title": "",
"feedback_section": "",
"feedback_placeholder": "Add details (optional)",
"feedback_submit_label": "Submit",
"feedback_cancel_label": "Cancel",
"capability_versions": {},
"is_coworker": True,
"preset_selector": "<string>",
"languages": [],
"default_language": "<string>",
"persona": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tone": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"extra_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"tools": [],
"workflows_parallel_enabled": False,
"mcp_servers": [],
"convert_unsupported_files_to_text": True,
"skills": [],
"subagents_enabled": False,
"subagents": [],
"guidelines_enabled": False,
"guidelines": [],
"glossary": [],
"memories": [],
"hidden_tools": ["todos_read_todos", "todos_add_todo", "todos_write_todos", "todos_update_todo_status", "todos_remove_todo"],
"deployment_custom_instructions": "<string>",
"variables_enabled": False,
"variables": [],
"workflows": [],
"knowledge_bases": [],
"multi_kb_search": False,
"citation_instructions_enabled": False,
"citation_instructions": [
{
"text": "<string>",
"definition": {
"type": "doc",
"content": []
}
}
],
"agent_files": [],
"databases": [],
"tables": [],
"coworkers": [],
"base_tools": [
{
"title": "Human in the Loop",
"description": "Human in the Loop",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "PersonStanding",
"tool_display_message_start": "Escalating to human operator...",
"tool_display_message_end": "Escalated to human operator",
"requires_approval": False,
"visible": True,
"icon": "PersonStanding",
"bg_color": "blue.50",
"icon_color": "blue.500",
"deprecated": False,
"type": "human_in_the_loop",
"has_timeout": False,
"handover_message": "You are now talking to the co-worker."
},
{
"title": "Web Research",
"description": "Search the web for information",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "Globe",
"tool_display_message_start": "Searching the web...",
"tool_display_message_end": "Searched the web",
"requires_approval": False,
"visible": True,
"icon": "Globe",
"bg_color": "#D1FADF",
"icon_color": "#027A48",
"deprecated": False,
"type": "web_research"
},
{
"title": "Files",
"description": "Attach, generate, and work with files.",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "Files",
"tool_display_message_start": "Working with files...",
"tool_display_message_end": "Done",
"requires_approval": False,
"visible": True,
"icon": "Files",
"bg_color": "#EFF6FF",
"icon_color": "#2B7FFF",
"deprecated": False,
"type": "files",
"allow_html_graphs": True,
"show_inline": True,
"custom_author_name": False,
"author_name": "",
"enable_python_sandbox": False,
"enable_formula_eval": False,
"experimental": False
},
{
"title": "Memory",
"description": "Persistent memory during a single conversation",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "Brain",
"tool_display_message_start": "Accessing memory...",
"tool_display_message_end": "Memory operation complete",
"requires_approval": False,
"visible": True,
"icon": "Brain",
"bg_color": "#f5f3ff",
"icon_color": "#8e51ff",
"deprecated": False,
"type": "memory"
},
{
"title": "File System",
"description": "Access and read files in the current session",
"category": "QuickAction",
"enabled": True,
"tool_display_icon": "FolderOpen",
"tool_display_message_start": "Accessing file system...",
"tool_display_message_end": "File system operation complete",
"requires_approval": False,
"visible": False,
"icon": "FolderOpen",
"bg_color": "#fef3c7",
"icon_color": "#f59e0b",
"deprecated": False,
"type": "filesystem"
},
{
"title": "Code Execution",
"description": "Run Python code in a sandboxed environment",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "Terminal",
"tool_display_message_start": "Running code...",
"tool_display_message_end": "Code executed",
"requires_approval": False,
"visible": True,
"icon": "Terminal",
"bg_color": "#fef9c3",
"icon_color": "#ca8a04",
"deprecated": False,
"type": "code_execution",
"timeout": 60
},
{
"title": "Agent Memory",
"description": "Persistent memory across all conversations",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "BookOpen",
"tool_display_message_start": "Accessing agent memory...",
"tool_display_message_end": "Memory operation complete",
"requires_approval": False,
"visible": False,
"icon": "BookOpen",
"bg_color": "#fef3c7",
"icon_color": "#d97706",
"deprecated": False,
"type": "agent_memory"
},
{
"title": "Documentation",
"description": "Search and read Noxus platform documentation",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "BookOpen",
"tool_display_message_start": "Searching documentation...",
"tool_display_message_end": "Documentation found",
"requires_approval": False,
"visible": True,
"icon": "BookOpen",
"bg_color": "#EFF6FF",
"icon_color": "#2B7FFF",
"deprecated": False,
"type": "documentation"
},
{
"title": "Task Tracking",
"description": "Track and manage tasks during the conversation",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "ListTodo",
"tool_display_message_start": "Managing tasks...",
"tool_display_message_end": "Tasks updated",
"requires_approval": False,
"visible": True,
"icon": "ListTodo",
"bg_color": "#f0fdf4",
"icon_color": "#16a34a",
"deprecated": False,
"type": "todos",
"enable_subtasks": False
},
{
"title": "Image Generation",
"description": "Generate images from text prompts, shown inline in the chat.",
"category": "QuickAction",
"enabled": False,
"tool_display_icon": "ImagePlus",
"tool_display_message_start": "Generating image...",
"tool_display_message_end": "Image generated",
"requires_approval": False,
"visible": True,
"icon": "ImagePlus",
"bg_color": "#FDF4FF",
"icon_color": "#C026D3",
"deprecated": False,
"type": "image_generation"
}
],
"actions": [],
"insights_enabled": False,
"insights_csat_enabled": False,
"insights_csat_sampling_rate": 1,
"insights_csat_agent_tool_enabled": False,
"insights_csat_agent_tool_instructions": "",
"insights_csat_auto_enabled": False,
"insights_csat_auto_min_messages": 2,
"insights_custom_definitions": [],
"tool_grant_scope": "workspace"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
image_url: '<string>',
visible: true,
author_name: '<string>',
definition: {
pii_banner: '',
pii_info: '',
pii_lock: false,
pii_anonimization: [
{value: 'PERSON', label: 'Name'},
{value: 'EMAIL_ADDRESS', label: 'Email'},
{value: 'PHONE_NUMBER', label: 'Phone Number'},
{value: 'CREDIT_CARD', label: 'Credit Card'}
],
divider1: '',
guardrail_info: '',
guardrail_lock: false,
guardrail_latency_banner: '',
violence_and_hate: {value: 'Off', context: ''},
sexual_content: {value: 'Off', context: ''},
guns_and_weapons: {value: 'Off', context: ''},
suicide: {value: 'Off', context: ''},
crime: {value: 'Off', context: ''},
toxicity: {value: 'Off', context: ''},
bias: {value: 'Off', context: ''},
profanity: {value: 'Off', context: ''},
guardrails_scan_output: false,
guardrails_output_mode: 'post_stream',
divider2: '',
guardrail_action: {value: 'fail', label: 'Fail/block run'},
guardrail_action_replace: '',
guardrail_action_human: '',
block_after_violations: 0,
block_message: 'This conversation has been locked due to repeated safety violations. Please start a new conversation.',
divider3: '',
prompt_defense: '',
prompt_lock: false,
jailbreak: false,
prompt_injection: false,
context_leak: false,
auto_model_pick: false,
auto_model_preference: 'cost',
model: ['preset:cost'],
parameter_preset: 'default',
intro: '',
basic_params_section: '',
max_tokens: 64000,
temperature: 0.7,
top_p: 1,
top_k: 40,
timeout: 120,
divider_7: '',
penalty_section: '',
presence_penalty: 0.3,
frequency_penalty: 0.6,
stop_sequences: [],
divider_8: '',
reasoning_section: '',
enable_reasoning: true,
reasoning_effort: 'Low',
divider: '',
reliability_section: '',
max_retries_per_model: 3,
retry_on_status_codes: [429, 500, 502, 503, 504],
datacenter_fallback: true,
exclude_user_identity_from_prompt: false,
enable_prompt_caching: true,
protect_instructions_in_preview: false,
usage_limits_section: '',
usage_limits_maximum_request: 1000,
usage_limits_maximum_tokens: 2000000,
usage_limits_max_messages: 100,
usage_limits_agent_timeout: 120,
divider_11: '',
compaction_enabled: true,
compaction_strategy: 'auto',
compaction_threshold: 0.75,
compaction_tool_enabled: false,
tool_calling_section: '',
parallel_tool_calls: true,
tool_timeout: 15,
visuals_section: '',
hide_reasoning: false,
group_into_chain_of_thought: true,
chain_of_thought_final_answer_only: false,
hide_workflow_progress: false,
hide_error_banners: true,
tool_display_preset: 'execution',
minimal_caret_only: true,
message_footer_enabled: false,
message_footer: [{text: '<string>', definition: {type: 'doc', content: []}}],
minimal_tool_message: 'Thinking...',
citation_style: 'text',
deduplicate_sources_by_url: false,
omit_citation_quotes: false,
show_source_images: false,
chat_input_placeholder: 'Ask me anything...',
divider_visuals: '',
transport_show_tool_calls: false,
transport_show_sources: true,
transport_show_thinking: false,
transport_allow_noop: false,
transport_thinking_text: '',
conversation_title_section: '',
agent_title_mode: 'generate',
agent_title_prompt: '',
divider_conversation_title: '',
feedback_section: '',
feedback_placeholder: 'Add details (optional)',
feedback_submit_label: 'Submit',
feedback_cancel_label: 'Cancel',
capability_versions: {},
is_coworker: true,
preset_selector: '<string>',
languages: [],
default_language: '<string>',
persona: [{text: '<string>', definition: {type: 'doc', content: []}}],
tone: [{text: '<string>', definition: {type: 'doc', content: []}}],
extra_instructions: [{text: '<string>', definition: {type: 'doc', content: []}}],
tools: [],
workflows_parallel_enabled: false,
mcp_servers: [],
convert_unsupported_files_to_text: true,
skills: [],
subagents_enabled: false,
subagents: [],
guidelines_enabled: false,
guidelines: [],
glossary: [],
memories: [],
hidden_tools: [
'todos_read_todos',
'todos_add_todo',
'todos_write_todos',
'todos_update_todo_status',
'todos_remove_todo'
],
deployment_custom_instructions: '<string>',
variables_enabled: false,
variables: [],
workflows: [],
knowledge_bases: [],
multi_kb_search: false,
citation_instructions_enabled: false,
citation_instructions: [{text: '<string>', definition: {type: 'doc', content: []}}],
agent_files: [],
databases: [],
tables: [],
coworkers: [],
base_tools: [
{
title: 'Human in the Loop',
description: 'Human in the Loop',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'PersonStanding',
tool_display_message_start: 'Escalating to human operator...',
tool_display_message_end: 'Escalated to human operator',
requires_approval: false,
visible: true,
icon: 'PersonStanding',
bg_color: 'blue.50',
icon_color: 'blue.500',
deprecated: false,
type: 'human_in_the_loop',
has_timeout: false,
handover_message: 'You are now talking to the co-worker.'
},
{
title: 'Web Research',
description: 'Search the web for information',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'Globe',
tool_display_message_start: 'Searching the web...',
tool_display_message_end: 'Searched the web',
requires_approval: false,
visible: true,
icon: 'Globe',
bg_color: '#D1FADF',
icon_color: '#027A48',
deprecated: false,
type: 'web_research'
},
{
title: 'Files',
description: 'Attach, generate, and work with files.',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'Files',
tool_display_message_start: 'Working with files...',
tool_display_message_end: 'Done',
requires_approval: false,
visible: true,
icon: 'Files',
bg_color: '#EFF6FF',
icon_color: '#2B7FFF',
deprecated: false,
type: 'files',
allow_html_graphs: true,
show_inline: true,
custom_author_name: false,
author_name: '',
enable_python_sandbox: false,
enable_formula_eval: false,
experimental: false
},
{
title: 'Memory',
description: 'Persistent memory during a single conversation',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'Brain',
tool_display_message_start: 'Accessing memory...',
tool_display_message_end: 'Memory operation complete',
requires_approval: false,
visible: true,
icon: 'Brain',
bg_color: '#f5f3ff',
icon_color: '#8e51ff',
deprecated: false,
type: 'memory'
},
{
title: 'File System',
description: 'Access and read files in the current session',
category: 'QuickAction',
enabled: true,
tool_display_icon: 'FolderOpen',
tool_display_message_start: 'Accessing file system...',
tool_display_message_end: 'File system operation complete',
requires_approval: false,
visible: false,
icon: 'FolderOpen',
bg_color: '#fef3c7',
icon_color: '#f59e0b',
deprecated: false,
type: 'filesystem'
},
{
title: 'Code Execution',
description: 'Run Python code in a sandboxed environment',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'Terminal',
tool_display_message_start: 'Running code...',
tool_display_message_end: 'Code executed',
requires_approval: false,
visible: true,
icon: 'Terminal',
bg_color: '#fef9c3',
icon_color: '#ca8a04',
deprecated: false,
type: 'code_execution',
timeout: 60
},
{
title: 'Agent Memory',
description: 'Persistent memory across all conversations',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'BookOpen',
tool_display_message_start: 'Accessing agent memory...',
tool_display_message_end: 'Memory operation complete',
requires_approval: false,
visible: false,
icon: 'BookOpen',
bg_color: '#fef3c7',
icon_color: '#d97706',
deprecated: false,
type: 'agent_memory'
},
{
title: 'Documentation',
description: 'Search and read Noxus platform documentation',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'BookOpen',
tool_display_message_start: 'Searching documentation...',
tool_display_message_end: 'Documentation found',
requires_approval: false,
visible: true,
icon: 'BookOpen',
bg_color: '#EFF6FF',
icon_color: '#2B7FFF',
deprecated: false,
type: 'documentation'
},
{
title: 'Task Tracking',
description: 'Track and manage tasks during the conversation',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'ListTodo',
tool_display_message_start: 'Managing tasks...',
tool_display_message_end: 'Tasks updated',
requires_approval: false,
visible: true,
icon: 'ListTodo',
bg_color: '#f0fdf4',
icon_color: '#16a34a',
deprecated: false,
type: 'todos',
enable_subtasks: false
},
{
title: 'Image Generation',
description: 'Generate images from text prompts, shown inline in the chat.',
category: 'QuickAction',
enabled: false,
tool_display_icon: 'ImagePlus',
tool_display_message_start: 'Generating image...',
tool_display_message_end: 'Image generated',
requires_approval: false,
visible: true,
icon: 'ImagePlus',
bg_color: '#FDF4FF',
icon_color: '#C026D3',
deprecated: false,
type: 'image_generation'
}
],
actions: [],
insights_enabled: false,
insights_csat_enabled: false,
insights_csat_sampling_rate: 1,
insights_csat_agent_tool_enabled: false,
insights_csat_agent_tool_instructions: '',
insights_csat_auto_enabled: false,
insights_csat_auto_min_messages: 2,
insights_custom_definitions: [],
tool_grant_scope: 'workspace'
}
})
};
fetch('https://api.example.com/v1/agents', 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/v1/agents",
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([
'name' => '<string>',
'description' => '<string>',
'image_url' => '<string>',
'visible' => true,
'author_name' => '<string>',
'definition' => [
'pii_banner' => '',
'pii_info' => '',
'pii_lock' => false,
'pii_anonimization' => [
[
'value' => 'PERSON',
'label' => 'Name'
],
[
'value' => 'EMAIL_ADDRESS',
'label' => 'Email'
],
[
'value' => 'PHONE_NUMBER',
'label' => 'Phone Number'
],
[
'value' => 'CREDIT_CARD',
'label' => 'Credit Card'
]
],
'divider1' => '',
'guardrail_info' => '',
'guardrail_lock' => false,
'guardrail_latency_banner' => '',
'violence_and_hate' => [
'value' => 'Off',
'context' => ''
],
'sexual_content' => [
'value' => 'Off',
'context' => ''
],
'guns_and_weapons' => [
'value' => 'Off',
'context' => ''
],
'suicide' => [
'value' => 'Off',
'context' => ''
],
'crime' => [
'value' => 'Off',
'context' => ''
],
'toxicity' => [
'value' => 'Off',
'context' => ''
],
'bias' => [
'value' => 'Off',
'context' => ''
],
'profanity' => [
'value' => 'Off',
'context' => ''
],
'guardrails_scan_output' => false,
'guardrails_output_mode' => 'post_stream',
'divider2' => '',
'guardrail_action' => [
'value' => 'fail',
'label' => 'Fail/block run'
],
'guardrail_action_replace' => '',
'guardrail_action_human' => '',
'block_after_violations' => 0,
'block_message' => 'This conversation has been locked due to repeated safety violations. Please start a new conversation.',
'divider3' => '',
'prompt_defense' => '',
'prompt_lock' => false,
'jailbreak' => false,
'prompt_injection' => false,
'context_leak' => false,
'auto_model_pick' => false,
'auto_model_preference' => 'cost',
'model' => [
'preset:cost'
],
'parameter_preset' => 'default',
'intro' => '',
'basic_params_section' => '',
'max_tokens' => 64000,
'temperature' => 0.7,
'top_p' => 1,
'top_k' => 40,
'timeout' => 120,
'divider_7' => '',
'penalty_section' => '',
'presence_penalty' => 0.3,
'frequency_penalty' => 0.6,
'stop_sequences' => [
],
'divider_8' => '',
'reasoning_section' => '',
'enable_reasoning' => true,
'reasoning_effort' => 'Low',
'divider' => '',
'reliability_section' => '',
'max_retries_per_model' => 3,
'retry_on_status_codes' => [
429,
500,
502,
503,
504
],
'datacenter_fallback' => true,
'exclude_user_identity_from_prompt' => false,
'enable_prompt_caching' => true,
'protect_instructions_in_preview' => false,
'usage_limits_section' => '',
'usage_limits_maximum_request' => 1000,
'usage_limits_maximum_tokens' => 2000000,
'usage_limits_max_messages' => 100,
'usage_limits_agent_timeout' => 120,
'divider_11' => '',
'compaction_enabled' => true,
'compaction_strategy' => 'auto',
'compaction_threshold' => 0.75,
'compaction_tool_enabled' => false,
'tool_calling_section' => '',
'parallel_tool_calls' => true,
'tool_timeout' => 15,
'visuals_section' => '',
'hide_reasoning' => false,
'group_into_chain_of_thought' => true,
'chain_of_thought_final_answer_only' => false,
'hide_workflow_progress' => false,
'hide_error_banners' => true,
'tool_display_preset' => 'execution',
'minimal_caret_only' => true,
'message_footer_enabled' => false,
'message_footer' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'minimal_tool_message' => 'Thinking...',
'citation_style' => 'text',
'deduplicate_sources_by_url' => false,
'omit_citation_quotes' => false,
'show_source_images' => false,
'chat_input_placeholder' => 'Ask me anything...',
'divider_visuals' => '',
'transport_show_tool_calls' => false,
'transport_show_sources' => true,
'transport_show_thinking' => false,
'transport_allow_noop' => false,
'transport_thinking_text' => '',
'conversation_title_section' => '',
'agent_title_mode' => 'generate',
'agent_title_prompt' => '',
'divider_conversation_title' => '',
'feedback_section' => '',
'feedback_placeholder' => 'Add details (optional)',
'feedback_submit_label' => 'Submit',
'feedback_cancel_label' => 'Cancel',
'capability_versions' => [
],
'is_coworker' => true,
'preset_selector' => '<string>',
'languages' => [
],
'default_language' => '<string>',
'persona' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'tone' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'extra_instructions' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'tools' => [
],
'workflows_parallel_enabled' => false,
'mcp_servers' => [
],
'convert_unsupported_files_to_text' => true,
'skills' => [
],
'subagents_enabled' => false,
'subagents' => [
],
'guidelines_enabled' => false,
'guidelines' => [
],
'glossary' => [
],
'memories' => [
],
'hidden_tools' => [
'todos_read_todos',
'todos_add_todo',
'todos_write_todos',
'todos_update_todo_status',
'todos_remove_todo'
],
'deployment_custom_instructions' => '<string>',
'variables_enabled' => false,
'variables' => [
],
'workflows' => [
],
'knowledge_bases' => [
],
'multi_kb_search' => false,
'citation_instructions_enabled' => false,
'citation_instructions' => [
[
'text' => '<string>',
'definition' => [
'type' => 'doc',
'content' => [
]
]
]
],
'agent_files' => [
],
'databases' => [
],
'tables' => [
],
'coworkers' => [
],
'base_tools' => [
[
'title' => 'Human in the Loop',
'description' => 'Human in the Loop',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'PersonStanding',
'tool_display_message_start' => 'Escalating to human operator...',
'tool_display_message_end' => 'Escalated to human operator',
'requires_approval' => false,
'visible' => true,
'icon' => 'PersonStanding',
'bg_color' => 'blue.50',
'icon_color' => 'blue.500',
'deprecated' => false,
'type' => 'human_in_the_loop',
'has_timeout' => false,
'handover_message' => 'You are now talking to the co-worker.'
],
[
'title' => 'Web Research',
'description' => 'Search the web for information',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'Globe',
'tool_display_message_start' => 'Searching the web...',
'tool_display_message_end' => 'Searched the web',
'requires_approval' => false,
'visible' => true,
'icon' => 'Globe',
'bg_color' => '#D1FADF',
'icon_color' => '#027A48',
'deprecated' => false,
'type' => 'web_research'
],
[
'title' => 'Files',
'description' => 'Attach, generate, and work with files.',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'Files',
'tool_display_message_start' => 'Working with files...',
'tool_display_message_end' => 'Done',
'requires_approval' => false,
'visible' => true,
'icon' => 'Files',
'bg_color' => '#EFF6FF',
'icon_color' => '#2B7FFF',
'deprecated' => false,
'type' => 'files',
'allow_html_graphs' => true,
'show_inline' => true,
'custom_author_name' => false,
'author_name' => '',
'enable_python_sandbox' => false,
'enable_formula_eval' => false,
'experimental' => false
],
[
'title' => 'Memory',
'description' => 'Persistent memory during a single conversation',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'Brain',
'tool_display_message_start' => 'Accessing memory...',
'tool_display_message_end' => 'Memory operation complete',
'requires_approval' => false,
'visible' => true,
'icon' => 'Brain',
'bg_color' => '#f5f3ff',
'icon_color' => '#8e51ff',
'deprecated' => false,
'type' => 'memory'
],
[
'title' => 'File System',
'description' => 'Access and read files in the current session',
'category' => 'QuickAction',
'enabled' => true,
'tool_display_icon' => 'FolderOpen',
'tool_display_message_start' => 'Accessing file system...',
'tool_display_message_end' => 'File system operation complete',
'requires_approval' => false,
'visible' => false,
'icon' => 'FolderOpen',
'bg_color' => '#fef3c7',
'icon_color' => '#f59e0b',
'deprecated' => false,
'type' => 'filesystem'
],
[
'title' => 'Code Execution',
'description' => 'Run Python code in a sandboxed environment',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'Terminal',
'tool_display_message_start' => 'Running code...',
'tool_display_message_end' => 'Code executed',
'requires_approval' => false,
'visible' => true,
'icon' => 'Terminal',
'bg_color' => '#fef9c3',
'icon_color' => '#ca8a04',
'deprecated' => false,
'type' => 'code_execution',
'timeout' => 60
],
[
'title' => 'Agent Memory',
'description' => 'Persistent memory across all conversations',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'BookOpen',
'tool_display_message_start' => 'Accessing agent memory...',
'tool_display_message_end' => 'Memory operation complete',
'requires_approval' => false,
'visible' => false,
'icon' => 'BookOpen',
'bg_color' => '#fef3c7',
'icon_color' => '#d97706',
'deprecated' => false,
'type' => 'agent_memory'
],
[
'title' => 'Documentation',
'description' => 'Search and read Noxus platform documentation',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'BookOpen',
'tool_display_message_start' => 'Searching documentation...',
'tool_display_message_end' => 'Documentation found',
'requires_approval' => false,
'visible' => true,
'icon' => 'BookOpen',
'bg_color' => '#EFF6FF',
'icon_color' => '#2B7FFF',
'deprecated' => false,
'type' => 'documentation'
],
[
'title' => 'Task Tracking',
'description' => 'Track and manage tasks during the conversation',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'ListTodo',
'tool_display_message_start' => 'Managing tasks...',
'tool_display_message_end' => 'Tasks updated',
'requires_approval' => false,
'visible' => true,
'icon' => 'ListTodo',
'bg_color' => '#f0fdf4',
'icon_color' => '#16a34a',
'deprecated' => false,
'type' => 'todos',
'enable_subtasks' => false
],
[
'title' => 'Image Generation',
'description' => 'Generate images from text prompts, shown inline in the chat.',
'category' => 'QuickAction',
'enabled' => false,
'tool_display_icon' => 'ImagePlus',
'tool_display_message_start' => 'Generating image...',
'tool_display_message_end' => 'Image generated',
'requires_approval' => false,
'visible' => true,
'icon' => 'ImagePlus',
'bg_color' => '#FDF4FF',
'icon_color' => '#C026D3',
'deprecated' => false,
'type' => 'image_generation'
]
],
'actions' => [
],
'insights_enabled' => false,
'insights_csat_enabled' => false,
'insights_csat_sampling_rate' => 1,
'insights_csat_agent_tool_enabled' => false,
'insights_csat_agent_tool_instructions' => '',
'insights_csat_auto_enabled' => false,
'insights_csat_auto_min_messages' => 2,
'insights_custom_definitions' => [
],
'tool_grant_scope' => 'workspace'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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/v1/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"visible\": true,\n \"author_name\": \"<string>\",\n \"definition\": {\n \"pii_banner\": \"\",\n \"pii_info\": \"\",\n \"pii_lock\": false,\n \"pii_anonimization\": [\n {\n \"value\": \"PERSON\",\n \"label\": \"Name\"\n },\n {\n \"value\": \"EMAIL_ADDRESS\",\n \"label\": \"Email\"\n },\n {\n \"value\": \"PHONE_NUMBER\",\n \"label\": \"Phone Number\"\n },\n {\n \"value\": \"CREDIT_CARD\",\n \"label\": \"Credit Card\"\n }\n ],\n \"divider1\": \"\",\n \"guardrail_info\": \"\",\n \"guardrail_lock\": false,\n \"guardrail_latency_banner\": \"\",\n \"violence_and_hate\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"sexual_content\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guns_and_weapons\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"suicide\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"crime\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"toxicity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"bias\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"profanity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guardrails_scan_output\": false,\n \"guardrails_output_mode\": \"post_stream\",\n \"divider2\": \"\",\n \"guardrail_action\": {\n \"value\": \"fail\",\n \"label\": \"Fail/block run\"\n },\n \"guardrail_action_replace\": \"\",\n \"guardrail_action_human\": \"\",\n \"block_after_violations\": 0,\n \"block_message\": \"This conversation has been locked due to repeated safety violations. Please start a new conversation.\",\n \"divider3\": \"\",\n \"prompt_defense\": \"\",\n \"prompt_lock\": false,\n \"jailbreak\": false,\n \"prompt_injection\": false,\n \"context_leak\": false,\n \"auto_model_pick\": false,\n \"auto_model_preference\": \"cost\",\n \"model\": [\n \"preset:cost\"\n ],\n \"parameter_preset\": \"default\",\n \"intro\": \"\",\n \"basic_params_section\": \"\",\n \"max_tokens\": 64000,\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"top_k\": 40,\n \"timeout\": 120,\n \"divider_7\": \"\",\n \"penalty_section\": \"\",\n \"presence_penalty\": 0.3,\n \"frequency_penalty\": 0.6,\n \"stop_sequences\": [],\n \"divider_8\": \"\",\n \"reasoning_section\": \"\",\n \"enable_reasoning\": true,\n \"reasoning_effort\": \"Low\",\n \"divider\": \"\",\n \"reliability_section\": \"\",\n \"max_retries_per_model\": 3,\n \"retry_on_status_codes\": [\n 429,\n 500,\n 502,\n 503,\n 504\n ],\n \"datacenter_fallback\": true,\n \"exclude_user_identity_from_prompt\": false,\n \"enable_prompt_caching\": true,\n \"protect_instructions_in_preview\": false,\n \"usage_limits_section\": \"\",\n \"usage_limits_maximum_request\": 1000,\n \"usage_limits_maximum_tokens\": 2000000,\n \"usage_limits_max_messages\": 100,\n \"usage_limits_agent_timeout\": 120,\n \"divider_11\": \"\",\n \"compaction_enabled\": true,\n \"compaction_strategy\": \"auto\",\n \"compaction_threshold\": 0.75,\n \"compaction_tool_enabled\": false,\n \"tool_calling_section\": \"\",\n \"parallel_tool_calls\": true,\n \"tool_timeout\": 15,\n \"visuals_section\": \"\",\n \"hide_reasoning\": false,\n \"group_into_chain_of_thought\": true,\n \"chain_of_thought_final_answer_only\": false,\n \"hide_workflow_progress\": false,\n \"hide_error_banners\": true,\n \"tool_display_preset\": \"execution\",\n \"minimal_caret_only\": true,\n \"message_footer_enabled\": false,\n \"message_footer\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"minimal_tool_message\": \"Thinking...\",\n \"citation_style\": \"text\",\n \"deduplicate_sources_by_url\": false,\n \"omit_citation_quotes\": false,\n \"show_source_images\": false,\n \"chat_input_placeholder\": \"Ask me anything...\",\n \"divider_visuals\": \"\",\n \"transport_show_tool_calls\": false,\n \"transport_show_sources\": true,\n \"transport_show_thinking\": false,\n \"transport_allow_noop\": false,\n \"transport_thinking_text\": \"\",\n \"conversation_title_section\": \"\",\n \"agent_title_mode\": \"generate\",\n \"agent_title_prompt\": \"\",\n \"divider_conversation_title\": \"\",\n \"feedback_section\": \"\",\n \"feedback_placeholder\": \"Add details (optional)\",\n \"feedback_submit_label\": \"Submit\",\n \"feedback_cancel_label\": \"Cancel\",\n \"capability_versions\": {},\n \"is_coworker\": true,\n \"preset_selector\": \"<string>\",\n \"languages\": [],\n \"default_language\": \"<string>\",\n \"persona\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tone\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"extra_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tools\": [],\n \"workflows_parallel_enabled\": false,\n \"mcp_servers\": [],\n \"convert_unsupported_files_to_text\": true,\n \"skills\": [],\n \"subagents_enabled\": false,\n \"subagents\": [],\n \"guidelines_enabled\": false,\n \"guidelines\": [],\n \"glossary\": [],\n \"memories\": [],\n \"hidden_tools\": [\n \"todos_read_todos\",\n \"todos_add_todo\",\n \"todos_write_todos\",\n \"todos_update_todo_status\",\n \"todos_remove_todo\"\n ],\n \"deployment_custom_instructions\": \"<string>\",\n \"variables_enabled\": false,\n \"variables\": [],\n \"workflows\": [],\n \"knowledge_bases\": [],\n \"multi_kb_search\": false,\n \"citation_instructions_enabled\": false,\n \"citation_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"agent_files\": [],\n \"databases\": [],\n \"tables\": [],\n \"coworkers\": [],\n \"base_tools\": [\n {\n \"title\": \"Human in the Loop\",\n \"description\": \"Human in the Loop\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"PersonStanding\",\n \"tool_display_message_start\": \"Escalating to human operator...\",\n \"tool_display_message_end\": \"Escalated to human operator\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"PersonStanding\",\n \"bg_color\": \"blue.50\",\n \"icon_color\": \"blue.500\",\n \"deprecated\": false,\n \"type\": \"human_in_the_loop\",\n \"has_timeout\": false,\n \"handover_message\": \"You are now talking to the co-worker.\"\n },\n {\n \"title\": \"Web Research\",\n \"description\": \"Search the web for information\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Globe\",\n \"tool_display_message_start\": \"Searching the web...\",\n \"tool_display_message_end\": \"Searched the web\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Globe\",\n \"bg_color\": \"#D1FADF\",\n \"icon_color\": \"#027A48\",\n \"deprecated\": false,\n \"type\": \"web_research\"\n },\n {\n \"title\": \"Files\",\n \"description\": \"Attach, generate, and work with files.\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Files\",\n \"tool_display_message_start\": \"Working with files...\",\n \"tool_display_message_end\": \"Done\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Files\",\n \"bg_color\": \"#EFF6FF\",\n \"icon_color\": \"#2B7FFF\",\n \"deprecated\": false,\n \"type\": \"files\",\n \"allow_html_graphs\": true,\n \"show_inline\": true,\n \"custom_author_name\": false,\n \"author_name\": \"\",\n \"enable_python_sandbox\": false,\n \"enable_formula_eval\": false,\n \"experimental\": false\n },\n {\n \"title\": \"Memory\",\n \"description\": \"Persistent memory during a single conversation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Brain\",\n \"tool_display_message_start\": \"Accessing memory...\",\n \"tool_display_message_end\": \"Memory operation complete\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Brain\",\n \"bg_color\": \"#f5f3ff\",\n \"icon_color\": \"#8e51ff\",\n \"deprecated\": false,\n \"type\": \"memory\"\n },\n {\n \"title\": \"File System\",\n \"description\": \"Access and read files in the current session\",\n \"category\": \"QuickAction\",\n \"enabled\": true,\n \"tool_display_icon\": \"FolderOpen\",\n \"tool_display_message_start\": \"Accessing file system...\",\n \"tool_display_message_end\": \"File system operation complete\",\n \"requires_approval\": false,\n \"visible\": false,\n \"icon\": \"FolderOpen\",\n \"bg_color\": \"#fef3c7\",\n \"icon_color\": \"#f59e0b\",\n \"deprecated\": false,\n \"type\": \"filesystem\"\n },\n {\n \"title\": \"Code Execution\",\n \"description\": \"Run Python code in a sandboxed environment\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Terminal\",\n \"tool_display_message_start\": \"Running code...\",\n \"tool_display_message_end\": \"Code executed\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Terminal\",\n \"bg_color\": \"#fef9c3\",\n \"icon_color\": \"#ca8a04\",\n \"deprecated\": false,\n \"type\": \"code_execution\",\n \"timeout\": 60\n },\n {\n \"title\": \"Agent Memory\",\n \"description\": \"Persistent memory across all conversations\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"BookOpen\",\n \"tool_display_message_start\": \"Accessing agent memory...\",\n \"tool_display_message_end\": \"Memory operation complete\",\n \"requires_approval\": false,\n \"visible\": false,\n \"icon\": \"BookOpen\",\n \"bg_color\": \"#fef3c7\",\n \"icon_color\": \"#d97706\",\n \"deprecated\": false,\n \"type\": \"agent_memory\"\n },\n {\n \"title\": \"Documentation\",\n \"description\": \"Search and read Noxus platform documentation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"BookOpen\",\n \"tool_display_message_start\": \"Searching documentation...\",\n \"tool_display_message_end\": \"Documentation found\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"BookOpen\",\n \"bg_color\": \"#EFF6FF\",\n \"icon_color\": \"#2B7FFF\",\n \"deprecated\": false,\n \"type\": \"documentation\"\n },\n {\n \"title\": \"Task Tracking\",\n \"description\": \"Track and manage tasks during the conversation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"ListTodo\",\n \"tool_display_message_start\": \"Managing tasks...\",\n \"tool_display_message_end\": \"Tasks updated\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"ListTodo\",\n \"bg_color\": \"#f0fdf4\",\n \"icon_color\": \"#16a34a\",\n \"deprecated\": false,\n \"type\": \"todos\",\n \"enable_subtasks\": false\n },\n {\n \"title\": \"Image Generation\",\n \"description\": \"Generate images from text prompts, shown inline in the chat.\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"ImagePlus\",\n \"tool_display_message_start\": \"Generating image...\",\n \"tool_display_message_end\": \"Image generated\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"ImagePlus\",\n \"bg_color\": \"#FDF4FF\",\n \"icon_color\": \"#C026D3\",\n \"deprecated\": false,\n \"type\": \"image_generation\"\n }\n ],\n \"actions\": [],\n \"insights_enabled\": false,\n \"insights_csat_enabled\": false,\n \"insights_csat_sampling_rate\": 1,\n \"insights_csat_agent_tool_enabled\": false,\n \"insights_csat_agent_tool_instructions\": \"\",\n \"insights_csat_auto_enabled\": false,\n \"insights_csat_auto_min_messages\": 2,\n \"insights_custom_definitions\": [],\n \"tool_grant_scope\": \"workspace\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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/v1/agents")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"visible\": true,\n \"author_name\": \"<string>\",\n \"definition\": {\n \"pii_banner\": \"\",\n \"pii_info\": \"\",\n \"pii_lock\": false,\n \"pii_anonimization\": [\n {\n \"value\": \"PERSON\",\n \"label\": \"Name\"\n },\n {\n \"value\": \"EMAIL_ADDRESS\",\n \"label\": \"Email\"\n },\n {\n \"value\": \"PHONE_NUMBER\",\n \"label\": \"Phone Number\"\n },\n {\n \"value\": \"CREDIT_CARD\",\n \"label\": \"Credit Card\"\n }\n ],\n \"divider1\": \"\",\n \"guardrail_info\": \"\",\n \"guardrail_lock\": false,\n \"guardrail_latency_banner\": \"\",\n \"violence_and_hate\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"sexual_content\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guns_and_weapons\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"suicide\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"crime\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"toxicity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"bias\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"profanity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guardrails_scan_output\": false,\n \"guardrails_output_mode\": \"post_stream\",\n \"divider2\": \"\",\n \"guardrail_action\": {\n \"value\": \"fail\",\n \"label\": \"Fail/block run\"\n },\n \"guardrail_action_replace\": \"\",\n \"guardrail_action_human\": \"\",\n \"block_after_violations\": 0,\n \"block_message\": \"This conversation has been locked due to repeated safety violations. Please start a new conversation.\",\n \"divider3\": \"\",\n \"prompt_defense\": \"\",\n \"prompt_lock\": false,\n \"jailbreak\": false,\n \"prompt_injection\": false,\n \"context_leak\": false,\n \"auto_model_pick\": false,\n \"auto_model_preference\": \"cost\",\n \"model\": [\n \"preset:cost\"\n ],\n \"parameter_preset\": \"default\",\n \"intro\": \"\",\n \"basic_params_section\": \"\",\n \"max_tokens\": 64000,\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"top_k\": 40,\n \"timeout\": 120,\n \"divider_7\": \"\",\n \"penalty_section\": \"\",\n \"presence_penalty\": 0.3,\n \"frequency_penalty\": 0.6,\n \"stop_sequences\": [],\n \"divider_8\": \"\",\n \"reasoning_section\": \"\",\n \"enable_reasoning\": true,\n \"reasoning_effort\": \"Low\",\n \"divider\": \"\",\n \"reliability_section\": \"\",\n \"max_retries_per_model\": 3,\n \"retry_on_status_codes\": [\n 429,\n 500,\n 502,\n 503,\n 504\n ],\n \"datacenter_fallback\": true,\n \"exclude_user_identity_from_prompt\": false,\n \"enable_prompt_caching\": true,\n \"protect_instructions_in_preview\": false,\n \"usage_limits_section\": \"\",\n \"usage_limits_maximum_request\": 1000,\n \"usage_limits_maximum_tokens\": 2000000,\n \"usage_limits_max_messages\": 100,\n \"usage_limits_agent_timeout\": 120,\n \"divider_11\": \"\",\n \"compaction_enabled\": true,\n \"compaction_strategy\": \"auto\",\n \"compaction_threshold\": 0.75,\n \"compaction_tool_enabled\": false,\n \"tool_calling_section\": \"\",\n \"parallel_tool_calls\": true,\n \"tool_timeout\": 15,\n \"visuals_section\": \"\",\n \"hide_reasoning\": false,\n \"group_into_chain_of_thought\": true,\n \"chain_of_thought_final_answer_only\": false,\n \"hide_workflow_progress\": false,\n \"hide_error_banners\": true,\n \"tool_display_preset\": \"execution\",\n \"minimal_caret_only\": true,\n \"message_footer_enabled\": false,\n \"message_footer\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"minimal_tool_message\": \"Thinking...\",\n \"citation_style\": \"text\",\n \"deduplicate_sources_by_url\": false,\n \"omit_citation_quotes\": false,\n \"show_source_images\": false,\n \"chat_input_placeholder\": \"Ask me anything...\",\n \"divider_visuals\": \"\",\n \"transport_show_tool_calls\": false,\n \"transport_show_sources\": true,\n \"transport_show_thinking\": false,\n \"transport_allow_noop\": false,\n \"transport_thinking_text\": \"\",\n \"conversation_title_section\": \"\",\n \"agent_title_mode\": \"generate\",\n \"agent_title_prompt\": \"\",\n \"divider_conversation_title\": \"\",\n \"feedback_section\": \"\",\n \"feedback_placeholder\": \"Add details (optional)\",\n \"feedback_submit_label\": \"Submit\",\n \"feedback_cancel_label\": \"Cancel\",\n \"capability_versions\": {},\n \"is_coworker\": true,\n \"preset_selector\": \"<string>\",\n \"languages\": [],\n \"default_language\": \"<string>\",\n \"persona\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tone\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"extra_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tools\": [],\n \"workflows_parallel_enabled\": false,\n \"mcp_servers\": [],\n \"convert_unsupported_files_to_text\": true,\n \"skills\": [],\n \"subagents_enabled\": false,\n \"subagents\": [],\n \"guidelines_enabled\": false,\n \"guidelines\": [],\n \"glossary\": [],\n \"memories\": [],\n \"hidden_tools\": [\n \"todos_read_todos\",\n \"todos_add_todo\",\n \"todos_write_todos\",\n \"todos_update_todo_status\",\n \"todos_remove_todo\"\n ],\n \"deployment_custom_instructions\": \"<string>\",\n \"variables_enabled\": false,\n \"variables\": [],\n \"workflows\": [],\n \"knowledge_bases\": [],\n \"multi_kb_search\": false,\n \"citation_instructions_enabled\": false,\n \"citation_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"agent_files\": [],\n \"databases\": [],\n \"tables\": [],\n \"coworkers\": [],\n \"base_tools\": [\n {\n \"title\": \"Human in the Loop\",\n \"description\": \"Human in the Loop\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"PersonStanding\",\n \"tool_display_message_start\": \"Escalating to human operator...\",\n \"tool_display_message_end\": \"Escalated to human operator\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"PersonStanding\",\n \"bg_color\": \"blue.50\",\n \"icon_color\": \"blue.500\",\n \"deprecated\": false,\n \"type\": \"human_in_the_loop\",\n \"has_timeout\": false,\n \"handover_message\": \"You are now talking to the co-worker.\"\n },\n {\n \"title\": \"Web Research\",\n \"description\": \"Search the web for information\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Globe\",\n \"tool_display_message_start\": \"Searching the web...\",\n \"tool_display_message_end\": \"Searched the web\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Globe\",\n \"bg_color\": \"#D1FADF\",\n \"icon_color\": \"#027A48\",\n \"deprecated\": false,\n \"type\": \"web_research\"\n },\n {\n \"title\": \"Files\",\n \"description\": \"Attach, generate, and work with files.\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Files\",\n \"tool_display_message_start\": \"Working with files...\",\n \"tool_display_message_end\": \"Done\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Files\",\n \"bg_color\": \"#EFF6FF\",\n \"icon_color\": \"#2B7FFF\",\n \"deprecated\": false,\n \"type\": \"files\",\n \"allow_html_graphs\": true,\n \"show_inline\": true,\n \"custom_author_name\": false,\n \"author_name\": \"\",\n \"enable_python_sandbox\": false,\n \"enable_formula_eval\": false,\n \"experimental\": false\n },\n {\n \"title\": \"Memory\",\n \"description\": \"Persistent memory during a single conversation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Brain\",\n \"tool_display_message_start\": \"Accessing memory...\",\n \"tool_display_message_end\": \"Memory operation complete\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Brain\",\n \"bg_color\": \"#f5f3ff\",\n \"icon_color\": \"#8e51ff\",\n \"deprecated\": false,\n \"type\": \"memory\"\n },\n {\n \"title\": \"File System\",\n \"description\": \"Access and read files in the current session\",\n \"category\": \"QuickAction\",\n \"enabled\": true,\n \"tool_display_icon\": \"FolderOpen\",\n \"tool_display_message_start\": \"Accessing file system...\",\n \"tool_display_message_end\": \"File system operation complete\",\n \"requires_approval\": false,\n \"visible\": false,\n \"icon\": \"FolderOpen\",\n \"bg_color\": \"#fef3c7\",\n \"icon_color\": \"#f59e0b\",\n \"deprecated\": false,\n \"type\": \"filesystem\"\n },\n {\n \"title\": \"Code Execution\",\n \"description\": \"Run Python code in a sandboxed environment\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Terminal\",\n \"tool_display_message_start\": \"Running code...\",\n \"tool_display_message_end\": \"Code executed\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Terminal\",\n \"bg_color\": \"#fef9c3\",\n \"icon_color\": \"#ca8a04\",\n \"deprecated\": false,\n \"type\": \"code_execution\",\n \"timeout\": 60\n },\n {\n \"title\": \"Agent Memory\",\n \"description\": \"Persistent memory across all conversations\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"BookOpen\",\n \"tool_display_message_start\": \"Accessing agent memory...\",\n \"tool_display_message_end\": \"Memory operation complete\",\n \"requires_approval\": false,\n \"visible\": false,\n \"icon\": \"BookOpen\",\n \"bg_color\": \"#fef3c7\",\n \"icon_color\": \"#d97706\",\n \"deprecated\": false,\n \"type\": \"agent_memory\"\n },\n {\n \"title\": \"Documentation\",\n \"description\": \"Search and read Noxus platform documentation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"BookOpen\",\n \"tool_display_message_start\": \"Searching documentation...\",\n \"tool_display_message_end\": \"Documentation found\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"BookOpen\",\n \"bg_color\": \"#EFF6FF\",\n \"icon_color\": \"#2B7FFF\",\n \"deprecated\": false,\n \"type\": \"documentation\"\n },\n {\n \"title\": \"Task Tracking\",\n \"description\": \"Track and manage tasks during the conversation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"ListTodo\",\n \"tool_display_message_start\": \"Managing tasks...\",\n \"tool_display_message_end\": \"Tasks updated\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"ListTodo\",\n \"bg_color\": \"#f0fdf4\",\n \"icon_color\": \"#16a34a\",\n \"deprecated\": false,\n \"type\": \"todos\",\n \"enable_subtasks\": false\n },\n {\n \"title\": \"Image Generation\",\n \"description\": \"Generate images from text prompts, shown inline in the chat.\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"ImagePlus\",\n \"tool_display_message_start\": \"Generating image...\",\n \"tool_display_message_end\": \"Image generated\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"ImagePlus\",\n \"bg_color\": \"#FDF4FF\",\n \"icon_color\": \"#C026D3\",\n \"deprecated\": false,\n \"type\": \"image_generation\"\n }\n ],\n \"actions\": [],\n \"insights_enabled\": false,\n \"insights_csat_enabled\": false,\n \"insights_csat_sampling_rate\": 1,\n \"insights_csat_agent_tool_enabled\": false,\n \"insights_csat_agent_tool_instructions\": \"\",\n \"insights_csat_auto_enabled\": false,\n \"insights_csat_auto_min_messages\": 2,\n \"insights_custom_definitions\": [],\n \"tool_grant_scope\": \"workspace\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"visible\": true,\n \"author_name\": \"<string>\",\n \"definition\": {\n \"pii_banner\": \"\",\n \"pii_info\": \"\",\n \"pii_lock\": false,\n \"pii_anonimization\": [\n {\n \"value\": \"PERSON\",\n \"label\": \"Name\"\n },\n {\n \"value\": \"EMAIL_ADDRESS\",\n \"label\": \"Email\"\n },\n {\n \"value\": \"PHONE_NUMBER\",\n \"label\": \"Phone Number\"\n },\n {\n \"value\": \"CREDIT_CARD\",\n \"label\": \"Credit Card\"\n }\n ],\n \"divider1\": \"\",\n \"guardrail_info\": \"\",\n \"guardrail_lock\": false,\n \"guardrail_latency_banner\": \"\",\n \"violence_and_hate\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"sexual_content\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guns_and_weapons\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"suicide\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"crime\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"toxicity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"bias\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"profanity\": {\n \"value\": \"Off\",\n \"context\": \"\"\n },\n \"guardrails_scan_output\": false,\n \"guardrails_output_mode\": \"post_stream\",\n \"divider2\": \"\",\n \"guardrail_action\": {\n \"value\": \"fail\",\n \"label\": \"Fail/block run\"\n },\n \"guardrail_action_replace\": \"\",\n \"guardrail_action_human\": \"\",\n \"block_after_violations\": 0,\n \"block_message\": \"This conversation has been locked due to repeated safety violations. Please start a new conversation.\",\n \"divider3\": \"\",\n \"prompt_defense\": \"\",\n \"prompt_lock\": false,\n \"jailbreak\": false,\n \"prompt_injection\": false,\n \"context_leak\": false,\n \"auto_model_pick\": false,\n \"auto_model_preference\": \"cost\",\n \"model\": [\n \"preset:cost\"\n ],\n \"parameter_preset\": \"default\",\n \"intro\": \"\",\n \"basic_params_section\": \"\",\n \"max_tokens\": 64000,\n \"temperature\": 0.7,\n \"top_p\": 1,\n \"top_k\": 40,\n \"timeout\": 120,\n \"divider_7\": \"\",\n \"penalty_section\": \"\",\n \"presence_penalty\": 0.3,\n \"frequency_penalty\": 0.6,\n \"stop_sequences\": [],\n \"divider_8\": \"\",\n \"reasoning_section\": \"\",\n \"enable_reasoning\": true,\n \"reasoning_effort\": \"Low\",\n \"divider\": \"\",\n \"reliability_section\": \"\",\n \"max_retries_per_model\": 3,\n \"retry_on_status_codes\": [\n 429,\n 500,\n 502,\n 503,\n 504\n ],\n \"datacenter_fallback\": true,\n \"exclude_user_identity_from_prompt\": false,\n \"enable_prompt_caching\": true,\n \"protect_instructions_in_preview\": false,\n \"usage_limits_section\": \"\",\n \"usage_limits_maximum_request\": 1000,\n \"usage_limits_maximum_tokens\": 2000000,\n \"usage_limits_max_messages\": 100,\n \"usage_limits_agent_timeout\": 120,\n \"divider_11\": \"\",\n \"compaction_enabled\": true,\n \"compaction_strategy\": \"auto\",\n \"compaction_threshold\": 0.75,\n \"compaction_tool_enabled\": false,\n \"tool_calling_section\": \"\",\n \"parallel_tool_calls\": true,\n \"tool_timeout\": 15,\n \"visuals_section\": \"\",\n \"hide_reasoning\": false,\n \"group_into_chain_of_thought\": true,\n \"chain_of_thought_final_answer_only\": false,\n \"hide_workflow_progress\": false,\n \"hide_error_banners\": true,\n \"tool_display_preset\": \"execution\",\n \"minimal_caret_only\": true,\n \"message_footer_enabled\": false,\n \"message_footer\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"minimal_tool_message\": \"Thinking...\",\n \"citation_style\": \"text\",\n \"deduplicate_sources_by_url\": false,\n \"omit_citation_quotes\": false,\n \"show_source_images\": false,\n \"chat_input_placeholder\": \"Ask me anything...\",\n \"divider_visuals\": \"\",\n \"transport_show_tool_calls\": false,\n \"transport_show_sources\": true,\n \"transport_show_thinking\": false,\n \"transport_allow_noop\": false,\n \"transport_thinking_text\": \"\",\n \"conversation_title_section\": \"\",\n \"agent_title_mode\": \"generate\",\n \"agent_title_prompt\": \"\",\n \"divider_conversation_title\": \"\",\n \"feedback_section\": \"\",\n \"feedback_placeholder\": \"Add details (optional)\",\n \"feedback_submit_label\": \"Submit\",\n \"feedback_cancel_label\": \"Cancel\",\n \"capability_versions\": {},\n \"is_coworker\": true,\n \"preset_selector\": \"<string>\",\n \"languages\": [],\n \"default_language\": \"<string>\",\n \"persona\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tone\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"extra_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"tools\": [],\n \"workflows_parallel_enabled\": false,\n \"mcp_servers\": [],\n \"convert_unsupported_files_to_text\": true,\n \"skills\": [],\n \"subagents_enabled\": false,\n \"subagents\": [],\n \"guidelines_enabled\": false,\n \"guidelines\": [],\n \"glossary\": [],\n \"memories\": [],\n \"hidden_tools\": [\n \"todos_read_todos\",\n \"todos_add_todo\",\n \"todos_write_todos\",\n \"todos_update_todo_status\",\n \"todos_remove_todo\"\n ],\n \"deployment_custom_instructions\": \"<string>\",\n \"variables_enabled\": false,\n \"variables\": [],\n \"workflows\": [],\n \"knowledge_bases\": [],\n \"multi_kb_search\": false,\n \"citation_instructions_enabled\": false,\n \"citation_instructions\": [\n {\n \"text\": \"<string>\",\n \"definition\": {\n \"type\": \"doc\",\n \"content\": []\n }\n }\n ],\n \"agent_files\": [],\n \"databases\": [],\n \"tables\": [],\n \"coworkers\": [],\n \"base_tools\": [\n {\n \"title\": \"Human in the Loop\",\n \"description\": \"Human in the Loop\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"PersonStanding\",\n \"tool_display_message_start\": \"Escalating to human operator...\",\n \"tool_display_message_end\": \"Escalated to human operator\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"PersonStanding\",\n \"bg_color\": \"blue.50\",\n \"icon_color\": \"blue.500\",\n \"deprecated\": false,\n \"type\": \"human_in_the_loop\",\n \"has_timeout\": false,\n \"handover_message\": \"You are now talking to the co-worker.\"\n },\n {\n \"title\": \"Web Research\",\n \"description\": \"Search the web for information\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Globe\",\n \"tool_display_message_start\": \"Searching the web...\",\n \"tool_display_message_end\": \"Searched the web\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Globe\",\n \"bg_color\": \"#D1FADF\",\n \"icon_color\": \"#027A48\",\n \"deprecated\": false,\n \"type\": \"web_research\"\n },\n {\n \"title\": \"Files\",\n \"description\": \"Attach, generate, and work with files.\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Files\",\n \"tool_display_message_start\": \"Working with files...\",\n \"tool_display_message_end\": \"Done\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Files\",\n \"bg_color\": \"#EFF6FF\",\n \"icon_color\": \"#2B7FFF\",\n \"deprecated\": false,\n \"type\": \"files\",\n \"allow_html_graphs\": true,\n \"show_inline\": true,\n \"custom_author_name\": false,\n \"author_name\": \"\",\n \"enable_python_sandbox\": false,\n \"enable_formula_eval\": false,\n \"experimental\": false\n },\n {\n \"title\": \"Memory\",\n \"description\": \"Persistent memory during a single conversation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Brain\",\n \"tool_display_message_start\": \"Accessing memory...\",\n \"tool_display_message_end\": \"Memory operation complete\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Brain\",\n \"bg_color\": \"#f5f3ff\",\n \"icon_color\": \"#8e51ff\",\n \"deprecated\": false,\n \"type\": \"memory\"\n },\n {\n \"title\": \"File System\",\n \"description\": \"Access and read files in the current session\",\n \"category\": \"QuickAction\",\n \"enabled\": true,\n \"tool_display_icon\": \"FolderOpen\",\n \"tool_display_message_start\": \"Accessing file system...\",\n \"tool_display_message_end\": \"File system operation complete\",\n \"requires_approval\": false,\n \"visible\": false,\n \"icon\": \"FolderOpen\",\n \"bg_color\": \"#fef3c7\",\n \"icon_color\": \"#f59e0b\",\n \"deprecated\": false,\n \"type\": \"filesystem\"\n },\n {\n \"title\": \"Code Execution\",\n \"description\": \"Run Python code in a sandboxed environment\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"Terminal\",\n \"tool_display_message_start\": \"Running code...\",\n \"tool_display_message_end\": \"Code executed\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"Terminal\",\n \"bg_color\": \"#fef9c3\",\n \"icon_color\": \"#ca8a04\",\n \"deprecated\": false,\n \"type\": \"code_execution\",\n \"timeout\": 60\n },\n {\n \"title\": \"Agent Memory\",\n \"description\": \"Persistent memory across all conversations\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"BookOpen\",\n \"tool_display_message_start\": \"Accessing agent memory...\",\n \"tool_display_message_end\": \"Memory operation complete\",\n \"requires_approval\": false,\n \"visible\": false,\n \"icon\": \"BookOpen\",\n \"bg_color\": \"#fef3c7\",\n \"icon_color\": \"#d97706\",\n \"deprecated\": false,\n \"type\": \"agent_memory\"\n },\n {\n \"title\": \"Documentation\",\n \"description\": \"Search and read Noxus platform documentation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"BookOpen\",\n \"tool_display_message_start\": \"Searching documentation...\",\n \"tool_display_message_end\": \"Documentation found\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"BookOpen\",\n \"bg_color\": \"#EFF6FF\",\n \"icon_color\": \"#2B7FFF\",\n \"deprecated\": false,\n \"type\": \"documentation\"\n },\n {\n \"title\": \"Task Tracking\",\n \"description\": \"Track and manage tasks during the conversation\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"ListTodo\",\n \"tool_display_message_start\": \"Managing tasks...\",\n \"tool_display_message_end\": \"Tasks updated\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"ListTodo\",\n \"bg_color\": \"#f0fdf4\",\n \"icon_color\": \"#16a34a\",\n \"deprecated\": false,\n \"type\": \"todos\",\n \"enable_subtasks\": false\n },\n {\n \"title\": \"Image Generation\",\n \"description\": \"Generate images from text prompts, shown inline in the chat.\",\n \"category\": \"QuickAction\",\n \"enabled\": false,\n \"tool_display_icon\": \"ImagePlus\",\n \"tool_display_message_start\": \"Generating image...\",\n \"tool_display_message_end\": \"Image generated\",\n \"requires_approval\": false,\n \"visible\": true,\n \"icon\": \"ImagePlus\",\n \"bg_color\": \"#FDF4FF\",\n \"icon_color\": \"#C026D3\",\n \"deprecated\": false,\n \"type\": \"image_generation\"\n }\n ],\n \"actions\": [],\n \"insights_enabled\": false,\n \"insights_csat_enabled\": false,\n \"insights_csat_sampling_rate\": 1,\n \"insights_csat_agent_tool_enabled\": false,\n \"insights_csat_agent_tool_instructions\": \"\",\n \"insights_csat_auto_enabled\": false,\n \"insights_csat_auto_min_messages\": 2,\n \"insights_custom_definitions\": [],\n \"tool_grant_scope\": \"workspace\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"definition": {},
"description": "<string>",
"visible": true,
"image_url": "<string>",
"last_updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"app_settings_v2": {
"is_active": false,
"version_id": "<string>",
"interface_type": "slack",
"extra_settings": {},
"published_at": "2023-11-07T05:31:56Z"
},
"is_app_published": true,
"allow_public_access": false,
"meta": {
"template_id": "<string>",
"is_genie": true,
"source": "genie"
},
"draft_definition": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Body
application/json
Response
Successful Response
Assistant schema for the public SDK API with TipTap fields resolved to strings.
Show child attributes
Show child attributes
Show child attributes
Show child attributes