:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
/**
* Auto-generated from the Django backend OpenAPI schema.
* To modify these types, update the Django serializers or views, then run:
* hogli build:openapi
* Questions or issues? #team-devex on Slack
*
* PostHog API - generated
* OpenAPI spec version: 1.0.0
*/
/**
* Response shape for a channel's page identity in the wiki.
*/
export interface ChannelWikiPageApi {
/** Repo-relative path of the wiki page whose frontmatter names the channel. */
path: string
/** Whether a page exists at this path. False when the path is a proposal for a channel whose page has not been created yet. */
exists?: boolean
}
/**
* Request body for landing agent commits posted back as a git bundle.
*/
export interface CommitBundleApi {
/** A `git bundle` carrying the ref to land, created in the agent's clone (for example `git bundle create out.bundle origin/main..main`). */
bundle: string
/**
* Optional run summary stored in the landed commit body.
* @maxLength 10000
*/
summary?: string
/**
* Land a dated dreaming branch (`dream/<YYYY-MM-DD>`) as one merge commit instead of rebasing onto `main`. Omit for ordinary commits on `main`.
* @maxLength 64
* @nullable
*/
branch?: string | null
}
/**
* Response shape for the wiki's current state.
*/
export interface ContextLayerStatusApi {
/** Commit sha of the wiki's current head. */
head_sha: string
}
/**
* 400 body when a write violates the wiki's structure rules.
*/
export interface LintErrorApi {
/** What was rejected. */
detail: string
/** One entry per structure violation found by the linter. */
errors: string[]
}
/**
* * `not_started` - not_started
* * `queued` - queued
* * `in_progress` - in_progress
*/
export type ActiveDreamRunRunStatusEnumApi =
(typeof ActiveDreamRunRunStatusEnumApi)[keyof typeof ActiveDreamRunRunStatusEnumApi]
export const ActiveDreamRunRunStatusEnumApi = {
NotStarted: 'not_started',
Queued: 'queued',
InProgress: 'in_progress',
} as const
/**
* A dreaming task that has not reached a terminal state yet.
*/
export interface ActiveDreamRunApi {
/** The current task-run state for the active dream.
*
* * `not_started` - not_started
* * `queued` - queued
* * `in_progress` - in_progress */
run_status: ActiveDreamRunRunStatusEnumApi
/** When the active dream task was created. */
started_at: string
}
export interface UnpublishedDreamRunApi {
/** Task URL in its project for the unpublished dream outcome and logs. */
task_url: string
/** The terminal task-run state, such as completed, failed, or cancelled. */
run_status: string
/** When the unpublished dream task was created. */
started_at: string
}
/**
* One dreaming run: the merge commit it landed as, plus what it changed.
*/
export interface DreamRunApi {
/** Merge commit sha the run landed as; pass back as `sha` on the detail read. */
sha: string
/** The run's date, `YYYY-MM-DD`. */
date: string
/** When the run landed. */
committed_at: string
/** The run summary the dreaming agent wrote. */
summary: string
/** Pages the run created. */
pages_added: number
/** Pages the run edited. */
pages_modified: number
/** Pages the run removed. */
pages_deleted: number
}
/**
* Response shape for the wiki's dream run listing.
*/
export interface DreamRunListApi {
/** Commit sha of the wiki's current head. */
head_sha: string
/** The organization's active dreaming task, or null when no dream is running. */
active_run: ActiveDreamRunApi | null
/** The latest finished dream when no update was published after it started, or null otherwise. */
unpublished_run: UnpublishedDreamRunApi | null
/** Every landed dream run, newest first. */
dreams: DreamRunApi[]
}
/**
* * `added` - added
* * `modified` - modified
* * `deleted` - deleted
*/
export type DreamFileDiffStatusEnumApi = (typeof DreamFileDiffStatusEnumApi)[keyof typeof DreamFileDiffStatusEnumApi]
export const DreamFileDiffStatusEnumApi = {
Added: 'added',
Modified: 'modified',
Deleted: 'deleted',
} as const
/**
* One file a dream run changed, with its unified patch.
*/
export interface DreamFileDiffApi {
/** Repo-relative path of the changed page. */
path: string
/** How the run changed the page.
*
* * `added` - added
* * `modified` - modified
* * `deleted` - deleted */
status: DreamFileDiffStatusEnumApi
/** Unified git patch for this file. */
patch: string
/** Whether the patch was cut off for size. */
truncated: boolean
}
/**
* Response shape for one dream run: the run plus the diff it landed.
*/
export interface DreamRunDetailApi {
run: DreamRunApi
/** Per-file patches, in diff order. */
files: DreamFileDiffApi[]
}
/**
* Response shape for a wiki bundle export.
*/
export interface WikiExportApi {
/** Short-lived download URL for the wiki's current bundle. */
url: string
/** Commit sha of the bundle behind the URL. */
head_sha: string
}
/**
* Response shape for one wiki page.
*/
export interface WikiPageApi {
/** Repo-relative path of the page, for example `areas/analytics.md`. */
path: string
/** The page's Markdown content. */
content: string
/** Commit sha the content was read at; pass back as `base_head` on writes. */
head_sha: string
/** When this page was last changed in the wiki history. */
updated_at: string
/** Character offset of this chunk. */
offset: number
/** Character length of the complete page. */
total_length: number
/**
* Next character offset, or null when complete.
* @nullable
*/
next_offset: number | null
/** True when no further chunks remain. Do not write a page until all chunks are read. */
complete: boolean
}
/**
* Request body for creating or replacing one wiki page.
*/
export interface WikiPageWriteApi {
/**
* Repo-relative Markdown path inside the wiki's structure, for example `projects/12/spaces/general.md`.
* @maxLength 512
*/
path: string
/**
* The complete Markdown content for the page.
* @maxLength 1000000
*/
content: string
/**
* Optimistic-concurrency guard: the head sha the edit is based on. A moved head is rejected with 409 and the current head; omit to write unguarded.
* @nullable
*/
base_head?: string | null
}
/**
* 409 body when a guarded write was based on a stale head.
*/
export interface HeadConflictApi {
/** What moved and what to do next. */
detail: string
/** The wiki's current head sha; re-read pages at this head and retry. */
current_head: string
}
export interface WikiPageProposalApi {
/** Immutable suggested edit ID. Only its author can apply it through the user API. */
id: string
/** Task that proposed the edit. */
task_id: string
/** Shared wiki page to review. */
path: string
/** Page content at the revision the proposal is based on. */
original_content: string
/** Proposed page content. This is not published wiki content. */
content: string
/** Wiki revision the proposal is based on. */
base_head: string
/** When the edit was proposed. */
created_at: string
}
export interface PaginatedWikiPageProposalListApi {
count: number
/** @nullable */
next?: string | null
/** @nullable */
previous?: string | null
results: WikiPageProposalApi[]
}
/**
* Response shape for the wiki's page listing.
*/
export interface WikiTreeApi {
/** Commit sha of the wiki's current head. */
head_sha: string
/** Repo-relative path of every Markdown page at the current head. */
paths: string[]
}
export interface WikiHealthFindingApi {
/** Stable category used to group this finding. */
category: string
/** Wiki page path associated with this finding. */
path: string
/** Human-readable explanation of the finding. */
message: string
}
export interface WikiHealthReportApi {
/** Commit sha inspected by the report. */
head_sha: string
/** Health findings for the current wiki head. */
findings: WikiHealthFindingApi[]
}
/**
* Request body for creating or replacing one wiki page.
*/
export interface WikiPageProposalWriteApi {
/**
* Repo-relative Markdown path inside the wiki's structure, for example `projects/12/spaces/general.md`.
* @maxLength 512
*/
path: string
/**
* The complete Markdown content for the page.
* @maxLength 1000000
*/
content: string
/**
* The head_sha returned when reading the page. Required to bind the proposed edit.
* @maxLength 64
*/
base_head: string
}
export type ContextLayerPagesRetrieveParams = {
/**
* Head from the first chunk. Required for continuation. A changed head returns 409.
* @minLength 1
* @maxLength 64
*/
head_sha?: string
/**
* Maximum characters to read. Omit for the full page.
* @minimum 1
* @maximum 12000
*/
limit?: number
/**
* Character offset from next_offset.
* @minimum 0
*/
offset?: number
/**
* Repo-relative Markdown path of the page to read.
* @minLength 1
*/
path: string
}
export type ContextLayerProposalsListParams = {
/**
* Number of results to return per page.
*/
limit?: number
/**
* The initial index from which to return the results.
*/
offset?: number
}
export type ContextLayerAgentPagesRetrieveParams = {
/**
* Head from the first chunk. Required for continuation. A changed head returns 409.
* @minLength 1
* @maxLength 64
*/
head_sha?: string
/**
* Maximum characters to read. Omit for the full page.
* @minimum 1
* @maximum 12000
*/
limit?: number
/**
* Character offset from next_offset.
* @minimum 0
*/
offset?: number
/**
* Repo-relative Markdown path of the page to read.
* @minLength 1
*/
path: string
}