# px[0] Docs

## Docs

- [Create an API Key](https://docs.px0.ai/api-reference/api-keys/create-an-api-key.md): Generates a new programmatic API key for accessing authorized resources. The full, secret API key is returned ONLY once in this response and cannot be recovered later.
- [Delete an API Key](https://docs.px0.ai/api-reference/api-keys/delete-an-api-key.md): Revokes and permanently deletes an API key by its unique UUID.
- [List API Keys](https://docs.px0.ai/api-reference/api-keys/list-api-keys.md): Lists metadata for all programmatic API keys. Secret key values are omitted.
- [Login](https://docs.px0.ai/api-reference/auth/login.md): Authenticates a user and creates a new access token.
- [Logout](https://docs.px0.ai/api-reference/auth/logout.md): Destroys the active access token, logging the user out.
- [Register a new user](https://docs.px0.ai/api-reference/auth/register-a-new-user.md): Registers a new user with an email and password. This endpoint can be called unauthenticated to register a new admin, or authenticated (as an admin) to register a standard user into a specific team.
- [Reset Password](https://docs.px0.ai/api-reference/auth/reset-password.md): Resets a user's password using a valid reset code and a new password, deriving the user from the code in the database.
- [Trigger Password Reset](https://docs.px0.ai/api-reference/auth/trigger-password-reset.md): Generates a password reset code and sends it via email to the user.
- [Trigger Verification Email](https://docs.px0.ai/api-reference/auth/trigger-verification-email.md): Triggers a new email verification code and sends it to the user's email.
- [Verify User Email](https://docs.px0.ai/api-reference/auth/verify-user-email.md): Verifies a user's email address using a numeric code sent via email.
- [Health Check](https://docs.px0.ai/api-reference/health/health-check.md): Verifies that the service is running.
- [Get Admin Inbox](https://docs.px0.ai/api-reference/inbox/get-admin-inbox.md): Returns a list of pending join requests that the authenticated user is authorized to approve or reject.
- [Resolve Join Request](https://docs.px0.ai/api-reference/inbox/resolve-join-request.md): Approves or rejects a pending join request.
- [Create Organization](https://docs.px0.ai/api-reference/organizations/create-organization.md): Creates a new organization. Requires admin privileges.
- [Delete Organization](https://docs.px0.ai/api-reference/organizations/delete-organization.md): Deletes an organization and all cascading dependencies. Requires Org Admin.
- [List Org People](https://docs.px0.ai/api-reference/organizations/list-org-people.md): Returns a paginated list of distinct people who are members of any team in the organization.
- [Remove Member from Organization](https://docs.px0.ai/api-reference/organizations/remove-member-from-organization.md): Removes a user from an organization by removing them from all teams in that organization. Requires Org Admin privileges.
- [Update Organization](https://docs.px0.ai/api-reference/organizations/update-organization.md): Updates an existing organization's metadata. Requires admin privileges.
- [Change Password](https://docs.px0.ai/api-reference/profile/change-password.md): Changes the currently logged-in user's password.
- [Delete Me](https://docs.px0.ai/api-reference/profile/delete-me.md): Deletes the currently logged-in user's account.
- [List User Organizations](https://docs.px0.ai/api-reference/profile/list-user-organizations.md): Returns a list of organizations the authenticated user belongs to.
- [List User Teams](https://docs.px0.ai/api-reference/profile/list-user-teams.md): Returns a list of teams the authenticated user belongs to.
- [Me](https://docs.px0.ai/api-reference/profile/me.md): Returns the profile of the currently logged-in user.
- [Update Me](https://docs.px0.ai/api-reference/profile/update-me.md): Updates the profile of the currently logged-in user.
- [Create a Prompt Payload](https://docs.px0.ai/api-reference/prompt-payloads/create-a-prompt-payload.md): Creates a new sample payload for the specified prompt. Only editors of the team can create.
- [Delete a Prompt Payload](https://docs.px0.ai/api-reference/prompt-payloads/delete-a-prompt-payload.md): Deletes a specific sample payload. Only editors can delete.
- [Get a Prompt Payload](https://docs.px0.ai/api-reference/prompt-payloads/get-a-prompt-payload.md): Retrieves a specific sample payload by its ID and prompt ID.
- [List Prompt Payloads](https://docs.px0.ai/api-reference/prompt-payloads/list-prompt-payloads.md): Lists all sample payloads associated with the specified prompt.
- [Update a Prompt Payload](https://docs.px0.ai/api-reference/prompt-payloads/update-a-prompt-payload.md): Updates an existing sample payload's variables and/or optional name. Only editors can update.
- [Render Live Prompt Version](https://docs.px0.ai/api-reference/prompt-renders/render-live-prompt-version.md): Renders the active 'live' template version of a prompt using supplied variables.
- [Render Specific Prompt Version](https://docs.px0.ai/api-reference/prompt-renders/render-specific-prompt-version.md): Renders a specific template version of a prompt (even draft status) using supplied variables.
- [Archive Prompt Version](https://docs.px0.ai/api-reference/prompt-versions/archive-prompt-version.md): Archives a prompt version, marking its status as archived.
- [Attach/Set Version Tag](https://docs.px0.ai/api-reference/prompt-versions/attachset-version-tag.md): Attaches a unique string tag (e.g. 'prod') to the specified prompt version, replacing the tag on any other version of this prompt if it was already assigned.
- [Create a Prompt Version](https://docs.px0.ai/api-reference/prompt-versions/create-a-prompt-version.md): Creates a new version of the prompt template in 'draft' state.
- [Delete Prompt Version Draft](https://docs.px0.ai/api-reference/prompt-versions/delete-prompt-version-draft.md): Deletes a specific prompt template version. Only versions currently in the 'draft' status may be deleted.
- [Demote Prompt Version](https://docs.px0.ai/api-reference/prompt-versions/demote-prompt-version.md): Demotes a live prompt version to stable (making it inactive but remaining read-only).
- [Diff Prompt Versions](https://docs.px0.ai/api-reference/prompt-versions/diff-prompt-versions.md): Compares the templates of two prompt versions side-by-side and returns a unified diff. Requires read access to the prompt.
- [Duplicate Prompt Version](https://docs.px0.ai/api-reference/prompt-versions/duplicate-prompt-version.md): Copies the specified prompt version's template to create a new prompt version in draft state. This operation does not copy any associated payloads, only the prompt template and other metadata.
- [Get Prompt Version](https://docs.px0.ai/api-reference/prompt-versions/get-prompt-version.md): Retrieves details of a specific prompt template version by version number.
- [List Prompt Version Tags](https://docs.px0.ai/api-reference/prompt-versions/list-prompt-version-tags.md): Lists all tags associated with versions of this prompt.
- [List Prompt Versions](https://docs.px0.ai/api-reference/prompt-versions/list-prompt-versions.md): Lists all template versions associated with a prompt container.
- [Promote Prompt Version](https://docs.px0.ai/api-reference/prompt-versions/promote-prompt-version.md): Promotes a version of the prompt template along the lifecycle: draft -> stable -> live. Promoting from draft makes it stable (read-only). Promoting from stable makes it live. When promoting a version to live, any previous live version is demoted to stable.
- [Remove Version Tag](https://docs.px0.ai/api-reference/prompt-versions/remove-version-tag.md): Removes/deletes the specified version tag from the prompt.
- [Update Prompt Version Draft](https://docs.px0.ai/api-reference/prompt-versions/update-prompt-version-draft.md): Updates the draft template code of a specific version. Only versions currently in the 'draft' status may be modified.
- [Archive a Prompt](https://docs.px0.ai/api-reference/prompts/archive-a-prompt.md): Archives a specific prompt container, setting `status` to 'archived'. The prompt still exists in the system and people can call it and use it, so a prompt is never deleted. Requires Org Admin or Team Admin privileges (GitHub repo owner model). Team Editors and Team Members are not authorized to arch…
- [Create a Prompt](https://docs.px0.ai/api-reference/prompts/create-a-prompt.md): Creates a new prompt container.
- [Get a Prompt](https://docs.px0.ai/api-reference/prompts/get-a-prompt.md): Returns details of a specific prompt container by its unique UUID or unique slug. Optionally retrieves version or tag details if requested via query parameters.
- [List all prompts with team filter](https://docs.px0.ai/api-reference/prompts/list-all-prompts-with-team-filter.md): Returns a list of prompts. If team_id query parameter is not provided, returns an empty list by default. Users can filter by a team they are a member of.
- [List Prompts](https://docs.px0.ai/api-reference/prompts/list-prompts.md): Lists all available prompt containers.
- [Move a Prompt](https://docs.px0.ai/api-reference/prompts/move-a-prompt.md): Moves a prompt from its current team to another team. Requires admin privileges on both teams.
- [Restore a Prompt](https://docs.px0.ai/api-reference/prompts/restore-a-prompt.md): Restores a previously archived prompt setting `status` back to 'active'. Requires Team Admin or Org Admin.
- [Update a Prompt](https://docs.px0.ai/api-reference/prompts/update-a-prompt.md): Updates the description of a specific prompt by its unique UUID.
- [Create Team](https://docs.px0.ai/api-reference/team-management/create-team.md): Creates a new team under a specific organization. Requires Org Admin privileges (admin on the Default Team). Team admins or editors of other custom teams are not authorized to create teams.
- [Delete Team](https://docs.px0.ai/api-reference/team-management/delete-team.md): Deletes an existing team. Requires Org Admin, Team Admin, or Team Editor privileges. Team Members (viewers) are not authorized.
- [List Org Teams](https://docs.px0.ai/api-reference/team-management/list-org-teams.md): Returns a list of all teams within the specified organization.
- [Update Team](https://docs.px0.ai/api-reference/team-management/update-team.md): Updates an existing team. Requires Org Admin, Team Admin, or Team Editor privileges. Team Members (viewers) are not authorized.
- [Leave Team](https://docs.px0.ai/api-reference/teams/leave-team.md): Allows the authenticated user to voluntarily leave a team they belong to.
- [Request to Join Team](https://docs.px0.ai/api-reference/teams/request-to-join-team.md): Creates a pending request for the authenticated user to join a specific team.
- [Add Team Member](https://docs.px0.ai/api-reference/user-management/add-team-member.md): Adds a user to a team. Requires admin privileges.
- [List Team Members](https://docs.px0.ai/api-reference/user-management/list-team-members.md): Returns a paginated list of members for a given team. Requires at least viewer access.
- [Remove Team Member](https://docs.px0.ai/api-reference/user-management/remove-team-member.md): Removes a user from a team. Requires admin privileges.
- [Update Team Member Role](https://docs.px0.ai/api-reference/user-management/update-team-member-role.md): Updates a team member's role. Requires team admin privileges.
- [Create Your First Prompt](https://docs.px0.ai/get-started/create-prompt.md): Step-by-step tutorial on creating a prompt container, authoring a prompt template, and rendering it dynamically with variables.
- [Get an Access Key](https://docs.px0.ai/get-started/get-access-key.md): Learn how to retrieve your organization and team IDs and generate a programmatic API key for secure service-to-service authentication.
- [Run px0 Locally](https://docs.px0.ai/get-started/run-locally.md): Set up and run the px0 prompt infrastructure on your local machine using Docker Compose.
- [Setup Telemetry](https://docs.px0.ai/get-started/setup-telemetry.md): Configure the end-to-end telemetry stack with Prometheus, Grafana, and the OpenTelemetry Collector to monitor and benchmark your prompt infrastructure.
- [Introduction](https://docs.px0.ai/index.md): px0 is an open-source prompt infrastructure toolkit that lets you version, update, and govern prompts in production, eliminating the need to hardcode prompts or redeploy your application for prompt changes.
- [Go](https://docs.px0.ai/sdk/go.md): Render prompt templates programmatically using the px0 Go SDK.
- [Python](https://docs.px0.ai/sdk/python.md): Render prompt templates programmatically using the px0 Python SDK.
- [TypeScript](https://docs.px0.ai/sdk/typescript.md): Render prompt templates programmatically using the px0 TypeScript SDK.
- [Template Syntax](https://docs.px0.ai/template-syntax.md): A complete guide to px0 syntax, structure, and formatting for dynamic prompt templates.

## OpenAPI Specs

- [openapi](https://docs.px0.ai/openapi.yaml)