Documentation

POST /api/fix

Submit a store URL for repair.

RequestPOST /api/fix
AuthenticationNo authentication
Handlerbackend/fixtool.py

What it does

The entry point to Fix, the standalone tool. It takes a URL and returns a token and the page to watch. Fix requires no account: the token is the identity, and `POST /api/fix/adopt` attaches a completed run to an account afterwards.

Authentication

No authentication. The response does not depend on a session.

Parameters

ParameterInTypeRequiredDescription
urlbodystringRequiredThe store to examine.

Request

The cookie jar carries the session between calls. Angle-bracketed values are the parameter types from the table above.

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{"url":"<string>"}' \
  "https://flowfinds.ai/api/fix"
const res = await fetch("https://flowfinds.ai/api/fix", {
  method: "POST",
  credentials: "include",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "url": "<string>"
  }),
});
const data = await res.json();
import requests

s = requests.Session()
r = s.post("https://flowfinds.ai/api/fix", json={
    "url": "<string>"
  })
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  -X POST -H 'Content-Type: application/json' \
  -d '{"url":"https://example.com"}' \
  "$FLOWFINDS_ORIGIN/api/fix"

Responses

200The run started.

FieldTypeDescription
tokenstringThe run identity.
urlstring`/fix/<token>` — the page that shows progress.

200The URL was rejected.

FieldTypeDescription
errorstringWhat was wrong with it.

Errors

This endpoint has no failure path of its own. An uncaught exception anywhere in the engine is still returned as structured JSON by the shared guard.

Related

Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.