Public PromptQL Projects
PromptQL allows you to make your project accessible to anyone with a unique URL. This feature enables easy sharing and collaboration without the need for explicit access grants.
Enabling Public PromptQL Playground
You can enable the Public PromptQL Playground from the PromptQL settings page in the console.
Steps to Enable
Access PromptQL Settings
Navigate to the PromptQL settings by clicking the gear icon in the bottom left corner of the console project page. From there, select the PromptQL section.
Locate Public PromptQL Playground Section
Find the “Enable Public PromptQL Playground” option on the PromptQL settings page.
Enable and Save
Toggle the switch to enable the Public PromptQL Playground and save your changes.
Get Shareable URL
After enabling, a unique URL will be generated. This URL can be shared with anyone you want to give access to your PromptQL project.
When users access your public PromptQL project via the shared URL, they only need to log in to Hasura. No additional access granting is required, making it truly public in nature.
Custom Project README
When a project is set to public mode, project administrators can create a custom README in Markdown format. This README is visible to all users who access the project’s public URL, providing essential context and information.
To add a custom README:
- Navigate to the “README” section in the Project sidebar
- Compose or paste your Markdown content
- Click the Save button to apply changes
- For enabled public PromptQL projects, a public URL is displayed at the top of the page
The custom README feature allows you to:
- Provide project context and background
- Offer usage instructions or guidelines
- Share relevant documentation or resources
- Highlight key features or functionalities
- Set expectations for your users
By utilizing this feature effectively, you can enhance the user experience and facilitate better understanding of your public PromptQL project.
Token Usage and Billing
- By default, token usage for public projects will be billed from the user’s PromptQL credits.
- Project owners have the option to configure a custom LLM if they prefer to handle the token usage differently.