dashboards

Add a markdown text tile to a dashboard.

Text tiles render as markdown blocks on the dashboard — useful as section headings, dividers, or annotations between insight tiles to give the dashboard structure.

post/api/projects/{project_id}/dashboards/{id}/create_text_tile/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/dashboards/{id}/create_text_tile/
  • Auth: HTTP bearer

Path parameters

idinteger required

A unique integer value identifying this dashboard.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

format'json' | 'txt'

Request body

type'text' | 'image'
  • text - text
  • image - image
bodystring required

Markdown body for the dashboard tile. Text tiles support headings, lists, and inline formatting. Image tiles require exactly one Markdown image. Max 4000 characters.

agent_contextstring nullable

Optional context that helps AI agents make consistent dashboard updates, such as Data Catalog metric names, data sources, tile-specific query assumptions, caveats, or editing guidance. PostHog's Data Catalog is the semantic layer. Store canonical metric definitions there, not in this field. An empty string or null means there is no agent context. Shared and exported dashboards, and organizations without AI data processing approval, omit this field. Max 10000 characters.

colorstring nullable

Optional accent color name (e.g. 'blue', 'green', 'purple', 'black').

Response

idinteger
layoutsunknown
colorstring nullable
filters_overridesunknown
show_descriptionboolean nullable
transparent_backgroundboolean nullable
group_keystring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.