@agentseo/sdk

@agentseo/sdk

Official JavaScript SDK for AgentSEO.

Install

npm install @agentseo/sdk

Quick Start

import { AgentSEO } from "@agentseo/sdk";

const client = new AgentSEO({
  apiKey: process.env.AGENTSEO_API_KEY!,
  baseUrl: "https://api.agentseo.dev"
});

const result = await client.localAudit(
  { domain: "example.com", location: "New York, NY" },
  { sync: true }
);

console.log(result);

Async Jobs

By default, requests are queued (sync: false) and return a job object.

const job = await client.contentGap({
  url: "https://example.com/blog/post",
  keyword: "best project management software"
});

const result = await client.getJob(job.id);

Error Handling

import { AgentSEO, AgentSEOError } from "@agentseo/sdk";

try {
  await client.search({ query: "agentic seo tools" }, { sync: true });
} catch (error) {
  if (error instanceof AgentSEOError) {
    console.error(error.status, error.message, error.details);
  }
}

API Surface

• localAudit(input, options?)
• contentGap(input, options?)
• search(input, options?)
• analyzeSerp(input, options?)
• aiOverviewExtract(input, options?)
• localVisibilityTrack(input, options?)
• llmMentionsTrack(input, options?)
• contentDecayDetect(input, options?)
• keywordClusterBuild(input, options?)
• getJob(jobId)

Request Options

• sync?: boolean Run inline and return final result when true.
• idempotencyKey?: string Prevent duplicate job creation on retries.