Working with Prompts

Design your AI feature in our API Console.

• Define the Prompt template, add dynamic variables or import pre-configured Prompt from Prompt library
• Set your preferred AI model
• Add Sources to provide context
• Fine tune the Prompt configuration

After configuration, your Prompt will have a dedicated REST API endpoint. You can test each Prompt in our playground prior to deployment.

• After testing, you can publish the Prompt to your Workspace for reuse by other users

To integrate with the API, perform a REST API call from your application. Send your variables in a JSON format, and the system will handle the AI context and state management. This is compatible with any programming language or framework.

// Example API integration using JavaScript
const response = await fetch('https://api.hyperleapai.com/prompt-runs/execute', {
  method: 'POST',
  headers: {
    'x-hl-api-key': 'your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    prompt_id: 'your_prompt_id',
    prompt_version_id: 'your_prompt_version_id',
    replacements: {
      variable_name: 'variable_value'
      ...
    }
  })
});

const result = await response.json();

Ensure your Prompts deliver consistent responses as configured. You can monitor usage, track costs, and adjust settings without code changes. Access audit logs to review interactions and gather feedback for continuous improvement.