Insights

Generate or fetch the compatibility report between two chatroom members.

post/v1/get_soulmate_report

Request

  • Base URL: https://partner.mindupload.app
  • URL: https://partner.mindupload.app/v1/get_soulmate_report
  • Auth: API key in header X-Partner-Key

Request body

preferred_languagestring nullable

BCP-47-ish language code (e.g. 'en', 'zh-cn') for localized messages.

usernamestring nullable

The end-user's username.

passwordstring nullable

The end-user's password on first sign-in. After login/register, send the returned session token (JWT) here instead — the field accepts either, and reusing the token keeps raw passwords out of your storage.

my_clone_idstring nullable
other_clone_idstring nullable
chatroom_idstring nullable

Chatroom id as returned by chatroom operations.

expected_credit_coststring nullable

Credit amount displayed before the action, as an exact decimal string. The action is refused if a new charge would use a different amount. Omit for older clients; cached reports remain free.

Response

Result envelope — check the success field.

successboolean

Whether the call succeeded.

error_messagestring nullable

Human-readable reason when success is false.

error_codestring
reportobject nullable
report_generated_atinteger nullable
is_generatingboolean nullable
chargedboolean nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.