---
title: "Analyze - Cld-Text"
method: POST
path: "/analyze/cld_text"
tags: ["Analysis"]
---

# Analyze - Cld-Text

`POST /analyze/cld_text`

Analyze an image using the [Cld-Text](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#ai_based_image_captioning) content-aware detection model. Cloudinary's text model tells you if your image includes text, and where it's located. Used with image tagging, you can then search for images that contain blocks of text. Used with object-aware cropping, you can choose to keep only the text part, or specify a crop that avoids the text.

## Request body

- AnalyzeCldTextRequest
  - `source` union, required
    - object
      - `asset_id` string, required — The asset ID to analyze
      - `uri` string, uri — The URI of the asset to analyze
    - object
      - `asset_id` string — The asset ID to analyze
      - `uri` string, uri, required — The URI of the asset to analyze
  - `async` boolean — Whether to perform the analysis asynchronously. If true, the response is returned immediately and analysis is done in the background. Once complete, a webhook notification will be sent to the specified URL and/or to the URLs defined in the Webhook Notifications settings of your Cloudinary Console.
  - `notification_url` string — The webhook URL to notify when the analysis is complete. Only relevant when async is set to true.

## Response `200`

Analysis succeeded

- AnalyzeCldTextResponse, nullable
  - `data` object
    - `entity` string
    - `analysis` CldTextAnalysisData
      - `tags` object, required
      - `model_version` integer
  - `limits` LimitsObject, nullable
    - `items` object[]
      - `type` 'google_tagging' | 'object_detection' | 'ai_vision', required
      - `used_by_request` integer, nullable — The amount of quota used by the current request
      - `remaining` integer, nullable — The remaining quota
      - `limit` integer, nullable — The total quota limit
      - `reset_time` string, date-time, nullable — Time in UTC when the limit will be reset
  - `request_id` string

## Other responses

- `202` — Analysis accepted
- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `429` — Rate limited
- `500` — Internal server error

---

[API](https://skmtc.net/cloudinary/apis/analyze-api-beta.md) · [All operations](https://skmtc.net/cloudinary/apis/analyze-api-beta/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudinary/analyze-api-beta/versions/b54402e987f1/schema)