TURAXIA

API reference

OpenAPI 3.1 — rendered natively.
No iframe, no script tag.

The same typed contract your SDK, CLI, and MCP tools share. Download the raw spec or browse every endpoint below.

Download OpenAPI (JSON)Quickstart

Server

Base URL.

Module execution endpoints use Authorization: Bearer $TURAXIA_KEY. Keys are issued through Connect and scoped per workspace.

Public discovery endpoints such as /v1/modules and /v1/quickstarts stay readable without a key so developers can inspect the live surface before onboarding.

  • https://api.turaxia.com — Production

Endpoints

Every path, every method.

/parse/v1/parse
POSTParse a supplier URL into a typed product record through the Connect-hosted ingress.Parse
Request body
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "sourceUrl"
        ],
        "properties": {
          "sourceUrl": {
            "type": "string",
            "format": "uri"
          },
          "rawHtml": {
            "type": "string"
          }
        }
      }
    }
  }
}
Responses
{
  "200": {
    "description": "Typed product record.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ProductRecord"
        }
      }
    }
  }
}
/localize/v1/localize
POSTTranslate a typed product record into a target locale.Localize
Request body
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "productId",
          "to"
        ],
        "properties": {
          "productId": {
            "type": "string"
          },
          "to": {
            "type": "string",
            "examples": [
              "ru",
              "en",
              "ja"
            ]
          },
          "glossary": {
            "type": "string"
          }
        }
      }
    }
  }
}
Responses
{
  "200": {
    "description": "Localized record."
  }
}
/price/v1/quote
POSTLanded-cost quote.Price
Request body
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "productId",
          "destinationCountry"
        ],
        "properties": {
          "productId": {
            "type": "string"
          },
          "destinationCountry": {
            "type": "string",
            "examples": [
              "KZ"
            ]
          },
          "destinationCurrency": {
            "type": "string"
          },
          "asOf": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    }
  }
}
Responses
{
  "200": {
    "description": "Price quote.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/PriceQuote"
        }
      }
    }
  }
}
/route/v1/resolve
POSTResolve an optimal carrier and package plan.Route
Request body
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "productId",
          "destinationCountry"
        ],
        "properties": {
          "productId": {
            "type": "string"
          },
          "destinationCountry": {
            "type": "string"
          }
        }
      }
    }
  }
}
Responses
{
  "200": {
    "description": "Route + package plan."
  }
}
/v1/modules
GETList the currently exposed modules and their public surfaces.Connect
Responses
{
  "200": {
    "description": "Module catalog and public surface metadata."
  }
}
/v1/quickstarts
GETList the onboarding quickstarts published by Connect.Connect
Responses
{
  "200": {
    "description": "Quickstart metadata for public onboarding surfaces."
  }
}

Scoping

Keys are workspace-scoped.

Every API key is scoped to a single workspace via Connect. Requests carry the workspace scope; mismatched scope returns 403. The workspace-isolation card in /proof documents this behavior end-to-end.

Schemas

Core shared types.

ConfidenceSignal
{
  "type": "object",
  "required": [
    "field",
    "confidence",
    "source"
  ],
  "properties": {
    "field": {
      "type": "string"
    },
    "confidence": {
      "type": "number",
      "minimum": 0,
      "maximum": 1
    },
    "source": {
      "type": "string"
    }
  }
}
ProductRecord
{
  "type": "object",
  "required": [
    "productId"
  ],
  "properties": {
    "productId": {
      "type": "string"
    },
    "title": {
      "type": [
        "string",
        "null"
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "pricing": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "currency": {
          "type": "string"
        },
        "amount": {
          "type": "number"
        }
      }
    },
    "variants": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "confidenceSignals": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConfidenceSignal"
      }
    }
  }
}
PriceQuote
{
  "type": "object",
  "required": [
    "productId",
    "destinationCurrency",
    "amount",
    "breakdown"
  ],
  "properties": {
    "productId": {
      "type": "string"
    },
    "destinationCurrency": {
      "type": "string"
    },
    "amount": {
      "type": "number"
    },
    "breakdown": {
      "type": "object"
    },
    "rules": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}