Save agent draft

curl --request PATCH \
  --url https://api.sidenet.ai/v1/agents/{id}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "instructions": [
    {
      "type": "prompt_block_ref",
      "id": "d41a8f6b-9c27-4b13-a5e8-2f60c1d7b394"
    },
    {
      "type": "text",
      "content": "Answer in {{locale || 'English'}}."
    }
  ],
  "model_slug": "anthropic/claude-sonnet-4-5",
  "policy_slug": "policy/fastest-sonnet",
  "model_options": {
    "reasoningEffort": "medium"
  },
  "model_settings": {
    "temperature": 0.2
  },
  "max_steps": 8,
  "workflows": [
    {
      "workflow_id": "4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641"
    }
  ],
  "agentTools": [
    {
      "tool_id": "c07f2b95-8d41-4e63-a029-5f7b1c8d3e40",
      "provider_id": "8d3b1a75-6c02-4e59-b84f-27a9d5e10c63"
    }
  ],
  "name": "Support agent",
  "description": "Answers billing and account questions",
  "scorers": [],
  "agents": [
    {
      "agentId": "6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10"
    }
  ],
  "memory": {
    "lastMessages": 20,
    "semanticRecall": false
  }
}
EOF

import requests

url = "https://api.sidenet.ai/v1/agents/{id}/draft"

payload = {
    "instructions": [
        {
            "type": "prompt_block_ref",
            "id": "d41a8f6b-9c27-4b13-a5e8-2f60c1d7b394"
        },
        {
            "type": "text",
            "content": "Answer in {{locale || 'English'}}."
        }
    ],
    "model_slug": "anthropic/claude-sonnet-4-5",
    "policy_slug": "policy/fastest-sonnet",
    "model_options": { "reasoningEffort": "medium" },
    "model_settings": { "temperature": 0.2 },
    "max_steps": 8,
    "workflows": [{ "workflow_id": "4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641" }],
    "agentTools": [
        {
            "tool_id": "c07f2b95-8d41-4e63-a029-5f7b1c8d3e40",
            "provider_id": "8d3b1a75-6c02-4e59-b84f-27a9d5e10c63"
        }
    ],
    "name": "Support agent",
    "description": "Answers billing and account questions",
    "scorers": [],
    "agents": [{ "agentId": "6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10" }],
    "memory": {
        "lastMessages": 20,
        "semanticRecall": False
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    instructions: [
      {type: 'prompt_block_ref', id: 'd41a8f6b-9c27-4b13-a5e8-2f60c1d7b394'},
      {type: 'text', content: 'Answer in {{locale || \'English\'}}.'}
    ],
    model_slug: 'anthropic/claude-sonnet-4-5',
    policy_slug: 'policy/fastest-sonnet',
    model_options: {reasoningEffort: 'medium'},
    model_settings: {temperature: 0.2},
    max_steps: 8,
    workflows: [{workflow_id: '4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641'}],
    agentTools: [
      {
        tool_id: 'c07f2b95-8d41-4e63-a029-5f7b1c8d3e40',
        provider_id: '8d3b1a75-6c02-4e59-b84f-27a9d5e10c63'
      }
    ],
    name: 'Support agent',
    description: 'Answers billing and account questions',
    scorers: [],
    agents: [{agentId: '6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10'}],
    memory: {lastMessages: 20, semanticRecall: false}
  })
};

fetch('https://api.sidenet.ai/v1/agents/{id}/draft', 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.sidenet.ai/v1/agents/{id}/draft",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'instructions' => [
        [
                'type' => 'prompt_block_ref',
                'id' => 'd41a8f6b-9c27-4b13-a5e8-2f60c1d7b394'
        ],
        [
                'type' => 'text',
                'content' => 'Answer in {{locale || \'English\'}}.'
        ]
    ],
    'model_slug' => 'anthropic/claude-sonnet-4-5',
    'policy_slug' => 'policy/fastest-sonnet',
    'model_options' => [
        'reasoningEffort' => 'medium'
    ],
    'model_settings' => [
        'temperature' => 0.2
    ],
    'max_steps' => 8,
    'workflows' => [
        [
                'workflow_id' => '4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641'
        ]
    ],
    'agentTools' => [
        [
                'tool_id' => 'c07f2b95-8d41-4e63-a029-5f7b1c8d3e40',
                'provider_id' => '8d3b1a75-6c02-4e59-b84f-27a9d5e10c63'
        ]
    ],
    'name' => 'Support agent',
    'description' => 'Answers billing and account questions',
    'scorers' => [
        
    ],
    'agents' => [
        [
                'agentId' => '6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10'
        ]
    ],
    'memory' => [
        'lastMessages' => 20,
        'semanticRecall' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sidenet.ai/v1/agents/{id}/draft"

	payload := strings.NewReader("{\n  \"instructions\": [\n    {\n      \"type\": \"prompt_block_ref\",\n      \"id\": \"d41a8f6b-9c27-4b13-a5e8-2f60c1d7b394\"\n    },\n    {\n      \"type\": \"text\",\n      \"content\": \"Answer in {{locale || 'English'}}.\"\n    }\n  ],\n  \"model_slug\": \"anthropic/claude-sonnet-4-5\",\n  \"policy_slug\": \"policy/fastest-sonnet\",\n  \"model_options\": {\n    \"reasoningEffort\": \"medium\"\n  },\n  \"model_settings\": {\n    \"temperature\": 0.2\n  },\n  \"max_steps\": 8,\n  \"workflows\": [\n    {\n      \"workflow_id\": \"4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641\"\n    }\n  ],\n  \"agentTools\": [\n    {\n      \"tool_id\": \"c07f2b95-8d41-4e63-a029-5f7b1c8d3e40\",\n      \"provider_id\": \"8d3b1a75-6c02-4e59-b84f-27a9d5e10c63\"\n    }\n  ],\n  \"name\": \"Support agent\",\n  \"description\": \"Answers billing and account questions\",\n  \"scorers\": [],\n  \"agents\": [\n    {\n      \"agentId\": \"6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10\"\n    }\n  ],\n  \"memory\": {\n    \"lastMessages\": 20,\n    \"semanticRecall\": false\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.sidenet.ai/v1/agents/{id}/draft")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"instructions\": [\n    {\n      \"type\": \"prompt_block_ref\",\n      \"id\": \"d41a8f6b-9c27-4b13-a5e8-2f60c1d7b394\"\n    },\n    {\n      \"type\": \"text\",\n      \"content\": \"Answer in {{locale || 'English'}}.\"\n    }\n  ],\n  \"model_slug\": \"anthropic/claude-sonnet-4-5\",\n  \"policy_slug\": \"policy/fastest-sonnet\",\n  \"model_options\": {\n    \"reasoningEffort\": \"medium\"\n  },\n  \"model_settings\": {\n    \"temperature\": 0.2\n  },\n  \"max_steps\": 8,\n  \"workflows\": [\n    {\n      \"workflow_id\": \"4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641\"\n    }\n  ],\n  \"agentTools\": [\n    {\n      \"tool_id\": \"c07f2b95-8d41-4e63-a029-5f7b1c8d3e40\",\n      \"provider_id\": \"8d3b1a75-6c02-4e59-b84f-27a9d5e10c63\"\n    }\n  ],\n  \"name\": \"Support agent\",\n  \"description\": \"Answers billing and account questions\",\n  \"scorers\": [],\n  \"agents\": [\n    {\n      \"agentId\": \"6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10\"\n    }\n  ],\n  \"memory\": {\n    \"lastMessages\": 20,\n    \"semanticRecall\": false\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sidenet.ai/v1/agents/{id}/draft")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"instructions\": [\n    {\n      \"type\": \"prompt_block_ref\",\n      \"id\": \"d41a8f6b-9c27-4b13-a5e8-2f60c1d7b394\"\n    },\n    {\n      \"type\": \"text\",\n      \"content\": \"Answer in {{locale || 'English'}}.\"\n    }\n  ],\n  \"model_slug\": \"anthropic/claude-sonnet-4-5\",\n  \"policy_slug\": \"policy/fastest-sonnet\",\n  \"model_options\": {\n    \"reasoningEffort\": \"medium\"\n  },\n  \"model_settings\": {\n    \"temperature\": 0.2\n  },\n  \"max_steps\": 8,\n  \"workflows\": [\n    {\n      \"workflow_id\": \"4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641\"\n    }\n  ],\n  \"agentTools\": [\n    {\n      \"tool_id\": \"c07f2b95-8d41-4e63-a029-5f7b1c8d3e40\",\n      \"provider_id\": \"8d3b1a75-6c02-4e59-b84f-27a9d5e10c63\"\n    }\n  ],\n  \"name\": \"Support agent\",\n  \"description\": \"Answers billing and account questions\",\n  \"scorers\": [],\n  \"agents\": [\n    {\n      \"agentId\": \"6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10\"\n    }\n  ],\n  \"memory\": {\n    \"lastMessages\": 20,\n    \"semanticRecall\": false\n  }\n}"

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

{
  "agent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "active_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "activeVersionNumber": 123,
    "latestPublishedVersionNumber": 123,
    "draftDirty": true
  },
  "draft": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "rev": 123,
    "instructions": [
      {}
    ],
    "model_slug": "<string>",
    "policy_slug": "<string>",
    "model_options": {},
    "model_settings": {},
    "max_steps": 123,
    "agentTools": [
      {}
    ],
    "workflows": [
      {}
    ],
    "agents": [
      {}
    ],
    "scorers": [
      {}
    ],
    "memory": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Agents

Save agent draft

Partial save of the draft agent config (instructions, model fields, agentTools, workflows, memory, scorers, subagents, etc). Only the fields you send are written. Subagents are [{ agentId }]. The model fields are model_slug, policy_slug, model_options and model_settings; the older requesty_model_slug, requesty_policy_slug and requesty_options spellings are still accepted and mapped onto them (the canonical name wins if you send both). prompt, model_name, model_provider and model_openrouter_slug no longer exist and are ignored — the system prompt is instructions. name and description are the agent’s own, not the draft’s: they are saved here for convenience but apply immediately to every version, published ones included, and need no publish. The response carries the updated agent alongside the draft.

PATCH

agents

{id}

draft

Save agent draft

curl --request PATCH \
  --url https://api.sidenet.ai/v1/agents/{id}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "instructions": [
    {
      "type": "prompt_block_ref",
      "id": "d41a8f6b-9c27-4b13-a5e8-2f60c1d7b394"
    },
    {
      "type": "text",
      "content": "Answer in {{locale || 'English'}}."
    }
  ],
  "model_slug": "anthropic/claude-sonnet-4-5",
  "policy_slug": "policy/fastest-sonnet",
  "model_options": {
    "reasoningEffort": "medium"
  },
  "model_settings": {
    "temperature": 0.2
  },
  "max_steps": 8,
  "workflows": [
    {
      "workflow_id": "4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641"
    }
  ],
  "agentTools": [
    {
      "tool_id": "c07f2b95-8d41-4e63-a029-5f7b1c8d3e40",
      "provider_id": "8d3b1a75-6c02-4e59-b84f-27a9d5e10c63"
    }
  ],
  "name": "Support agent",
  "description": "Answers billing and account questions",
  "scorers": [],
  "agents": [
    {
      "agentId": "6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10"
    }
  ],
  "memory": {
    "lastMessages": 20,
    "semanticRecall": false
  }
}
EOF

import requests

url = "https://api.sidenet.ai/v1/agents/{id}/draft"

payload = {
    "instructions": [
        {
            "type": "prompt_block_ref",
            "id": "d41a8f6b-9c27-4b13-a5e8-2f60c1d7b394"
        },
        {
            "type": "text",
            "content": "Answer in {{locale || 'English'}}."
        }
    ],
    "model_slug": "anthropic/claude-sonnet-4-5",
    "policy_slug": "policy/fastest-sonnet",
    "model_options": { "reasoningEffort": "medium" },
    "model_settings": { "temperature": 0.2 },
    "max_steps": 8,
    "workflows": [{ "workflow_id": "4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641" }],
    "agentTools": [
        {
            "tool_id": "c07f2b95-8d41-4e63-a029-5f7b1c8d3e40",
            "provider_id": "8d3b1a75-6c02-4e59-b84f-27a9d5e10c63"
        }
    ],
    "name": "Support agent",
    "description": "Answers billing and account questions",
    "scorers": [],
    "agents": [{ "agentId": "6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10" }],
    "memory": {
        "lastMessages": 20,
        "semanticRecall": False
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    instructions: [
      {type: 'prompt_block_ref', id: 'd41a8f6b-9c27-4b13-a5e8-2f60c1d7b394'},
      {type: 'text', content: 'Answer in {{locale || \'English\'}}.'}
    ],
    model_slug: 'anthropic/claude-sonnet-4-5',
    policy_slug: 'policy/fastest-sonnet',
    model_options: {reasoningEffort: 'medium'},
    model_settings: {temperature: 0.2},
    max_steps: 8,
    workflows: [{workflow_id: '4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641'}],
    agentTools: [
      {
        tool_id: 'c07f2b95-8d41-4e63-a029-5f7b1c8d3e40',
        provider_id: '8d3b1a75-6c02-4e59-b84f-27a9d5e10c63'
      }
    ],
    name: 'Support agent',
    description: 'Answers billing and account questions',
    scorers: [],
    agents: [{agentId: '6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10'}],
    memory: {lastMessages: 20, semanticRecall: false}
  })
};

fetch('https://api.sidenet.ai/v1/agents/{id}/draft', 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.sidenet.ai/v1/agents/{id}/draft",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'instructions' => [
        [
                'type' => 'prompt_block_ref',
                'id' => 'd41a8f6b-9c27-4b13-a5e8-2f60c1d7b394'
        ],
        [
                'type' => 'text',
                'content' => 'Answer in {{locale || \'English\'}}.'
        ]
    ],
    'model_slug' => 'anthropic/claude-sonnet-4-5',
    'policy_slug' => 'policy/fastest-sonnet',
    'model_options' => [
        'reasoningEffort' => 'medium'
    ],
    'model_settings' => [
        'temperature' => 0.2
    ],
    'max_steps' => 8,
    'workflows' => [
        [
                'workflow_id' => '4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641'
        ]
    ],
    'agentTools' => [
        [
                'tool_id' => 'c07f2b95-8d41-4e63-a029-5f7b1c8d3e40',
                'provider_id' => '8d3b1a75-6c02-4e59-b84f-27a9d5e10c63'
        ]
    ],
    'name' => 'Support agent',
    'description' => 'Answers billing and account questions',
    'scorers' => [
        
    ],
    'agents' => [
        [
                'agentId' => '6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10'
        ]
    ],
    'memory' => [
        'lastMessages' => 20,
        'semanticRecall' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sidenet.ai/v1/agents/{id}/draft"

	payload := strings.NewReader("{\n  \"instructions\": [\n    {\n      \"type\": \"prompt_block_ref\",\n      \"id\": \"d41a8f6b-9c27-4b13-a5e8-2f60c1d7b394\"\n    },\n    {\n      \"type\": \"text\",\n      \"content\": \"Answer in {{locale || 'English'}}.\"\n    }\n  ],\n  \"model_slug\": \"anthropic/claude-sonnet-4-5\",\n  \"policy_slug\": \"policy/fastest-sonnet\",\n  \"model_options\": {\n    \"reasoningEffort\": \"medium\"\n  },\n  \"model_settings\": {\n    \"temperature\": 0.2\n  },\n  \"max_steps\": 8,\n  \"workflows\": [\n    {\n      \"workflow_id\": \"4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641\"\n    }\n  ],\n  \"agentTools\": [\n    {\n      \"tool_id\": \"c07f2b95-8d41-4e63-a029-5f7b1c8d3e40\",\n      \"provider_id\": \"8d3b1a75-6c02-4e59-b84f-27a9d5e10c63\"\n    }\n  ],\n  \"name\": \"Support agent\",\n  \"description\": \"Answers billing and account questions\",\n  \"scorers\": [],\n  \"agents\": [\n    {\n      \"agentId\": \"6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10\"\n    }\n  ],\n  \"memory\": {\n    \"lastMessages\": 20,\n    \"semanticRecall\": false\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.sidenet.ai/v1/agents/{id}/draft")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"instructions\": [\n    {\n      \"type\": \"prompt_block_ref\",\n      \"id\": \"d41a8f6b-9c27-4b13-a5e8-2f60c1d7b394\"\n    },\n    {\n      \"type\": \"text\",\n      \"content\": \"Answer in {{locale || 'English'}}.\"\n    }\n  ],\n  \"model_slug\": \"anthropic/claude-sonnet-4-5\",\n  \"policy_slug\": \"policy/fastest-sonnet\",\n  \"model_options\": {\n    \"reasoningEffort\": \"medium\"\n  },\n  \"model_settings\": {\n    \"temperature\": 0.2\n  },\n  \"max_steps\": 8,\n  \"workflows\": [\n    {\n      \"workflow_id\": \"4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641\"\n    }\n  ],\n  \"agentTools\": [\n    {\n      \"tool_id\": \"c07f2b95-8d41-4e63-a029-5f7b1c8d3e40\",\n      \"provider_id\": \"8d3b1a75-6c02-4e59-b84f-27a9d5e10c63\"\n    }\n  ],\n  \"name\": \"Support agent\",\n  \"description\": \"Answers billing and account questions\",\n  \"scorers\": [],\n  \"agents\": [\n    {\n      \"agentId\": \"6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10\"\n    }\n  ],\n  \"memory\": {\n    \"lastMessages\": 20,\n    \"semanticRecall\": false\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sidenet.ai/v1/agents/{id}/draft")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"instructions\": [\n    {\n      \"type\": \"prompt_block_ref\",\n      \"id\": \"d41a8f6b-9c27-4b13-a5e8-2f60c1d7b394\"\n    },\n    {\n      \"type\": \"text\",\n      \"content\": \"Answer in {{locale || 'English'}}.\"\n    }\n  ],\n  \"model_slug\": \"anthropic/claude-sonnet-4-5\",\n  \"policy_slug\": \"policy/fastest-sonnet\",\n  \"model_options\": {\n    \"reasoningEffort\": \"medium\"\n  },\n  \"model_settings\": {\n    \"temperature\": 0.2\n  },\n  \"max_steps\": 8,\n  \"workflows\": [\n    {\n      \"workflow_id\": \"4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641\"\n    }\n  ],\n  \"agentTools\": [\n    {\n      \"tool_id\": \"c07f2b95-8d41-4e63-a029-5f7b1c8d3e40\",\n      \"provider_id\": \"8d3b1a75-6c02-4e59-b84f-27a9d5e10c63\"\n    }\n  ],\n  \"name\": \"Support agent\",\n  \"description\": \"Answers billing and account questions\",\n  \"scorers\": [],\n  \"agents\": [\n    {\n      \"agentId\": \"6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10\"\n    }\n  ],\n  \"memory\": {\n    \"lastMessages\": 20,\n    \"semanticRecall\": false\n  }\n}"

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

{
  "agent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "active_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "activeVersionNumber": 123,
    "latestPublishedVersionNumber": 123,
    "draftDirty": true
  },
  "draft": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "rev": 123,
    "instructions": [
      {}
    ],
    "model_slug": "<string>",
    "policy_slug": "<string>",
    "model_options": {},
    "model_settings": {},
    "max_steps": 123,
    "agentTools": [
      {}
    ],
    "workflows": [
      {}
    ],
    "agents": [
      {}
    ],
    "scorers": [
      {}
    ],
    "memory": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.

Path Parameters

string

required

Example:

"6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10"

Body

application/json

instructions

object[]

The agent's system prompt, as an ordered list of blocks. Each entry is one of: { type: "text", content } — inline text; { type: "prompt_block", content, rules? } — inline text with an optional display condition; { type: "prompt_block_ref", id } — a reference to a /v1/prompt-blocks block in the same organization. Content may contain {{variable}}, {{a.b}} and {{variable || 'default'}} placeholders, resolved per request from the chat body's variables plus the now.* builtins; an unsupplied placeholder is left visible. rules is a { operator: "AND"|"OR", conditions: [...] } group (max 3 levels) — the block is included only when it evaluates true. On the draft a ref floats to the block's active version; publishing PINS it, so a published agent version keeps its exact prompt until you republish (see /v1/prompt-blocks/:id/rollout). Pins are server-owned — do not send versionId.

Example:

[
  {
    "type": "prompt_block_ref",
    "id": "d41a8f6b-9c27-4b13-a5e8-2f60c1d7b394"
  },
  {
    "type": "text",
    "content": "Answer in {{locale || 'English'}}."
  }
]

model_slug

string

The concrete model to run, e.g. anthropic/claude-sonnet-4-5. Ignored when policy_slug is set.

Example:

"anthropic/claude-sonnet-4-5"

policy_slug

string

A routing policy to run instead of a fixed model, e.g. policy/fastest-sonnet. Overrides model_slug when set.

Example:

"policy/fastest-sonnet"

model_options

object

Model-level options passed through to the router — reasoning effort, native provider options, and the like.

Example:

{ "reasoningEffort": "medium" }

model_settings

object

Generation settings: temperature, maxTokens, and similar.

Example:

{ "temperature": 0.2 }

max_steps

integer

Max LLM round-trips per run for the agentic tool loop. The final step is forced tool-free so runs always end with a text answer. null = platform default (20).

Required range: 1 <= x <= 100

Example:

8

workflows

object[]

Workflows the agent can run, as { workflow_id, config? } entries. workflow_id is the /v1/workflows id and must belong to the same organization. The workflow's ACTIVE version is always what runs, so activating a new version reaches the agent on its next turn with no republish. The agent-facing tool name and its description come from the workflow itself — the model calls it as workflow-<workflow name>. The whole workflow runs inside one tool call, and its step progress is streamed to the client as data-tool-workflow / data-tool-workflow-step parts by /v1/chat.

Show child attributes

Example:

[
  {
    "workflow_id": "4c2f9e18-7a63-4d05-b1e8-93a7c0f2d641"
  }
]

agentTools

object[]

Tools assigned to the agent. Each entry is { tool_id, provider_id?, config?, composio_connected_account_id?, discovery?, loop_responses?, require_approval? }. discovery (integration tools only) controls where the tool schema lives at runtime: true puts it behind the agent's search_tools/load_tool discovery tools, false pins it into the prompt, and unset lets the platform decide — small toolkits stay in the prompt, large ones (beyond ~15 total tools) become discoverable so the prompt is not flooded with schemas. require_approval: true pauses every call to that tool for human approval: the chat stream emits a data-tool-call-approval chunk instead of executing (carrying a model-written reason sentence for the approval card), and the client continues the run by POSTing /v1/chat with the approval field. Set loop_responses: true on a tool to let one call cover a whole result set: it gains _fields (project only the fields needed), _all_pages (fetch and merge every page) and _for_each (call once per value of a parameter and merge the rows), and the agent is given the large-response retrieval tools automatically. Because those re-issue the request, enable it only on tools whose endpoint is safe to call repeatedly.

Example:

[
  {
    "tool_id": "c07f2b95-8d41-4e63-a029-5f7b1c8d3e40",
    "provider_id": "8d3b1a75-6c02-4e59-b84f-27a9d5e10c63"
  }
]

name

string

The agent's name. Agent-level, not versioned — it takes effect immediately, with no publish, and is what other agents see when this one is a subagent.

Example:

"Support agent"

description

string

The agent's description. Agent-level, not versioned — same immediate effect as name. Send null to clear it.

Example:

"Answers billing and account questions"

scorers

object[]

Example:

[]

agents

object[]

Subagents this one may delegate to.

Show child attributes

Example:

[
  {
    "agentId": "6f1c0f4e-2b7a-4a51-9a2f-0c9d1b3e5a10"
  }
]

memory

object

Example:

{
  "lastMessages": 20,
  "semanticRecall": false
}

Response

The saved draft, and the agent record it belongs to

agent

object

The agent after the save — name/description reflect this call, and the version summary says whether the draft now differs from what is published.

Show child attributes

draft

object

The whole draft after the merge, not just the fields you sent. rev has been bumped by the DB.

Show child attributes

Authentication

Users & Groups

Chat & Messaging

Agents

Prompt Blocks

Workflows

Workflow Schedules

Networks

Tools

Tool Providers

Scoring & Experiments

System

Save agent draft

Authorizations

Path Parameters

Body

Response