Operational API Reference

API Reference

Everything you need to integrate DoesItClick into your own marketing stack. Use our RESTful endpoints to automate simulations and extract persona intelligence.

Base URLs

Browser runtime: same-origin `/api/...`

Direct API host: `https://api.doesitclick.ai/api/v1`

Chat v2 host: `https://api.doesitclick.ai/api/v2`

POST

/simulations

Initializes a new message test against selected personas. This is an asynchronous operation. You should poll the GET endpoint or use Webhooks to receive completion events.

Body Parameters

projectIduuidRequired

Target project for the simulation.

namestringRequired

Internal label for this run.

copySnapshotobjectRequired

The marketing content to test.

personaIdsstring[]Required

One or more personas to include in the run.

scenariosstring[]

`landing_page`, `pricing_page`, or `email_sequence`.

modestring

`fast` or `robust` depending on the level of signal you need.

goalstring

Examples: `trial`, `demo`, `purchase`, `newsletter`, `brand_awareness`.

Request Example

{
  "projectId": "uuid",
  "name": "Landing Test A",
  "copySnapshot": {
    "landingPage": {
      "headline": "Stop drop-off before your trial CTA",
      "subheadline": "See which objections block intent before launch.",
      "bodyCopy": "DoesItClick helps teams test message clarity, trust, and objection patterns with synthetic personas.",
      "cta": "Start trial"
    }
  },
  "personaIds": ["uuid"],
  "scenarios": ["landing_page"],
  "mode": "fast",
  "goal": "trial",
  "source": "api"
}

Response (201)

{
  "simulation": {
    "id": "sim_98213",
    "status": "pending",
    "createdAt": "2026-02-10T..."
  }
}

Scope of this page

This page is intentionally a practical starter reference. Use it to understand the live contract shape, then validate the exact endpoint behavior in staging before automating production workflows.