# dotCMS AI API

**Canonical:** https://apis.io/apis/dotcms/dotcms-ai-api/  
**Provider:** dotCMS — https://apis.io/providers/dotcms/  
**Base URL:** https://demo.dotcms.com/api  
**Documentation:** https://dev.dotcms.com/docs/build/apis/api-basics/rest-apis

dotCMS AI API is one of 73 APIs that [dotCMS](https://apis.io/providers/dotcms/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Artificial Intelligence. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

AI-powered content generation and analysis endpoints

## Operations (23)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/ai/providers` | List dotAI provider configuration metadata |
| POST | `/api/v1/ai/providers/test/{capability}` | Test a dotAI provider connection |
| GET | `/api/v1/ai/completions/config` | Get AI service configuration |
| PUT | `/api/v1/ai/completions/config` | Save AI provider configuration |
| POST | `/api/v1/ai/completions/rawPrompt` | Generate AI completions from raw prompt |
| POST | `/api/v1/ai/completions` | Generate AI completions from content |
| GET | `/api/v1/ai/embeddings/count` | Count 1 |
| POST | `/api/v1/ai/embeddings/count` | Count |
| POST | `/api/v1/ai/embeddings` | Embed |
| DELETE | `/api/v1/ai/embeddings` | Delete |
| DELETE | `/api/v1/ai/embeddings/db` | Drop and recreate tables |
| GET | `/api/v1/ai/embeddings/indexCount` | Index count |
| GET | `/api/v1/ai/embeddings/test` | Text resource |
| GET | `/api/v1/ai/image/generate` | Index by inode 1 |
| POST | `/api/v1/ai/image/generate` | Handle image request |
| GET | `/api/v1/ai/image/test` | Index by inode |
| GET | `/api/v1/ai/search/related` | Related by get |
| POST | `/api/v1/ai/search/related` | Related by post |
| GET | `/api/v1/ai/search` | Search by get |
| POST | `/api/v1/ai/search` | Search by post |
| GET | `/api/v1/ai/search/test` | Test response |
| GET | `/api/v1/ai/text/generate` | Do get |
| POST | `/api/v1/ai/text/generate` | Do post |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/openapi/dotcms-ai-api-openapi.yml
- **Documentation** — https://dev.dotcms.com/docs/build/apis/api-basics/rest-apis
- **DeveloperPortal** — https://dev.dotcms.com/
- **APIReference** — https://dev.dotcms.com/docs/build/apis/rest-apis/api-playground
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/errors/dotcms-problem-types.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/data-model/dotcms-data-model.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/dotcms/refs/heads/main/conventions/dotcms-conventions.yml

## Other dotCMS APIs (12)

- [dotCMS GraphQL API](https://apis.io/apis/dotcms/graphql/)
- [dotCMS Accessibility Agent API](https://apis.io/apis/dotcms/dotcms-accessibility-agent-api/)
- [dotCMS Accessibility Checker API](https://apis.io/apis/dotcms/dotcms-accessibility-checker-api/)
- [dotCMS Administration API](https://apis.io/apis/dotcms/dotcms-administration-api/)
- [dotCMS Announcements API](https://apis.io/apis/dotcms/dotcms-announcements-api/)
- [dotCMS API Token API](https://apis.io/apis/dotcms/dotcms-api-token-api/)
- [dotCMS Apps API](https://apis.io/apis/dotcms/dotcms-apps-api/)
- [dotCMS Authentication API](https://apis.io/apis/dotcms/dotcms-authentication-api/)
- [dotCMS Browser Tree API](https://apis.io/apis/dotcms/dotcms-browser-tree-api/)
- [dotCMS Bundle API](https://apis.io/apis/dotcms/dotcms-bundle-api/)
- [dotCMS Cache Management API](https://apis.io/apis/dotcms/dotcms-cache-management-api/)
- [dotCMS Categories API](https://apis.io/apis/dotcms/dotcms-categories-api/)

## Tags

Artificial Intelligence

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/dotcms/dotcms-ai-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/dotcms/.