AI Personalization

Generate an AI hook for one lead (synchronous)

Changed on

Charged per fresh success. Cache hits and generation failures are not charged. The lead must belong to the caller; an unknown or foreign lead returns 404.

post/v1/ai/hook

Request

Headers

Idempotency-Keystring

Optional. Repeating a key with the same body within 24 hours replays the first response (marked X-Idempotent-Replayed: true) without a second charge. The same key with a different body returns 409.

Request body

leadIdstring uuid required
localestring
mode'native' | 'translate'

Response

Success

successboolean

Example response

{
  "data": {
    "hook": "Curious how you weigh page-speed against the content depth your blog is clearly built around?",
    "cost": {
      "credits": 1,
      "pence": 1
    }
  }
}

Changes

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from boolean to no type for status

    • breaking

      the response's property type changed from boolean to no type for status

    • breaking

      the response's property type changed from boolean to no type for status

    • breaking

      the response's property type changed from boolean to no type for status

    • breaking

      the response's property type changed from boolean to no type for status

    • breaking

      the response's property type changed from boolean to no type for status

    • breaking

      the response's property type changed from boolean to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id generateAiHook was added

    • info

      the endpoint scheme security apiKeyAuth was removed from the API

    • info

      the endpoint scheme security bearerAuth was removed from the API

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

    • info

      the response property const value false was added for the status

    • info

      the response's property default value false was removed for the status

    • info

      the response's property default value false was removed for the status

    • info

      the response's property default value false was removed for the status

    • info

      the response's property default value false was removed for the status

    • info

      the response's property default value false was removed for the status

    • info

      the response's property default value false was removed for the status

    • info

      the response's property default value false was removed for the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status