AI Personalization

Generate AI hooks for many leads (async batch)

Changed on

Creates an async job. The create call is not charged; each successful lead is charged when the job processes it. The whole batch must be affordable or the call returns 402. Poll pollUrl (GET /v1/jobs/{id}) for results.

post/v1/ai/hook/batch

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

Response

Success

successboolean

Example response

{
  "data": {
    "status": "pending",
    "pollUrl": "/v1/jobs/4b2e1f9a-2c3d-4e5f-8a9b-0c1d2e3f4a5b",
    "estimatedCost": {
      "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

    • 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 batchGenerateAiHooks 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 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 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

      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