Resource
Landing Page Variable Builder
Cleans up variables in landing page prompt templates — headline, audience, pain point, offer, social proof, CTA, and objections.
API Request Variable Builder
Turns a reusable API request prompt into a clean variable set covering endpoint, method, auth, payload, response format, and error handling.
Overview
API request prompt templates tend to collect variables informally: {{endpoint}} in one version, {{apiEndpoint}} in another, {{url}} in a third. When the same template is reused across teams or integrated into an automation, inconsistent variable names cause silent substitution failures. This resource gives you a structured starting point — a template with clearly named variables for the parts of an API request that actually change between calls, ready to document and export.
How to use this resource
-
Open in Prompt Variable Builder
Click the CTA to load this template into the tool. The textarea will be prefilled with the API request template.
-
Click Build Variables
The tool detects {{apiName}}, {{endpoint}}, {{httpMethod}}, and the other variables. It flags any similar names and checks for mixed naming conventions.
-
Fill in labels, types, and descriptions
Set the type for each variable — endpoint is text, timeoutSeconds is number, and so on. Add a description to clarify what each variable expects.
-
Export and document
Use the JSON export as the schema for your integration, the TypeScript interface for typed code, or the Markdown doc as a reference for your team.
Why This Works
- API request templates fail silently when variable names are inconsistent across copies — a documented schema prevents this before the template is shared
- Assigning types (text, number, json) to variables catches substitution mismatches before a call is made
- A variable schema shared alongside the template means teammates know exactly what each placeholder expects without reading the full prompt
Best for
- API request templates that have grown multiple copies with inconsistent variable names
- Teams sharing prompt templates across environments where variable naming needs to be agreed in advance
- Developers generating typed interfaces or JSON schemas from prompt variable sets
Not for
- One-off API calls where the prompt won't be reused or shared
- Templates where the API structure changes completely between uses — a schema won't help if the variables themselves are unstable
Use cases
- Documenting the variables in a reusable API integration prompt before sharing it with a backend team
- Standardising variable names across multiple copies of the same API request template
- Generating a TypeScript interface for an API request prompt used in a typed automation script
- Exporting the variable schema as JSON to validate against before an automated pipeline run
FAQ
How do I keep {{requestPayload}} and {{additionalHeaders}} separate from the scalar variables in this template?
Assign them different types in the Prompt Variable Builder. {{requestPayload}} and {{additionalHeaders}} hold structured bodies, so set them to json, while {{endpoint}} and {{authMethod}} stay text and {{timeoutSeconds}} becomes number. The tool records each type in the export, so a typed pipeline treats the payload as an object rather than a flat string, and you fill the values and run the call wherever you use the prompt.
Why does this template use {{httpMethod}} and {{authMethod}} instead of hardcoding GET and Bearer auth?
Naming them as variables lets one schema cover every call in the {{apiName}} integration. The Prompt Variable Builder detects {{httpMethod}} and {{authMethod}} as fill points, so a POST with API-key auth and a GET with Bearer both reuse the same documented template. It builds the reusable template, not the API call itself, which you send from the assistant you choose.
More resources from Prompt Variable Builder
Resource
User Story Variable Builder
Documents and exports variables from user story and acceptance criteria prompt templates — persona, goal, outcome, constraints, and definition of done.
Resource
Candidate Evaluation Variable Builder
Documents variables in candidate evaluation prompt templates — candidate name, role, interview notes, strengths, concerns, and recommendation.
Resources that pair well
Resource
Agent Task Template
A reusable AI agent task template with variables for objective, context, available tools, constraints, success criteria, failure handling, and output format.
Resource
Agent Instruction Prompt Formatter
Formats fuzzy agent instructions into a structured prompt with objective, available tools, constraints, success criteria, and failure handling.
Related tools
Tool
Prompt Variable Builder
Turn any plain prompt into a reusable, variable-based template — auto-detect values and export.