Skip to main content
POST
/
experiments
/
api
/
{uid}
/
start
Start experiment
curl --request POST \
  --url https://api.pictify.io/experiments/api/{uid}/start \
  --header 'Authorization: Bearer <token>'
{
  "experiment": {
    "uid": "exp_abc123",
    "slug": "homepage-hero-test",
    "name": "Homepage Hero A/B Test",
    "variants": [
      {
        "id": "variant-a",
        "weight": 5000,
        "name": "New Design",
        "templateUid": "<string>",
        "variables": {},
        "isDefault": false,
        "conditions": {
          "children": "<array>",
          "property": "<string>",
          "value": "<unknown>"
        },
        "schedule": {
          "startAt": "2023-11-07T05:31:56Z",
          "endAt": "2023-11-07T05:31:56Z",
          "recurrence": {
            "type": "none",
            "cronExpression": "<string>",
            "timezone": "America/New_York"
          }
        },
        "impressions": 123,
        "clicks": 123
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "templateUid": "tmpl_xyz789",
    "goalConfig": {
      "type": "impressions_only",
      "destinationUrl": "<string>"
    },
    "banditConfig": {
      "enabled": false,
      "algorithm": "thompson_sampling",
      "warmupImpressions": 50,
      "recomputeIntervalMinutes": 15
    },
    "hypothesis": "<string>",
    "minimumSampleSize": 1000,
    "confidenceThreshold": 0.95,
    "minimumRunDays": 7,
    "winnerVariantId": "<string>",
    "winnerDeclaredAt": "2023-11-07T05:31:56Z",
    "fallbackImageUrl": "<string>",
    "outputConfig": {
      "format": "png",
      "quality": 90
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.pictify.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key obtained from the Pictify dashboard

Path Parameters

uid
string
required

Response

Experiment started

experiment
object