DocsGetting StartedQuick Start

Quick Start Guide

Get up and running with InkFleet quickly.

Prerequisites

  • A InkFleet account — contact us to get set up
  • Node.js 18+ (for API integration)
  • npm or yarn package manager

Step 1: Create Your First Project

After signing up, you'll be taken to your dashboard. Click New Project to create your first content project. You can also create a project via the API:

project-config.json
json
// Project configuration
{
  "name": "My First Blog",
  "type": "blog",
  "language": "en",
  "seo": {
    "autoOptimize": true,
    "targetScore": 90,
    "schemaMarkup": true
  },
  "ai": {
    "model": "inkfleet-v1",
    "tone": "professional"
  }
}

Step 2: Generate Your First Article

Navigate to AI Writer and enter your topic. InkFleet will generate a complete, SEO-optimized article in seconds. You can also call the REST API directly:

generate-article.ts
typescript
// No published SDK yet -- call the REST API directly
const response = await fetch('https://inkfleet.com/api/v1/articles/generate', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer your_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    topic: 'Best practices for cloud-native development',
    length: 'long',
    seoOptimize: true,
    keywords: ['cloud-native', 'kubernetes', 'microservices'],
  }),
});

const { article } = await response.json();
console.log('Article generated:', article.title);
console.log('SEO Score:', article.seoScore);

Step 3: Optimize for SEO

Your article is automatically analyzed for SEO. Check the SEO panel on the right side of the editor for real-time scoring and actionable suggestions. InkFleet evaluates:

  • Keyword density and placement across headings, body, and meta
  • Readability score (Flesch-Kincaid, Gunning Fog)
  • Internal and external link structure
  • Schema markup generation and validation
  • Meta title and description optimization

Tip: Aim for an SEO score above 85 before publishing. InkFleet will highlight exactly what to improve and can auto-fix most issues with a single click.

Step 4: Publish

Once your article is ready, use the REST API to pull it into your own publishing workflow.

Native one-click publishing integrations (WordPress, Shopify, and more) are on our roadmap — contact us if you'd like to be notified when they launch.

API Quick Start

Prefer working with the REST API directly? Here's how to generate an article with a single cURL command:

terminal
bash
# Generate an article via the REST API
curl -X POST https://inkfleet.com/api/v1/articles/generate \
  -H "Authorization: Bearer gho_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "topic": "Getting started with serverless",
    "length": "medium",
    "seoOptimize": true
  }'

Or using the JavaScript fetch API:

api-example.js
javascript
const response = await fetch('https://inkfleet.com/api/v1/articles/generate', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer gho_your_api_key',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    topic: 'Getting started with serverless',
    length: 'medium',
    seoOptimize: true,
  }),
});

const article = await response.json();
console.log(article);

Next Steps

Was this helpful?

Last updated: March 2024