API Reference
API Reference
The DeskForge API allows you to programmatically manage your desktop app projects, trigger builds, and retrieve artifacts.
Base URL
https://api.deskforge.appFor local development: http://localhost:3001/api
Authentication
All API requests require authentication using an API key.
Getting an API Key
- Log in to your DeskForge Dashboard
- Navigate to Settings → Access Tokens
- Click Generate New Token
- Copy and securely store your token
Using Your API Key
Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEYExample Request:
curl -H "Authorization: Bearer df_1234567890abcdef" \
https://api.deskforge.app/buildsRate Limits
Free Plan
100
requests/hour
Pro Plan
1,000
requests/hour
Team Plan
10,000
requests/hour
Endpoints Overview
Quick Example
Node.js
const axios = require('axios');
const client = axios.create({
baseURL: 'https://api.deskforge.app',
headers: {
'Authorization': `Bearer ${process.env.DESKFORGE_API_KEY}`
}
});
// List projects
const projects = await client.get('/projects');
console.log(projects.data);
// Trigger build
const build = await client.post('/projects/proj_abc123/builds', {
platform: 'mac',
arch: 'arm64'
});
console.log('Build ID:', build.data.id);