px[0] is an open-source prompt infrastructure toolkit for managing prompts in production. It replaces hardcoded prompt strings with versioned templates, in-process caching, and OpenTelemetry observability, so teams can iterate on prompts without touching application code. This is the OpenAPI specification for all the public APIs of px0.
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version: 0.1.2
- Generator version: 7.10.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/net/contextPut the package under your project folder and add the following in import:
import px0 "github.com/px0-ai/px0-go"To use a proxy, set the environment variable HTTP_PROXY:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.
For using other server than the one defined on index 0 set context value px0.ContextServerIndex of type int.
ctx := context.WithValue(context.Background(), px0.ContextServerIndex, 1)Templated server URL is formatted using default variables from configuration or from context value px0.ContextServerVariables of type map[string]string.
ctx := context.WithValue(context.Background(), px0.ContextServerVariables, map[string]string{
"basePath": "v2",
})Note, enum values are always validated and all unused variables are silently ignored.
Each operation can use different server URL defined using OperationServers map in the Configuration.
An operation is uniquely identified by "{classname}Service.{nickname}" string.
Similar rules for overriding default operation server index and variables applies by using px0.ContextOperationServerIndices and px0.ContextOperationServerVariables context maps.
ctx := context.WithValue(context.Background(), px0.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), px0.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})All URIs are relative to http://localhost:3000
| Class | Method | HTTP request | Description |
|---|---|---|---|
| APIKeysAPI | CreateAPIKey | Post /v1/api-keys | Create an API Key |
| APIKeysAPI | DeleteAPIKey | Delete /v1/api-keys/{id} | Delete an API Key |
| APIKeysAPI | ListAPIKeys | Get /v1/api-keys | List API Keys |
| AuthAPI | Login | Post /v1/auth/login | Login |
| AuthAPI | Logout | Delete /v1/auth/session | Logout |
| AuthAPI | Register | Post /v1/auth/register | Register a new user |
| AuthAPI | ResetPassword | Post /v1/auth/password-reset/reset | Reset Password |
| AuthAPI | TriggerPasswordReset | Post /v1/auth/password-reset/trigger | Trigger Password Reset |
| AuthAPI | TriggerVerificationEmail | Get /v1/auth/verify-email | Trigger Verification Email |
| AuthAPI | VerifyEmail | Post /v1/auth/verify-email | Verify User Email |
| HealthAPI | HealthCheck | Get /v1/health | Health Check |
| InboxAPI | GetAdminInbox | Get /v1/me/inbox | Get Admin Inbox |
| InboxAPI | ResolveJoinRequest | Put /v1/join-requests/{id} | Resolve Join Request |
| OrganizationsAPI | CreateOrg | Post /v1/orgs | Create Organization |
| OrganizationsAPI | DeleteOrg | Delete /v1/orgs/{id} | Delete Organization |
| OrganizationsAPI | ListOrgPeople | Get /v1/orgs/{orgID}/people | List Org People |
| OrganizationsAPI | RemoveOrgMember | Delete /v1/orgs/{orgID}/members/{userID} | Remove Member from Organization |
| OrganizationsAPI | UpdateOrg | Put /v1/orgs/{id} | Update Organization |
| ProfileAPI | ChangePassword | Post /v1/auth/me/change-password | Change Password |
| ProfileAPI | DeleteMe | Delete /v1/auth/me | Delete Me |
| ProfileAPI | ListUserOrgs | Get /v1/me/orgs | List User Organizations |
| ProfileAPI | ListUserTeams | Get /v1/me/teams | List User Teams |
| ProfileAPI | Me | Get /v1/auth/me | Me |
| ProfileAPI | UpdateMe | Put /v1/auth/me | Update Me |
| PromptPayloadsAPI | CreatePromptPayload | Post /v1/prompts/{id}/payloads | Create a Prompt Payload |
| PromptPayloadsAPI | DeletePromptPayload | Delete /v1/prompts/{id}/payloads/{payloadID} | Delete a Prompt Payload |
| PromptPayloadsAPI | GetPromptPayload | Get /v1/prompts/{id}/payloads/{payloadID} | Get a Prompt Payload |
| PromptPayloadsAPI | ListPromptPayloads | Get /v1/prompts/{id}/payloads | List Prompt Payloads |
| PromptPayloadsAPI | UpdatePromptPayload | Put /v1/prompts/{id}/payloads/{payloadID} | Update a Prompt Payload |
| PromptRendersAPI | RenderLive | Post /v1/prompts/{slug}/render | Render Live Prompt Version |
| PromptRendersAPI | RenderVersion | Post /v1/prompts/{slug}/versions/{version}/render | Render Specific Prompt Version |
| PromptVersionsAPI | ArchiveVersion | Post /v1/prompts/{id}/versions/{version}/archive | Archive Prompt Version |
| PromptVersionsAPI | CreateVersion | Post /v1/prompts/{id}/versions | Create a Prompt Version |
| PromptVersionsAPI | DeletePromptVersion | Delete /v1/prompts/{id}/versions/{version} | Delete Prompt Version Draft |
| PromptVersionsAPI | DemoteVersion | Post /v1/prompts/{id}/versions/{version}/demote | Demote Prompt Version |
| PromptVersionsAPI | DiffVersions | Get /v1/prompts/{id}/versions/diff | Diff Prompt Versions |
| PromptVersionsAPI | DuplicateVersion | Post /v1/prompts/{id}/versions/{version}/duplicate | Duplicate Prompt Version |
| PromptVersionsAPI | GetVersion | Get /v1/prompts/{id}/versions/{version} | Get Prompt Version |
| PromptVersionsAPI | ListVersionTags | Get /v1/prompts/{id}/tags | List Prompt Version Tags |
| PromptVersionsAPI | ListVersions | Get /v1/prompts/{id}/versions | List Prompt Versions |
| PromptVersionsAPI | PromoteVersion | Post /v1/prompts/{id}/versions/{version}/promote | Promote Prompt Version |
| PromptVersionsAPI | RemoveVersionTag | Delete /v1/prompts/{id}/tags/{tag} | Remove Version Tag |
| PromptVersionsAPI | SetVersionTag | Post /v1/prompts/{id}/versions/{version}/tags | Attach/Set Version Tag |
| PromptVersionsAPI | UpdateVersion | Put /v1/prompts/{id}/versions/{version} | Update Prompt Version Draft |
| PromptsAPI | ArchivePrompt | Post /v1/prompts/{id}/archive | Archive a Prompt |
| PromptsAPI | CreatePrompt | Post /v1/teams/{teamID}/prompts | Create a Prompt |
| PromptsAPI | GetPrompt | Get /v1/prompts/{id} | Get a Prompt |
| PromptsAPI | ListAllPrompts | Get /v1/prompts | List all prompts with team filter |
| PromptsAPI | ListPrompts | Get /v1/teams/{teamID}/prompts | List Prompts |
| PromptsAPI | MovePrompt | Post /v1/prompts/{id}/move | Move a Prompt |
| PromptsAPI | RestorePrompt | Post /v1/prompts/{id}/restore | Restore a Prompt |
| PromptsAPI | UpdatePrompt | Put /v1/prompts/{id} | Update a Prompt |
| TeamManagementAPI | CreateTeam | Post /v1/orgs/{orgID}/teams | Create Team |
| TeamManagementAPI | DeleteTeam | Delete /v1/teams/{id} | Delete Team |
| TeamManagementAPI | ListOrgTeams | Get /v1/orgs/{orgID}/teams | List Org Teams |
| TeamManagementAPI | UpdateTeam | Put /v1/teams/{id} | Update Team |
| TeamsAPI | CreateJoinRequest | Post /v1/teams/{id}/join-requests | Request to Join Team |
| TeamsAPI | LeaveTeam | Delete /v1/me/teams/{teamID} | Leave Team |
| UserManagementAPI | AddTeamMember | Post /v1/teams/{id}/members | Add Team Member |
| UserManagementAPI | ListTeamMembers | Get /v1/teams/{id}/members | List Team Members |
| UserManagementAPI | RemoveTeamMember | Delete /v1/teams/{id}/members/{userID} | Remove Team Member |
| UserManagementAPI | UpdateTeamMemberRole | Put /v1/teams/{id}/members/{userID}/role | Update Team Member Role |
- APIError
- APIKeyCreatedResponse
- AddTeamMemberRequest
- ApiKeyObject
- ChangePassword200Response
- ChangePasswordRequest
- CreateAPIKeyRequest
- CreateOrg201Response
- CreateOrgRequest
- CreatePrompt201Response
- CreatePromptPayload201Response
- CreatePromptPayloadRequest
- CreatePromptRequest
- CreateTeam201Response
- CreateTeamRequest
- CreateVersion201Response
- CreateVersionRequest
- DiffVersions200Response
- GetAdminInbox200Response
- GetPrompt200Response
- HealthCheck200Response
- InboxItem
- InboxItemPayload
- JoinRequestPayload
- ListAPIKeys200Response
- ListAllPrompts200Response
- ListOrgPeople200Response
- ListPromptPayloads200Response
- ListPrompts200Response
- ListTeamMembers200Response
- ListUserOrgs200Response
- ListUserTeams200Response
- ListVersionTags200Response
- ListVersionTags200ResponseTagsInner
- ListVersions200Response
- Login200Response
- LoginRequest
- MovePromptRequest
- Organization
- OrganizationWithRole
- Prompt
- PromptPayload
- PromptVersion
- Register201Response
- RegisterRequest
- RenderRequest
- RenderResponse
- ResetPassword200Response
- ResetPasswordRequest
- ResolveJoinRequestRequest
- SetVersionTagRequest
- Team
- TeamJoinRequest
- TeamMemberResponse
- TriggerPasswordReset200Response
- TriggerPasswordResetRequest
- TriggerVerificationEmail200Response
- UpdateMeRequest
- UpdateOrgRequest
- UpdatePromptPayloadRequest
- UpdatePromptRequest
- UpdateTeamMemberRole200Response
- UpdateTeamMemberRoleRequest
- UpdateTeamRequest
- UpdateVersionRequest
- User
- VerifyEmail200Response
- VerifyRequest
Authentication schemes defined for the API:
- Type: HTTP Bearer token authentication
Example
auth := context.WithValue(context.Background(), px0.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBoolPtrIntPtrInt32PtrInt64PtrFloatPtrFloat32PtrFloat64PtrStringPtrTime