Skip to content
Main site Contact

API reference

Use this section when the generated schema is not enough on its own. The pages below call out the legacy request formats, URL-encoding rules, auth requirements, and response quirks that are easy to miss if you only look at controller signatures.

  • Many request bodies are not JSON objects or JSON arrays. They are JSON strings whose contents are base64 data or even a JSON array encoded as a string.
  • filterStr is a nested query string. URL-encode the whole filterStr value. If the FT= value itself contains = or &, encode the inner FT value first, then encode the whole filterStr.
  • Search responses may return /api/Image URLs that include a short-lived token query parameter. That token is not your bearer token. Send it back exactly as returned.
  • Several older XML comments are stale. These docs follow the current controller behavior where they differ.

Use the embedded Swagger view for quick schema browsing and then use the written pages for the details that matter during real integrations.