Text API

Read text, text length, and paragraph details from text-bearing objects in a presentation.

Data Center:

GET Get Text Content

GET https://show.zoho.com/api/v1/presentation/{rid}/{container}/{container_id}/text/{object_id}

Required Scopes:

ZohoShow.showdocslist.READ

Reads text from a text-bearing object, such as a shape, connector label, table cell carrier, or group child where supported. Use this endpoint to fetch flattened text, text length, or paragraph count before applying text mutations. The fetch_type query parameter determines which text view is returned. Use full text reads for display and search, length reads for range validation, and paragraph count reads when your editor needs stable paragraph boundaries. fetch_type=paragraph_text is not currently usable: the server requires a paragraph range that has no corresponding request parameter, so every call to it returns an error regardless of input.

Path parameters

Name	Type	Required	Description
rid	string	Required	Resource id of the presentation. The caller must have the appropriate permission on this presentation.
container	string	Required	Container type that owns the object. Allowed values: slides, masters, layouts.
container_id	string	Required	Id of the selected container. Provide slide_id when container is slides, master_id when container is masters, or layout_id when container is layouts.
object_id	string	Required	Object id inside the selected container.

Query parameters

Name	Type	Required	Description
fetch_type	string	Required	Text retrieval mode. Allowed values: text, length, paragraph_count, paragraph_text. paragraph_text is not currently usable — see the endpoint description.
all_text	boolean	Optional	When true, returns all text content. This is the default behavior for fetch_type=text. Mutually exclusive with range_start/range_end.
range_start	integer	Optional	Zero-based start index of the text range (inclusive). Required together with range_end, and mutually exclusive with all_text.
range_end	integer	Optional	Zero-based end index of the text range (exclusive — this index is not included). Must be greater than range_start; required together with range_start.

Samples

Responses

200 Full Text (fetch_type=text)

400 Invalid Text Range

400 Missing Paragraph Range

400 Invalid Fetch Type

200 Text Length (fetch_type=length)

200 Paragraph Count (fetch_type=paragraph_count)

{
  "data": {
    "mutation": {
      "new_revision_id": "1"
    },
    "text": "Replaced all"
  },
  "message": "Text retrieved successfully",
  "request_uri": "/api/v1/presentation/8i4vv3f345fcf907446a2bdc4e2c871fc585e/slides/54ca442b-63d1-43df-bda9-9f8cd2654e70/text/28f4b1b9-923d-47de-b5f7-5bc7ca05aba2",
  "status": "success"
}

Code Examples

cURL

curl -X GET "https://show.zoho.com/api/v1/presentation/{rid}/{container}/{container_id}/text/{object_id}?fetch_type=text&all_text=true&range_start=0&range_end=10" \
  -H "Authorization: Zoho-oauthtoken YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

JavaScript

const response = await fetch('https://show.zoho.com/api/v1/presentation/{rid}/{container}/{container_id}/text/{object_id}?fetch_type=text&all_text=true&range_start=0&range_end=10', {
  method: 'GET',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
// Process the response data
return data;

Node.js

const https = require('https');
const url = require('url');

const options = {
  ...url.parse('https://show.zoho.com/api/v1/presentation/{rid}/{container}/{container_id}/text/{object_id}?fetch_type=text&all_text=true&range_start=0&range_end=10'),
  method: 'GET',
  headers: {
    'Authorization': 'Zoho-oauthtoken YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => {
    const result = JSON.parse(data);
    // Process the response data
  });
});

req.end();

Python

import requests

url = "https://show.zoho.com/api/v1/presentation/{rid}/{container}/{container_id}/text/{object_id}?fetch_type=text&all_text=true&range_start=0&range_end=10"
headers = {
    "Authorization": "Zoho-oauthtoken YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
data = response.json()
print(data)

Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.time.Duration;

public class ApiClient {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newBuilder()
            .connectTimeout(Duration.ofSeconds(10))
            .build();

        HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
            .uri(URI.create("https://show.zoho.com/api/v1/presentation/{rid}/{container}/{container_id}/text/{object_id}?fetch_type=text&all_text=true&range_start=0&range_end=10"))
            .header("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN")
            .timeout(Duration.ofSeconds(30));

            .header("Content-Type", "application/json")
        HttpRequest request = requestBuilder
            .GET(HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

Deluge

info "Making API request to: https://show.zoho.com/api/v1/presentation/{rid}/{container}/{container_id}/text/{object_id}?fetch_type=text&all_text=true&range_start=0&range_end=10";

headers = Map();
headers.put("Authorization", "Zoho-oauthtoken YOUR_ACCESS_TOKEN");
headers.put("Content-Type", "application/json");

response = invokeurl
[
    url: "https://show.zoho.com/api/v1/presentation/{rid}/{container}/{container_id}/text/{object_id}?fetch_type=text&all_text=true&range_start=0&range_end=10"
    type: GET
    headers: headers
];

if (response.get("status_code") == 200) {
    info "Request successful";
    responseData = response.get("response");
    info responseData;
} else {
    info "Request failed with status: " + response.get("status_code");
    info response.get("response");
}