Create Run Replica

This endpoint creates a replica of a specific run, allowing you to provide variables to customize the output.

Request

POST /api/v1/runs/{runId}/replica

Path Parameters

Name	Type	Description
`runId`	`integer`	Required The ID of the run to replicate.

Body Parameters

Name	Type	Description
`variables`	`object`	Required A key-value map of variables to be used in the replica generation.

Example Body:

{
  "variables": {
    "name": "John Doe",
    "company": "Acme Inc."
  }
}

Responses

200: Success

A successful request returns a JSON object with the details of the newly created replica.

{
  "replica": {
    "id": 123,
    "screenshotUrl": "https://your-screenshot-url.com/screenshot.png",
    "customScreenshotUrls": {
      "custom.domain.com": "https://custom.domain.com/screenshot.png"
    },
    "status": "✅",
    "errorDetails": null
  }
}

Name	Type	Description
`id`	`integer`	The unique identifier for the replica.
`screenshotUrl`	`string`	The URL to the screenshot of the generated replica.
`customScreenshotUrls`	`object`	A map of custom domains to their corresponding screenshot URLs.
`status`	`string`	The status of the replica generation. Can be `✅` for success or `❌` for an error.
`errorDetails`	`string`	(Optional) If the status is `❌`, this field will contain details about the error that occurred.

400: Bad Request

This error is returned if the runId is invalid or the request body does not match the required schema.

{
  "error": "Invalid run ID"
}

404: Not Found

This error is returned if the specified runId does not exist.

{
  "error": "Run not found"
}

500: Internal Server Error

This error is returned if there is a problem creating or generating the replica.

{
  "error": "Failed to create replica"
}

​Create Run Replica

​Request

​Path Parameters

​Body Parameters

​Responses

​200: Success

​400: Bad Request

​404: Not Found

​500: Internal Server Error