Skip to main content

Documentation

Learn how to use the Headless platform

Projects

3 min read

Projects contain your content types, entries, and media assets.

Creating a Project

  1. From your organization, click Create Project
  2. Enter a project name
  3. Choose a unique slug (e.g., marketing-site)
  4. Add an optional description
  5. Click Create

Project Dashboard

When you select a project, you'll see the project dashboard with quick access to:

  • Content Types: Define the structure of your content
  • Content: View and manage content entries
  • Media: Upload and manage files
  • API Explorer: Test your REST and GraphQL APIs

Project Settings

Access project settings through the gear icon:

  • General: Update name, slug, description, semantic search
  • Locales: Set up supported languages
  • API Keys: Manage API access tokens
  • Webhooks: Configure event notifications
  • Data: Export, import, or delete project data

Semantic search uses AI-powered embeddings to find content by meaning rather than exact keyword matches. This feature enables finding related content, searching inside documents, and discovering similar entries.

What Are Embeddings?

Embeddings are numerical representations (vectors) of text that capture semantic meaning. When you search for "vacation destinations," semantic search can find content about "holiday spots" or "travel getaways" even if those exact words weren't used.

Semantic search is disabled by default for privacy. To enable it:

  1. Go to Project Settings > General
  2. Find the Semantic Search section
  3. Toggle Enable AI-powered semantic search
  4. Click Save Changes

Important: When enabled, text content from your entries and documents will be sent to an external AI service to generate embeddings. Consider your data privacy requirements before enabling.

What Data Is Processed?

When semantic search is enabled:

  • Content entries: Text and rich text field values are sent for embedding generation
  • Media files: Text content from PDFs and documents is extracted and embedded
  • Only text content is processed - images, videos, and binary files are not sent

Embeddings are generated when you create or update a content entry, or upload a document.

Features Available

Once enabled, you can:

  • Related Content: View AI-suggested related entries in the sidebar when editing content
  • Semantic API Queries: Use ?semantic=query parameter in REST API to search by meaning
  • Similar Entries: Find similar entries with /api/v1/{project}/{contentType}/{id}/similar
  • Document Search: Search inside documents with /api/v1/{project}/media?semantic=query
  • MCP Tools: Use semantic_search, find_similar, and search_media tools

When you disable semantic search:

  1. All stored embeddings for the project are permanently deleted
  2. New content will not be indexed
  3. Semantic search queries will return informative messages

Privacy Considerations

  • Opt-in only: Must be explicitly enabled per project
  • Data sent externally: Text content is sent to an AI embedding service
  • Full cleanup: Disabling removes all stored embedding data
  • Per-project control: Each project has independent settings

Use the sidebar to switch between projects:

  1. Click on a project name in the sidebar to view it
  2. The project will open showing its dashboard
  3. Navigate through the project using the sidebar links

Deleting a Project

Warning: This action cannot be undone.

  1. Go to Project Settings > Data
  2. Click Delete Project
  3. Type the project name to confirm
  4. Click Delete Forever