API v1 Quickstart

Here are the main endpoints of the SEOFuxx API v1, plus a few examples so you can start testing quickly.

Basics

  • Base URL: https://www.seofuxx.com/api/v1
  • The specification is the openapi.yaml in the project
  • Many endpoints expect application/x-www-form-urlencoded

The main endpoints

  • POST /account: master data and profile actions
  • POST /password: update the password
  • POST /domains-projekte: save domain, keywords and auto crawl
  • POST /filemerger: analyze or merge CSS/JS
  • POST /favicon: generate favicons from an upload
  • POST /favicon/ai-image: generate an AI image
  • POST /favicon/from-ai: generate favicons from an AI image
  • GET /ai-visibility: read AI Visibility figures (with an API key)
  • POST /api-keys: create, list and revoke API keys

Example: analyze with the File Merger

curl -X POST "https://www.seofuxx.com/api/v1/filemerger" \
  -d "action=analyze" \
  -d "domain=https://example.com"

Example: merge with the File Merger

curl -X POST "https://www.seofuxx.com/api/v1/filemerger" \
  -d "action=merge" \
  -d "domain=https://example.com" \
  -d "jsfiles[]=/assets/js/app.js" \
  -d "cssfiles[]=/assets/css/app.css" \
  -d "shrink=1"

Authentication

Most endpoints depend on an active session, so you need to be logged in. That applies to account, password, domains-projekte and filemerger, for example. The examples above therefore only work with the cookie of a signed-in session.

For automated requests there are API keys. You create them in your account on the API keys tab. The key is shown in plain text only once, so copy it right away. If you lose it or suspect misuse, you revoke it there again. With the key you send the header Authorization: Bearer sfx_..., for example to GET /ai-visibility (see AI Visibility Tracking) and to the MCP endpoint.

Error codes

  • 400: invalid or missing parameters
  • 401: not logged in
  • 403: access not allowed
  • 429: limit reached, for example for analyses without an account
  • 500: internal error

The full field list and the response schemas are in the openapi.yaml, its the best place to look for details.

Czy ta treść jest pomocna?

·