Generate SDKs with OpenAPI

Each endpoint exposes an OpenAPI 3.0 spec that you can use to generate typed SDK clients for your preferred language.

Getting the spec

Fetch the OpenAPI spec for any endpoint:

Terminal
curl \
  -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
  "<ph_app_host>/api/projects/{project_id}/endpoints/{endpoint_name}/openapi.json"

The spec includes request schemas (with any variables your endpoint defines), response schemas, and authentication requirements.

Generating a TypeScript client

Using @hey-api/openapi-ts:

Terminal
# Save the spec
curl -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
  "<ph_app_host>/api/projects/{project_id}/endpoints/{endpoint_name}/openapi.json" \
  > openapi.json

# Generate the client
npx @hey-api/openapi-ts -i openapi.json -o ./src/posthog-client

Generating a Python client

Using openapi-generator:

Terminal
# Save the spec
curl -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
  "<ph_app_host>/api/projects/{project_id}/endpoints/{endpoint_name}/openapi.json" \
  > openapi.json

# Generate the client
openapi-generator generate -i openapi.json -g python -o ./posthog_client

Other generators

The spec works with any OpenAPI 3.0 compatible tool. See the OpenAPI Generator list for options in other languages.

Generate SDKs with OpenAPI

Contents

Getting the spec

Generating a TypeScript client

Generating a Python client

Other generators

Community questions

Was this page useful?