Supported Data Types

Supported Data Types

The API typically returns data structures conforming to the following TypeScript interfaces. Note that date fields are usually represented as ISO 8601 strings in JSON responses. Object IDs from the database are also represented as strings.

Blog Object

Represents a single blog post retrieved or created via the API.

interface Blog {
  _id: string;
  slug: string;
  title: string;
  introduction: string;
  mainBlog: string;
  conclusion: string;
  callToAction: string;
  author: string; // User ID
  createdAt: Date;
  blogParams: BlogParams; // Reference to the parameters used for generation
}

interface BlogParams {
  topicKeywords: string[];
  language: Language;
  callToAction: CallToAction;
  targetAudience: TargetAudience;
  hyperlinks: string[];
  toneStyle: ToneStyle;
  contentStructure: ContentStructure;
  baseUrlForLinkedBlog?: string;
  metaData?: Record<string, any>;
  externalOpenAiApiKey?: string;
}