SEO GPT by Writesonic

SEO GPT by Writesonic · GPT アクション

SEO Score Checker API

API for checking the SEO score of an article.

  • POST /feature/fa-seo-dataGenerates SEO Data from keyword and country code

    Generates SEO data including content structure and keywords based on user input. Call this endpoint before checking the seo score

  • POST /feature/fa-seo-score-checkerCheck SEO Score

    Checks the SEO score based on user input.

  • POST /feature/fa-seo-score-checker-from-article-urlCheck SEO Score from Article URL

    Checks the SEO score based on user input including article URL.

  • POST /feature/fa-seo-keywordsGet keyword research data

    Generate Competitor and Long-tail SEO Keywords

  • POST /feature/fa-technical-seo-analysisGet technical seo analysis

    Generates the technical seo analysis based on user input.

元の API スキーマ
{
  "openapi": "3.0.0",
  "info": {
    "title": "SEO Score Checker API",
    "version": "1.0.0",
    "description": "API for checking the SEO score of an article."
  },
  "servers": [
    {
      "url": "https://tools.writesonic.com/api"
    }
  ],
  "paths": {
    "/feature/fa-seo-data": {
      "post": {
        "summary": "Generates SEO Data from keyword and country code",
        "description": "Generates SEO data including content structure and keywords based on user input. Call this endpoint before checking the seo score",
        "operationId": "generateSeoData",
        "requestBody": {
          "description": "Input data to generate SEO data",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "user_input": {
                    "type": "object",
                    "properties": {
                      "keyword": {
                        "type": "string",
                        "example": "seo for digital marketing"
                      },
                      "country_code": {
                        "type": "string",
                        "example": "us"
                      }
                    },
                    "required": [
                      "keyword",
                      "country_code"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "keyword": {
                      "type": "string"
                    },
                    "country_code": {
                      "type": "string"
                    },
                    "overall_content_structure": {
                      "type": "object",
                      "properties": {
                        "word_count": {
                          "type": "object",
                          "properties": {
                            "min": {
                              "type": "integer"
                            },
                            "max": {
                              "type": "integer"
                            }
                          }
                        },
                        "heading_count": {
                          "type": "object",
                          "properties": {
                            "min": {
                              "type": "integer"
                            },
                            "max": {
                              "type": "integer"
                            }
                          }
                        },
                        "paragraph_count": {
                          "type": "object",
                          "properties": {
                            "min": {
                              "type": "integer"
                            },
                            "max": {
                              "type": "integer"
                            }
                          }
                        },
                        "image_count": {
                          "type": "object",
                          "properties": {
                            "min": {
                              "type": "integer"
                            },
                            "max": {
                              "type": "integer"
                            }
                          }
                        }
                      }
                    },
                    "overall_keywords": {
                      "type": "object",
                      "properties": {
                        "autocomplete_keywords": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "keyword": {
                                "type": "string"
                              },
                              "expected_range_min": {
                                "type": "integer"
                              },
                              "expected_range_max": {
                                "type": "integer"
                              },
                              "competition": {
                                "type": "number"
                              },
                              "volume": {
                                "type": "integer"
                              }
                            }
                          }
                        },
                        "competitor_keywords": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "keyword": {
                                "type": "string"
                              },
                              "expected_range_min": {
                                "type": "integer"
                              },
                              "expected_range_max": {
                                "type": "integer"
                              },
                              "competition": {
                                "type": "number"
                              },
                              "volume": {
                                "type": "integer"
                              }
                            }
                          }
                        },
                        "ai_keywords": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "keyword": {
                                "type": "string"
                              },
                              "expected_range_min": {
                                "type": "integer"
                              },
                              "expected_range_max": {
                                "type": "integer"
                              },
                              "competition": {
                                "type": "number"
                              },
                              "volume": {
                                "type": "integer"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/feature/fa-seo-score-checker": {
      "post": {
        "summary": "Check SEO Score",
        "description": "Checks the SEO score based on user input.",
        "operationId": "checkSeoScore",
        "requestBody": {
          "description": "Input data to check SEO score",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "user_input": {
                    "type": "object",
                    "properties": {
                      "keyword": {
                        "type": "string",
                        "example": "seo for digital marketing"
                      },
                      "country_code": {
                        "type": "string",
                        "example": "us"
                      },
                      "word_count": {
                        "type": "integer",
                        "example": 10
                      },
                      "heading_count": {
                        "type": "integer",
                        "example": 15
                      },
                      "paragraph_count": {
                        "type": "integer",
                        "example": 20
                      },
                      "image_count": {
                        "type": "integer",
                        "example": 0
                      },
                      "article_data": {
                        "type": "string",
                        "example": "ai marketing"
                      }
                    },
                    "required": [
                      "keyword",
                      "country_code",
                      "word_count",
                      "heading_count",
                      "paragraph_count",
                      "image_count",
                      "article_data"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "score": {
                      "type": "integer"
                    },
                    "custom_link": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/feature/fa-seo-score-checker-from-article-url": {
      "post": {
        "summary": "Check SEO Score from Article URL",
        "description": "Checks the SEO score based on user input including article URL.",
        "operationId": "checkSeoScoreFromArticleUrl",
        "requestBody": {
          "description": "Input data to check SEO score from article URL",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "user_input": {
                    "type": "object",
                    "properties": {
                      "keyword": {
                        "type": "string",
                        "example": "notion ai vs chatgpt"
                      },
                      "country_code": {
                        "type": "string",
                        "example": "us"
                      },
                      "article_url": {
                        "type": "string",
                        "example": "https://writesonic.com/blog/notion-ai-vs-chatgpt"
                      }
                    },
                    "required": [
                      "keyword",
                      "country_code",
                      "article_url"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "score": {
                      "type": "integer"
                    },
                    "custom_link": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/feature/fa-seo-keywords": {
      "post": {
        "summary": "Get keyword research data",
        "description": "Generate Competitor and Long-tail SEO Keywords",
        "operationId": "generateSeoKeywords",
        "requestBody": {
          "description": "Input data to generate SEO keywords",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "user_input": {
                    "type": "object",
                    "properties": {
                      "keyword": {
                        "type": "string",
                        "example": "seo in digital marketing"
                      },
                      "country_code": {
                        "type": "string",
                        "example": "us"
                      }
                    },
                    "required": [
                      "keyword",
                      "country_code"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "keyword": {
                      "type": "string"
                    },
                    "country_code": {
                      "type": "string"
                    },
                    "competitor_keywords": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "long_tail_keywords": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/feature/fa-technical-seo-analysis": {
      "post": {
        "summary": "Get technical seo analysis",
        "description": "Generates the technical seo analysis based on user input.",
        "operationId": "getTechnicalSeoAnalysis",
        "requestBody": {
          "description": "Input URL to generate technical seo analysis for",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "user_input": {
                    "type": "string",
                    "example": "https://tldrthis.com"
                  }
                },
                "required": [
                  "user_input"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "is_meta_tags_present": {
                      "type": "boolean"
                    },
                    "is_single_h1_tag_present": {
                      "type": "boolean"
                    },
                    "is_broken_link_present": {
                      "type": "boolean"
                    },
                    "is_image_without_alt_present": {
                      "type": "boolean"
                    },
                    "is_structured_data_present": {
                      "type": "boolean"
                    },
                    "is_semantic_html_present": {
                      "type": "boolean"
                    },
                    "is_duplicate_content_present": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}