Quickstart

Prerequisite: You’ll need an account on Morph to obtain an API key.

Follow these steps to integrate Morph into your application:

Step 1: Get Your API Key

The first step is to obtain an API key from the Morph dashboard:

Go to https://morphllm.com/dashboard
Create an account or sign in to your existing account
Create a new API key or use the existing one

Keep this API key secure as it will be used for authentication in your API requests.

Step 2: Use the Morph API

Morph provides an OpenAI-compatible API for applying model-suggested changes to your code files:

Morph API Documentation

View our OpenAI-compatible API

Base URL

https://api.morphllm.com/v1

Compatible with OpenAI SDK

Morph’s API is compatible with the OpenAI SDK. You only need to change the base URL and API key:

import OpenAI from 'openai';

// Initialize the OpenAI client with Morph's API endpoint
const openai = new OpenAI({
  apiKey: 'your-morph-api-key',
  baseURL: 'https://api.morphllm.com/v1'
});

async function applyChanges(originalCode: string, updatedCode: string): Promise<string> {
  const response = await openai.chat.completions.create({
    model: "morph-v2",
    messages: [
      {
        role: "user",
        content: `<code>${originalCode}</code>\n<update>${updatedCode}</update>`
      }
    ]
  });
  
  return response.choices[0].message.content;
}

// Example usage
const original = `function add(a: number, b: number): number {
  return a + b;
}`;

const edits = `function add(a: number, b: number): number {
  // Add validation
  if (isNaN(a) || isNaN(b)) {
    throw new Error('Both arguments must be valid numbers');
  }
  return a + b;
}`;

applyChanges(original, edits)
  .then(result => console.log(result))
  .catch(error => console.error('Error:', error));

Step 3: Build Your Edit File Tool

Create a powerful edit_file tool for your AI agent using Morph’s apply model:

edit_file Tool Implementation

Here’s a comprehensive implementation of an edit_file tool for your AI agent:

edit-file-tool.ts
import { promises as fs } from 'fs';
import OpenAI from 'openai';

// Initialize the OpenAI client with Morph's API endpoint
const openai = new OpenAI({
  apiKey: process.env.MORPH_API_KEY || 'your-morph-api-key',
  baseURL: 'https://api.morphllm.com/v1'
});


// Function to edit files using the Morph apply model
// @param params - Parameters for the edit
// @returns Result of the edit operation

async function editFile(params: {
  target_file: string;
  code_edit: string;
}): Promise<{ success: boolean; message: string; error?: any }> {
  try {
    // 1. Read the original file
    const originalContent = await fs.readFile(params.target_file, 'utf8');
    
    // 2. Send to Morph API
    const response = await openai.chat.completions.create({
      model: 'morph-v2',
      messages: [
        {
          role: 'user',
          content: `<code>${originalContent}</code>\n<update>${params.code_edit}</update>`
        }
      ]
    });
    
    // 3. Write the updated content back to the file
    await fs.writeFile(params.target_file, response.choices[0].message.content);
    
    return {
      success: true,
      message: `File ${params.target_file} was successfully updated`
    };
  } catch (error) {
    return {
      success: false,
      message: `Error: ${error.message}`,
      error
    };
  }
}

Tool Definition for AI Agent:

{
  "name": "edit_file",
  "description": "Use this tool to propose an edit to an existing file.\n\nThis will be read by the Morph apply model, which will quickly apply the edit. You should make it clear what the edit is, while also minimizing the unchanged code you write.\nWhen writing the edit, you should specify each edit in sequence, with the special comment // ... existing code ... to represent unchanged code between edited lines.",
  "parameters": {
    "properties": {
      "target_file": {
        "type": "string",
        "description": "The target file to modify."
      },
      "code_edit": {
        "type": "string",
        "description": "Specify ONLY the precise lines of code that you wish to edit. Use // ... existing code ... for unchanged sections."
      }
    },
    "required": ["target_file", "code_edit"]
  }
}

Input Format:

The Morph API expects two key components:

Original code wrapped in <code>...</code> tags
Update snippet wrapped in <update>...</update> tags

The update snippet should use truncation markers like // ... existing code ... to indicate unchanged parts of the code.

Example edit pattern:

// Original code:
function calculateTotal(items) {
  total = 0;
  for item in items:
    total += item.price;
  return total;
}

// Edit with markers:
function calculateTotal(items) {
  // ... existing code ...
  for item in items:
    total += item.price;
  return total * 1.1;  // Add 10% tax
}

Best practices:

Use special comments (Strongly Recommended: // ... existing code ...) to indicate unchanged sections
Provide sufficient context around edits for proper placement
Keep instructions concise and action-oriented
Minimize token usage by not repeating large unchanged sections

Enhancing Your Agent Capabilities

Morph’s apply model offers significant advantages over traditional LLMs for code editing:

Speed: Process edits at 2000+ tokens per second
Accuracy: Precise application of changes with context awareness
Cost-effective: Lower token usage compared to generating entire files
Format preservation: Maintains code structure and formatting

For access to our latest models, self-hosting, or business inquiries, please contact us at info@morphllm.com.

Troubleshooting

API Authorization Error

Apply Model Errors

Getting Started

Models

Guides

Endpoints

Step 1: Get Your API Key

Step 2: Use the Morph API

Morph API Documentation

Base URL

Compatible with OpenAI SDK

Step 3: Build Your Edit File Tool

Enhancing Your Agent Capabilities

Troubleshooting

Getting Started

Models

Guides

Endpoints

​Step 1: Get Your API Key

​Step 2: Use the Morph API

Morph API Documentation

​Base URL

​Compatible with OpenAI SDK

​Step 3: Build Your Edit File Tool

​Enhancing Your Agent Capabilities

​Troubleshooting

Step 1: Get Your API Key

Step 2: Use the Morph API

Base URL

Compatible with OpenAI SDK

Step 3: Build Your Edit File Tool

Enhancing Your Agent Capabilities

Troubleshooting