Quickstart

Installation

Using the Dashboard

The easiest way to get started is through our web dashboard:

1. Sign up at rankvectors.com
2. Create a new project
3. Get your API key from settings
4. Start syncing content!

Using the API

If you prefer to use the API directly, you'll need an API key:

curl -X POST https://api.rankvectors.com/api/projects \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Website",
    "domain": "https://example.com"
  }'

Create Your First Project

With JavaScript SDK

import { RankVectors } from '@rankvectors/rankvectors-javascript'

const client = new RankVectors({
  apiKey: 'YOUR_API_KEY'
})

const project = await client.projects.create({
  name: 'My Website',
  domain: 'https://example.com',
  preferredSdk: 'javascript'
})

console.log('Project created:', project.id)

With Python SDK

from rankvectors import RankVectors

client = RankVectors(api_key="YOUR_API_KEY")

project = client.projects.create(
    name="My Website",
    domain="https://example.com",
    preferred_sdk="python"
)

print(f"Project created: {project.id}")

Sync Your Content

After creating a project, sync your pages:

// Sync a single page
await client.pages.sync(project.id, {
  url: 'https://example.com/about',
  content: 'Your page content here...',
  title: 'About Us',
  statusCode: 200
})

// Or sync multiple pages at once
await client.pages.batchSync(project.id, [
  {
    url: 'https://example.com/page1',
    content: 'Content 1...',
    title: 'Page 1'
  },
  {
    url: 'https://example.com/page2',
    content: 'Content 2...',
    title: 'Page 2'
  }
])

Generate Link Suggestions

Once your pages are synced, generate link suggestions:

const suggestions = await client.suggestions.generate(project.id, {
  sourcePageUrl: 'https://example.com/about',
  limit: 10
})

console.log('Found', suggestions.length, 'link opportunities')

Implement Links

Review and implement suggestions:

// Get a specific suggestion
const suggestion = await client.suggestions.get(project.id, suggestionId)

// Mark as implemented
await client.suggestions.update(project.id, suggestionId, {
  status: 'implemented'
})

Next Steps

• Read the Sync Content Guide to learn more about syncing
• Check out SDK Documentation for your language
• Explore Integrations for CMS setups