Update a saved agent

curl --request PATCH \
  --url https://api.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allow_fetch": true,
  "allow_search": true,
  "description": "<string>",
  "favorite": true,
  "icon": "<string>",
  "inputs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "model_key": "<string>",
  "name": "<string>",
  "output_schema": {
    "fields": [
      {
        "name": "<string>",
        "choices": [
          "<string>"
        ],
        "description": "<string>",
        "field_type": "text"
      }
    ],
    "mode": "fields"
  },
  "prompt": {
    "segments": [
      {
        "text": "<string>",
        "type": "text"
      }
    ]
  },
  "use_business_context": true,
  "use_row_context": true
}
'

import requests

url = "https://api.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/"

payload = {
    "allow_fetch": True,
    "allow_search": True,
    "description": "<string>",
    "favorite": True,
    "icon": "<string>",
    "inputs": [
        {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
        }
    ],
    "model_key": "<string>",
    "name": "<string>",
    "output_schema": {
        "fields": [
            {
                "name": "<string>",
                "choices": ["<string>"],
                "description": "<string>",
                "field_type": "text"
            }
        ],
        "mode": "fields"
    },
    "prompt": { "segments": [
            {
                "text": "<string>",
                "type": "text"
            }
        ] },
    "use_business_context": True,
    "use_row_context": True
}
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({
    allow_fetch: true,
    allow_search: true,
    description: '<string>',
    favorite: true,
    icon: '<string>',
    inputs: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', name: '<string>'}],
    model_key: '<string>',
    name: '<string>',
    output_schema: {
      fields: [
        {
          name: '<string>',
          choices: ['<string>'],
          description: '<string>',
          field_type: 'text'
        }
      ],
      mode: 'fields'
    },
    prompt: {segments: [{text: '<string>', type: 'text'}]},
    use_business_context: true,
    use_row_context: true
  })
};

fetch('https://api.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/', 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.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/",
  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([
    'allow_fetch' => true,
    'allow_search' => true,
    'description' => '<string>',
    'favorite' => true,
    'icon' => '<string>',
    'inputs' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'name' => '<string>'
        ]
    ],
    'model_key' => '<string>',
    'name' => '<string>',
    'output_schema' => [
        'fields' => [
                [
                                'name' => '<string>',
                                'choices' => [
                                                                '<string>'
                                ],
                                'description' => '<string>',
                                'field_type' => 'text'
                ]
        ],
        'mode' => 'fields'
    ],
    'prompt' => [
        'segments' => [
                [
                                'text' => '<string>',
                                'type' => 'text'
                ]
        ]
    ],
    'use_business_context' => true,
    'use_row_context' => true
  ]),
  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.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/"

	payload := strings.NewReader("{\n  \"allow_fetch\": true,\n  \"allow_search\": true,\n  \"description\": \"<string>\",\n  \"favorite\": true,\n  \"icon\": \"<string>\",\n  \"inputs\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"model_key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": {\n    \"fields\": [\n      {\n        \"name\": \"<string>\",\n        \"choices\": [\n          \"<string>\"\n        ],\n        \"description\": \"<string>\",\n        \"field_type\": \"text\"\n      }\n    ],\n    \"mode\": \"fields\"\n  },\n  \"prompt\": {\n    \"segments\": [\n      {\n        \"text\": \"<string>\",\n        \"type\": \"text\"\n      }\n    ]\n  },\n  \"use_business_context\": true,\n  \"use_row_context\": true\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.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allow_fetch\": true,\n  \"allow_search\": true,\n  \"description\": \"<string>\",\n  \"favorite\": true,\n  \"icon\": \"<string>\",\n  \"inputs\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"model_key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": {\n    \"fields\": [\n      {\n        \"name\": \"<string>\",\n        \"choices\": [\n          \"<string>\"\n        ],\n        \"description\": \"<string>\",\n        \"field_type\": \"text\"\n      }\n    ],\n    \"mode\": \"fields\"\n  },\n  \"prompt\": {\n    \"segments\": [\n      {\n        \"text\": \"<string>\",\n        \"type\": \"text\"\n      }\n    ]\n  },\n  \"use_business_context\": true,\n  \"use_row_context\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/")

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  \"allow_fetch\": true,\n  \"allow_search\": true,\n  \"description\": \"<string>\",\n  \"favorite\": true,\n  \"icon\": \"<string>\",\n  \"inputs\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"model_key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": {\n    \"fields\": [\n      {\n        \"name\": \"<string>\",\n        \"choices\": [\n          \"<string>\"\n        ],\n        \"description\": \"<string>\",\n        \"field_type\": \"text\"\n      }\n    ],\n    \"mode\": \"fields\"\n  },\n  \"prompt\": {\n    \"segments\": [\n      {\n        \"text\": \"<string>\",\n        \"type\": \"text\"\n      }\n    ]\n  },\n  \"use_business_context\": true,\n  \"use_row_context\": true\n}"

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

{
  "allow_fetch": true,
  "allow_search": true,
  "created_at": "2023-11-07T05:31:56Z",
  "current_version": 123,
  "description": "<string>",
  "effort": "low",
  "favorite": true,
  "icon": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inputs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "model_key": "<string>",
  "name": "<string>",
  "output_schema": {
    "fields": [
      {
        "name": "<string>",
        "choices": [
          "<string>"
        ],
        "description": "<string>",
        "field_type": "text"
      }
    ],
    "mode": "fields"
  },
  "owner_user_id": "<string>",
  "prompt": {
    "segments": [
      {
        "text": "<string>",
        "type": "text"
      }
    ]
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "use_business_context": true,
  "use_row_context": true,
  "is_template": false,
  "owner_display_name": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

PATCH

table-enrichments

saved-agents

{saved_agent_id}

Update a saved agent

curl --request PATCH \
  --url https://api.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allow_fetch": true,
  "allow_search": true,
  "description": "<string>",
  "favorite": true,
  "icon": "<string>",
  "inputs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "model_key": "<string>",
  "name": "<string>",
  "output_schema": {
    "fields": [
      {
        "name": "<string>",
        "choices": [
          "<string>"
        ],
        "description": "<string>",
        "field_type": "text"
      }
    ],
    "mode": "fields"
  },
  "prompt": {
    "segments": [
      {
        "text": "<string>",
        "type": "text"
      }
    ]
  },
  "use_business_context": true,
  "use_row_context": true
}
'

import requests

url = "https://api.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/"

payload = {
    "allow_fetch": True,
    "allow_search": True,
    "description": "<string>",
    "favorite": True,
    "icon": "<string>",
    "inputs": [
        {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
        }
    ],
    "model_key": "<string>",
    "name": "<string>",
    "output_schema": {
        "fields": [
            {
                "name": "<string>",
                "choices": ["<string>"],
                "description": "<string>",
                "field_type": "text"
            }
        ],
        "mode": "fields"
    },
    "prompt": { "segments": [
            {
                "text": "<string>",
                "type": "text"
            }
        ] },
    "use_business_context": True,
    "use_row_context": True
}
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({
    allow_fetch: true,
    allow_search: true,
    description: '<string>',
    favorite: true,
    icon: '<string>',
    inputs: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', name: '<string>'}],
    model_key: '<string>',
    name: '<string>',
    output_schema: {
      fields: [
        {
          name: '<string>',
          choices: ['<string>'],
          description: '<string>',
          field_type: 'text'
        }
      ],
      mode: 'fields'
    },
    prompt: {segments: [{text: '<string>', type: 'text'}]},
    use_business_context: true,
    use_row_context: true
  })
};

fetch('https://api.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/', 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.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/",
  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([
    'allow_fetch' => true,
    'allow_search' => true,
    'description' => '<string>',
    'favorite' => true,
    'icon' => '<string>',
    'inputs' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'name' => '<string>'
        ]
    ],
    'model_key' => '<string>',
    'name' => '<string>',
    'output_schema' => [
        'fields' => [
                [
                                'name' => '<string>',
                                'choices' => [
                                                                '<string>'
                                ],
                                'description' => '<string>',
                                'field_type' => 'text'
                ]
        ],
        'mode' => 'fields'
    ],
    'prompt' => [
        'segments' => [
                [
                                'text' => '<string>',
                                'type' => 'text'
                ]
        ]
    ],
    'use_business_context' => true,
    'use_row_context' => true
  ]),
  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.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/"

	payload := strings.NewReader("{\n  \"allow_fetch\": true,\n  \"allow_search\": true,\n  \"description\": \"<string>\",\n  \"favorite\": true,\n  \"icon\": \"<string>\",\n  \"inputs\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"model_key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": {\n    \"fields\": [\n      {\n        \"name\": \"<string>\",\n        \"choices\": [\n          \"<string>\"\n        ],\n        \"description\": \"<string>\",\n        \"field_type\": \"text\"\n      }\n    ],\n    \"mode\": \"fields\"\n  },\n  \"prompt\": {\n    \"segments\": [\n      {\n        \"text\": \"<string>\",\n        \"type\": \"text\"\n      }\n    ]\n  },\n  \"use_business_context\": true,\n  \"use_row_context\": true\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.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"allow_fetch\": true,\n  \"allow_search\": true,\n  \"description\": \"<string>\",\n  \"favorite\": true,\n  \"icon\": \"<string>\",\n  \"inputs\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"model_key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": {\n    \"fields\": [\n      {\n        \"name\": \"<string>\",\n        \"choices\": [\n          \"<string>\"\n        ],\n        \"description\": \"<string>\",\n        \"field_type\": \"text\"\n      }\n    ],\n    \"mode\": \"fields\"\n  },\n  \"prompt\": {\n    \"segments\": [\n      {\n        \"text\": \"<string>\",\n        \"type\": \"text\"\n      }\n    ]\n  },\n  \"use_business_context\": true,\n  \"use_row_context\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/table-enrichments/saved-agents/{saved_agent_id}/")

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  \"allow_fetch\": true,\n  \"allow_search\": true,\n  \"description\": \"<string>\",\n  \"favorite\": true,\n  \"icon\": \"<string>\",\n  \"inputs\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"model_key\": \"<string>\",\n  \"name\": \"<string>\",\n  \"output_schema\": {\n    \"fields\": [\n      {\n        \"name\": \"<string>\",\n        \"choices\": [\n          \"<string>\"\n        ],\n        \"description\": \"<string>\",\n        \"field_type\": \"text\"\n      }\n    ],\n    \"mode\": \"fields\"\n  },\n  \"prompt\": {\n    \"segments\": [\n      {\n        \"text\": \"<string>\",\n        \"type\": \"text\"\n      }\n    ]\n  },\n  \"use_business_context\": true,\n  \"use_row_context\": true\n}"

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

{
  "allow_fetch": true,
  "allow_search": true,
  "created_at": "2023-11-07T05:31:56Z",
  "current_version": 123,
  "description": "<string>",
  "effort": "low",
  "favorite": true,
  "icon": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inputs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "model_key": "<string>",
  "name": "<string>",
  "output_schema": {
    "fields": [
      {
        "name": "<string>",
        "choices": [
          "<string>"
        ],
        "description": "<string>",
        "field_type": "text"
      }
    ],
    "mode": "fields"
  },
  "owner_user_id": "<string>",
  "prompt": {
    "segments": [
      {
        "text": "<string>",
        "type": "text"
      }
    ]
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "use_business_context": true,
  "use_row_context": true,
  "is_template": false,
  "owner_display_name": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

saved_agent_id

string<uuid>

required

Body

application/json

A partial saved-agent update; absent fields keep their value.

allow_fetch

boolean | null

allow_search

boolean | null

description

string | null

Maximum string length: 2000

effort

enum<string> | null

How hard the Agent works on each row.

Named levels rather than raw step counts: the level is the user-facing contract, and what each level buys (step and page budgets) is a product decision the loop maps internally — re-tuning budgets never invalidates stored columns.

Available options:

low,

standard,

high

favorite

boolean | null

icon

string | null

Required string length: 1 - 16

inputs

AgentInputSchema · object[] | null

Maximum array length: 20

Show child attributes

model_key

string | null

Required string length: 1 - 64

name

string | null

Required string length: 1 - 255

output_schema

EnrichmentOutputFields · object

The fields-mode output shape: repeatable named typed fields.

The default is Clay's: one text field named response.

EnrichmentOutputFields
EnrichmentOutputRawSchema

Show child attributes

prompt

AgentPromptTemplate · object | null

A saved agent's prompt: literal text with references between the runs.

The same convention every other stored prompt in the product uses (EnrichmentPromptTemplate for columns, template segments for sequences): identity-keyed segments, so renaming what a reference points at never rewrites the prompt. Structurally parallel to the enrichment template rather than importing it — an agent prompt references INPUTS, an enrichment prompt references COLUMNS, and the import hierarchy keeps the two domains apart.

Show child attributes

use_business_context

boolean | null

use_row_context

boolean | null

Response

Successful Response

One org-level saved agent as the editor, picker and library render it.

allow_fetch

boolean

required

allow_search

boolean

required

created_at

string<date-time>

required

current_version

integer

required

description

string | null

required

effort

enum<string>

required

How hard the Agent works on each row.

Available options:

low,

standard,

high

favorite

boolean

required

icon

string | null

required

string<uuid>

required

inputs

AgentInputSchema · object[]

required

Show child attributes

model_key

string | null

required

name

string

required

output_schema

EnrichmentOutputFields · object

required

The fields-mode output shape: repeatable named typed fields.

The default is Clay's: one text field named response.

EnrichmentOutputFields
EnrichmentOutputRawSchema

Show child attributes

owner_user_id

string | null

required

prompt

AgentPromptTemplate · object

required

A saved agent's prompt: literal text with references between the runs.

Show child attributes

updated_at

string<date-time>

required

use_business_context

boolean

required

use_row_context

boolean

required

is_template

boolean

default:false

owner_display_name

string | null

API reference

Endpoints

Update a saved agent

Authorizations

Path Parameters

Body

Response