Update a slide in a PPTX agent

curl --request PATCH \
  --url http://localhost:3000/v2/agents/{id}/slides/{slideIndex} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "overview": "<string>",
  "elements": [
    {
      "description": "<string>",
      "examples": "<string>",
      "table_markdown_example": "<string>",
      "table_header_rows": 123,
      "table_header_columns": 123,
      "items": {},
      "ignored": true,
      "variable_name": "<string>"
    }
  ]
}
'

import requests

url = "http://localhost:3000/v2/agents/{id}/slides/{slideIndex}"

payload = {
    "overview": "<string>",
    "elements": [
        {
            "description": "<string>",
            "examples": "<string>",
            "table_markdown_example": "<string>",
            "table_header_rows": 123,
            "table_header_columns": 123,
            "items": {},
            "ignored": True,
            "variable_name": "<string>"
        }
    ]
}
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({
    overview: '<string>',
    elements: [
      {
        description: '<string>',
        examples: '<string>',
        table_markdown_example: '<string>',
        table_header_rows: 123,
        table_header_columns: 123,
        items: {},
        ignored: true,
        variable_name: '<string>'
      }
    ]
  })
};

fetch('http://localhost:3000/v2/agents/{id}/slides/{slideIndex}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/v2/agents/{id}/slides/{slideIndex}",
  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([
    'overview' => '<string>',
    'elements' => [
        [
                'description' => '<string>',
                'examples' => '<string>',
                'table_markdown_example' => '<string>',
                'table_header_rows' => 123,
                'table_header_columns' => 123,
                'items' => [
                                
                ],
                'ignored' => true,
                'variable_name' => '<string>'
        ]
    ]
  ]),
  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 := "http://localhost:3000/v2/agents/{id}/slides/{slideIndex}"

	payload := strings.NewReader("{\n  \"overview\": \"<string>\",\n  \"elements\": [\n    {\n      \"description\": \"<string>\",\n      \"examples\": \"<string>\",\n      \"table_markdown_example\": \"<string>\",\n      \"table_header_rows\": 123,\n      \"table_header_columns\": 123,\n      \"items\": {},\n      \"ignored\": true,\n      \"variable_name\": \"<string>\"\n    }\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("http://localhost:3000/v2/agents/{id}/slides/{slideIndex}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"overview\": \"<string>\",\n  \"elements\": [\n    {\n      \"description\": \"<string>\",\n      \"examples\": \"<string>\",\n      \"table_markdown_example\": \"<string>\",\n      \"table_header_rows\": 123,\n      \"table_header_columns\": 123,\n      \"items\": {},\n      \"ignored\": true,\n      \"variable_name\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v2/agents/{id}/slides/{slideIndex}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"overview\": \"<string>\",\n  \"elements\": [\n    {\n      \"description\": \"<string>\",\n      \"examples\": \"<string>\",\n      \"table_markdown_example\": \"<string>\",\n      \"table_header_rows\": 123,\n      \"table_header_columns\": 123,\n      \"items\": {},\n      \"ignored\": true,\n      \"variable_name\": \"<string>\"\n    }\n  ]\n}"

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

{
  "object": "page",
  "id": "p_abc123",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T14:45:00.000Z",
  "name": "Project Management Agent",
  "slug": "project-management",
  "status": "available",
  "steps": [
    {
      "type": "audio",
      "order": 2,
      "evaluations": [],
      "id": "<string>",
      "content": {},
      "outputExample": "<string>",
      "structuredOutput": {
        "type": "json_schema",
        "name": "<string>",
        "schema": {},
        "description": "<string>",
        "strict": true
      },
      "agentFileId": "<string>",
      "previewFileId": "<string>",
      "version": "<string>",
      "title": "<string>",
      "instructions": "<string>",
      "promptId": "<string>"
    }
  ],
  "evaluations": [
    {
      "type": "outcome",
      "rubric": "<string>",
      "maxIterations": 10.5
    }
  ],
  "execution_mode": "one_shot",
  "versions": [
    {
      "object": "page",
      "id": "p_abc123",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T14:45:00.000Z",
      "agent_id": "<string>",
      "version_number": 123,
      "ant_agent_version": 123,
      "createdBy": {
        "object": "user",
        "id": "u_abc123",
        "apiKeyId": "bsk_abc123"
      },
      "updatedBy": {
        "object": "user",
        "id": "u_abc123",
        "apiKeyId": "bsk_abc123"
      },
      "label": "<string>"
    }
  ],
  "orgId": "org_123",
  "sync_status": "pending",
  "web_access": {
    "enabled": true,
    "allowedHosts": [
      "<string>"
    ],
    "allowEveryUrl": true
  },
  "tool_configs": [
    {
      "name": "bash",
      "enabled": true,
      "permission_policy": "always_allow"
    }
  ],
  "mcp_servers": [
    {
      "name": "<string>",
      "url": "<string>",
      "enabled": true,
      "permission_policy": "always_allow",
      "tools": [
        {
          "name": "<string>",
          "enabled": true,
          "permission_policy": "always_allow"
        }
      ],
      "connection_account_id": "<string>"
    }
  ],
  "createdBy": {
    "object": "user",
    "id": "u_abc123",
    "apiKeyId": "bsk_abc123"
  },
  "updatedBy": {
    "object": "user",
    "id": "u_abc123",
    "apiKeyId": "bsk_abc123"
  },
  "description": "Manage projects with Kanban boards",
  "icon": {
    "type": "emoji",
    "emoji": "page_icon",
    "external": {
      "url": "https://example.com/image.jpg"
    },
    "file_upload": {
      "id": "fu_abc123"
    },
    "domain": "acme.com",
    "file": {
      "url": "https://s3.amazonaws.com/...",
      "expiryTime": "2024-01-15T10:30:00.000Z"
    },
    "lucide": "file-text",
    "brand": "github",
    "dicebear": {
      "style": "notionists-neutral",
      "seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
      "backgroundColor": "b6e3f4,b6e3f4",
      "options": {
        "shape": "circle",
        "bodyColor": "<string>",
        "animationVariant": "fastest",
        "brows": "<string>",
        "eyes": "<string>",
        "glasses": "<string>",
        "lips": "<string>",
        "nose": "<string>",
        "flip": true,
        "rotate": 123,
        "scale": 123,
        "radius": 123,
        "size": 123,
        "backgroundType": "solid",
        "backgroundRotation": [
          123
        ],
        "translateX": 123,
        "translateY": 123,
        "clip": true,
        "randomizeIds": true
      }
    },
    "background": "blue",
    "empty": true,
    "updatedBy": "dataset:empresas"
  },
  "target_type": "company",
  "format": "markdown",
  "source_file_id": "<string>",
  "pptx_metadata": {
    "slideWidth": 123,
    "slideHeight": 123,
    "slideCount": 123,
    "title": "<string>",
    "author": "<string>"
  },
  "has_steps": false,
  "presentation_versions": [],
  "current_presentation_version": "<string>",
  "active_version_id": "<string>",
  "datasets": [
    "empresas",
    "pessoas"
  ],
  "sync_at": "<string>",
  "sync_error": "<string>",
  "skills_mode": "auto",
  "skill_ids": [
    "<string>"
  ],
  "instructions": "<string>",
  "tools_mode": "auto",
  "custom_tool_ids": [
    "<string>"
  ],
  "subagent_ids": [
    "<string>"
  ],
  "knowledge_file_ids": [
    "<string>"
  ]
}

PATCH

agents

{id}

slides

{slideIndex}

Update a slide in a PPTX agent

curl --request PATCH \
  --url http://localhost:3000/v2/agents/{id}/slides/{slideIndex} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "overview": "<string>",
  "elements": [
    {
      "description": "<string>",
      "examples": "<string>",
      "table_markdown_example": "<string>",
      "table_header_rows": 123,
      "table_header_columns": 123,
      "items": {},
      "ignored": true,
      "variable_name": "<string>"
    }
  ]
}
'

import requests

url = "http://localhost:3000/v2/agents/{id}/slides/{slideIndex}"

payload = {
    "overview": "<string>",
    "elements": [
        {
            "description": "<string>",
            "examples": "<string>",
            "table_markdown_example": "<string>",
            "table_header_rows": 123,
            "table_header_columns": 123,
            "items": {},
            "ignored": True,
            "variable_name": "<string>"
        }
    ]
}
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({
    overview: '<string>',
    elements: [
      {
        description: '<string>',
        examples: '<string>',
        table_markdown_example: '<string>',
        table_header_rows: 123,
        table_header_columns: 123,
        items: {},
        ignored: true,
        variable_name: '<string>'
      }
    ]
  })
};

fetch('http://localhost:3000/v2/agents/{id}/slides/{slideIndex}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/v2/agents/{id}/slides/{slideIndex}",
  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([
    'overview' => '<string>',
    'elements' => [
        [
                'description' => '<string>',
                'examples' => '<string>',
                'table_markdown_example' => '<string>',
                'table_header_rows' => 123,
                'table_header_columns' => 123,
                'items' => [
                                
                ],
                'ignored' => true,
                'variable_name' => '<string>'
        ]
    ]
  ]),
  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 := "http://localhost:3000/v2/agents/{id}/slides/{slideIndex}"

	payload := strings.NewReader("{\n  \"overview\": \"<string>\",\n  \"elements\": [\n    {\n      \"description\": \"<string>\",\n      \"examples\": \"<string>\",\n      \"table_markdown_example\": \"<string>\",\n      \"table_header_rows\": 123,\n      \"table_header_columns\": 123,\n      \"items\": {},\n      \"ignored\": true,\n      \"variable_name\": \"<string>\"\n    }\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("http://localhost:3000/v2/agents/{id}/slides/{slideIndex}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"overview\": \"<string>\",\n  \"elements\": [\n    {\n      \"description\": \"<string>\",\n      \"examples\": \"<string>\",\n      \"table_markdown_example\": \"<string>\",\n      \"table_header_rows\": 123,\n      \"table_header_columns\": 123,\n      \"items\": {},\n      \"ignored\": true,\n      \"variable_name\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v2/agents/{id}/slides/{slideIndex}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"overview\": \"<string>\",\n  \"elements\": [\n    {\n      \"description\": \"<string>\",\n      \"examples\": \"<string>\",\n      \"table_markdown_example\": \"<string>\",\n      \"table_header_rows\": 123,\n      \"table_header_columns\": 123,\n      \"items\": {},\n      \"ignored\": true,\n      \"variable_name\": \"<string>\"\n    }\n  ]\n}"

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

{
  "object": "page",
  "id": "p_abc123",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T14:45:00.000Z",
  "name": "Project Management Agent",
  "slug": "project-management",
  "status": "available",
  "steps": [
    {
      "type": "audio",
      "order": 2,
      "evaluations": [],
      "id": "<string>",
      "content": {},
      "outputExample": "<string>",
      "structuredOutput": {
        "type": "json_schema",
        "name": "<string>",
        "schema": {},
        "description": "<string>",
        "strict": true
      },
      "agentFileId": "<string>",
      "previewFileId": "<string>",
      "version": "<string>",
      "title": "<string>",
      "instructions": "<string>",
      "promptId": "<string>"
    }
  ],
  "evaluations": [
    {
      "type": "outcome",
      "rubric": "<string>",
      "maxIterations": 10.5
    }
  ],
  "execution_mode": "one_shot",
  "versions": [
    {
      "object": "page",
      "id": "p_abc123",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T14:45:00.000Z",
      "agent_id": "<string>",
      "version_number": 123,
      "ant_agent_version": 123,
      "createdBy": {
        "object": "user",
        "id": "u_abc123",
        "apiKeyId": "bsk_abc123"
      },
      "updatedBy": {
        "object": "user",
        "id": "u_abc123",
        "apiKeyId": "bsk_abc123"
      },
      "label": "<string>"
    }
  ],
  "orgId": "org_123",
  "sync_status": "pending",
  "web_access": {
    "enabled": true,
    "allowedHosts": [
      "<string>"
    ],
    "allowEveryUrl": true
  },
  "tool_configs": [
    {
      "name": "bash",
      "enabled": true,
      "permission_policy": "always_allow"
    }
  ],
  "mcp_servers": [
    {
      "name": "<string>",
      "url": "<string>",
      "enabled": true,
      "permission_policy": "always_allow",
      "tools": [
        {
          "name": "<string>",
          "enabled": true,
          "permission_policy": "always_allow"
        }
      ],
      "connection_account_id": "<string>"
    }
  ],
  "createdBy": {
    "object": "user",
    "id": "u_abc123",
    "apiKeyId": "bsk_abc123"
  },
  "updatedBy": {
    "object": "user",
    "id": "u_abc123",
    "apiKeyId": "bsk_abc123"
  },
  "description": "Manage projects with Kanban boards",
  "icon": {
    "type": "emoji",
    "emoji": "page_icon",
    "external": {
      "url": "https://example.com/image.jpg"
    },
    "file_upload": {
      "id": "fu_abc123"
    },
    "domain": "acme.com",
    "file": {
      "url": "https://s3.amazonaws.com/...",
      "expiryTime": "2024-01-15T10:30:00.000Z"
    },
    "lucide": "file-text",
    "brand": "github",
    "dicebear": {
      "style": "notionists-neutral",
      "seed": "0256de50-f90c-49a8-81f0-3988b2b89d8d",
      "backgroundColor": "b6e3f4,b6e3f4",
      "options": {
        "shape": "circle",
        "bodyColor": "<string>",
        "animationVariant": "fastest",
        "brows": "<string>",
        "eyes": "<string>",
        "glasses": "<string>",
        "lips": "<string>",
        "nose": "<string>",
        "flip": true,
        "rotate": 123,
        "scale": 123,
        "radius": 123,
        "size": 123,
        "backgroundType": "solid",
        "backgroundRotation": [
          123
        ],
        "translateX": 123,
        "translateY": 123,
        "clip": true,
        "randomizeIds": true
      }
    },
    "background": "blue",
    "empty": true,
    "updatedBy": "dataset:empresas"
  },
  "target_type": "company",
  "format": "markdown",
  "source_file_id": "<string>",
  "pptx_metadata": {
    "slideWidth": 123,
    "slideHeight": 123,
    "slideCount": 123,
    "title": "<string>",
    "author": "<string>"
  },
  "has_steps": false,
  "presentation_versions": [],
  "current_presentation_version": "<string>",
  "active_version_id": "<string>",
  "datasets": [
    "empresas",
    "pessoas"
  ],
  "sync_at": "<string>",
  "sync_error": "<string>",
  "skills_mode": "auto",
  "skill_ids": [
    "<string>"
  ],
  "instructions": "<string>",
  "tools_mode": "auto",
  "custom_tool_ids": [
    "<string>"
  ],
  "subagent_ids": [
    "<string>"
  ],
  "knowledge_file_ids": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

OAuth2 Authorization Code flow

Path Parameters

string

required

Agent ID

slideIndex

number

required

Slide index (0-based)

Query Parameters

version

string

required

Body

application/json

overview

string

Overview description of what the slide should contain

elements

object[]

Elements to update

Show child attributes

Response

Slide updated successfully

object

string

required

Object type

Example:

"page"

string

required

Unique identifier

Example:

"p_abc123"

createdAt

string<date-time>

required

Creation timestamp

Example:

"2024-01-15T10:30:00.000Z"

updatedAt

string<date-time>

required

Last update timestamp

Example:

"2024-01-15T14:45:00.000Z"

name

string

required

Agent name

Example:

"Project Management Agent"

slug

string

required

URL-friendly slug

Example:

"project-management"

status

enum<string>

required

Agent publication status

Available options:

available,

draft,

native,

internal

steps

object[]

required

Show child attributes

evaluations

object[]

required

Show child attributes

execution_mode

enum<string>

default:one_shot

required

Available options:

iterative,

one_shot

versions

object[]

required

Immutable agent configuration versions

Show child attributes

orgId

string

required

Organization ID

Example:

"org_123"

sync_status

enum<string>

required

Managed sync status

Available options:

pending,

preparing,

ready,

error

web_access

object

required

Show child attributes

tool_configs

object[]

required

Built-in tool permissions

Show child attributes

mcp_servers

object[]

required

MCP servers wired to this agent

Show child attributes

createdBy

Created by · object

Principal who created this object

Show child attributes

Example:

{
  "object": "user",
  "id": "u_abc123",
  "apiKeyId": "bsk_abc123"
}

updatedBy

Updated by · object

Principal who last updated this object

Show child attributes

Example:

{
  "object": "user",
  "id": "u_abc123",
  "apiKeyId": "bsk_abc123"
}

description

string | null

Agent description

Example:

"Manage projects with Kanban boards"

icon

object | null

Agent icon

Show child attributes

target_type

string | null

Target entity type

Example:

"company"

format

enum<string> | null

Agent format

Available options:

markdown,

pptx,

docx

source_file_id

string | null

Source file upload ID (for pptx/docx agents)

pptx_metadata

object | null

PPTX presentation metadata (for pptx agents)

Show child attributes

has_steps

boolean

default:false

Whether the agent has configured steps

presentation_versions

object[]

Version history for PPTX agent analyses

Show child attributes

current_presentation_version

string | null

Currently active version (ISO timestamp)

active_version_id

string | null

Active immutable agent version id

datasets

string[]

Distinct dataset slugs used across all steps of this agent

Example:

["empresas", "pessoas"]

sync_at

string | null

Last successful managed sync timestamp

sync_error

string | null

Last managed sync error

skills_mode

enum<string>

auto grants every skill visible to the org; custom uses skill_ids; disabled grants none

Available options:

auto,

custom,

disabled

skill_ids

string[]

Skill IDs enabled for this agent

instructions

string | null

tools_mode

enum<string>

auto grants every published custom tool of the org; custom uses custom_tool_ids; disabled grants none

Available options:

auto,

custom,

disabled

custom_tool_ids

string[]

Custom tool IDs enabled for this agent

subagent_ids

string[]

Subagent IDs this agent coordinates as a multiagent

knowledge_file_ids

string[]

File upload IDs that make up this agent knowledge base

datasets

files

users

pages

people

queries

providers

companies

Company Enrichment

sessions

blocks

agents

entities

lawsuits

scr

changelog

events

search

Feature Store

graph

targets

rules

Update a slide in a PPTX agent

Authorizations

Path Parameters

Query Parameters

Body

Response