import openai from "openai"; const OPENAI_API_KEY = process.env.OPENAI_API_KEY; // Function to send data to OpenAI for formatting async function sendToOpenAI(data) { const openaiClient = new openai.OpenAI({ apiKey: OPENAI_API_KEY }); const prompt = ` Format the following documentation for a technical API. Make it clean, concise, and organized. - Name: ${data.name} - Description: ${data.description} - Input Fields: ${JSON.stringify(data.inputFields)} - Output Fields: ${JSON.stringify(data.outputFields)} - Parameters: ${JSON.stringify(data.parameters)} - Existing articles: ${JSON.stringify(data.articles)} You are a content generator for API documentation. Your task is to generate the content that follows the format below, starting with: --- title: "The name of the action" description: "A brief description of what the action does" --- Focus strictly on structure and documentation. **Do not wrap the content inside \`\`\`mdx \`\`\`**. Always structure content as: - Introduction / use cases / explanatory videos (don't add a title 'Introduction' just add directly the content) - Inputs (use Input fields) - Parameters (user Parameters) - Output fields (use Output fields) - Specificities (include only if there's new value-added content) Replace: - 'task(s)' in the context of automating with 'action' - 'task(s)' in the context of consumption/usage with 'credit(s)' There's no need to specify phrases like 'To use this setting with the API' since it's implied that it will be used via API. Avoid repetition. For example, if you list the inputs in bullet points, do not repeat the input format in JSON. Use these **Mintlify components** (don't overuse them): 1. For 'Input Fields' and 'Parameters' (e.g., 'max_results', 'excludeViewedLeads') use **ParamField**: An example parameter field Properties: - 'type': Expected type of the parameter's value - 'required': Boolean indicating if the parameter is required - 'deprecated': Boolean indicating if the parameter is deprecated - 'default': Default value if no value is provided - 'initialValue': Initial value for the playground - 'placeholder': Placeholder text for the input - 'children': Description of the parameter (markdown enabled) **Do not** add an extra title like '### Maximum number of results'; the ParamField component itself is enough. 2. For 'Output Fields', use the 'ResponseField' component inside the 'Expandable' component. Key Rule: Always use one main ResponseField with one Expandable component. Inside the Expandable, add individual ResponseField components for each field. **DO NOT** list each ResponseField individually. Sort the fields in ascending order by name. For example: The LinkedIn company URL The industry of the company The number of followers on LinkedIn The affiliate status of the company Also add an 'Accordion' with the JSON - Map the array to a JSON object with keys. Example: \`\`\`json {{Output Fields}} \`\`\` Separate the two section by a brief sentence introducting the JSON schema. 3. To describe the automation setup you can use for step-by-step processes description: Example: Instructions for the first step. Instructions for the second step. 4. **Tooltip**: Use Hover over me for additional content like technical definitions. 5. **Highlight content** whenever possible if something is important and worth highlighting: - This adds a note in the content - This raises a warning - This highlights important information - This suggests a helpful tip - This indicates a successful or completed action 6. **Embedding Iframes**: For embedded content like YouTube or Loom videos: **Always**: When you see iframe links containing 'https://app.guideflow.com/embed/', extract the link and use it as: **ONLY** do that if you detect links containing 'https://app.guideflow.com/embed/'. Example: Replace: With: Add a brief description to introduce each video or iframe. **Do not** use 'Videos' as a title—incorporate the video within the context. 7. **Code component**: For displaying code snippets in various languages (e.g., JSON, JavaScript). Example: \`\`\`json { 'key': 'abc', 'other_key': 123 } \`\`\` The generated content should be clear, technical, and organized, without unnecessary context or explanations—just the content. `; // Change to use the chat-based completions API (v1/chat/completions) const response = await openaiClient.chat.completions.create({ model: "gpt-4o", // Use the latest GPT-4 model messages: [ { role: "system", content: "You are an assistant that formats API documentation.", }, { role: "user", content: prompt, }, ], temperature: 0, // Adjust temperature based on your preference }); return response.choices[0].message.content.trim(); } export { sendToOpenAI };

Changelog