Cancel Website Generation

Cancel an in-progress website generation for the specified project ID.

This endpoint:

1. Finds any in-progress generations for the project
2. Updates their status to FAILED with a cancellation message
3. Returns details about the cancelled generation

Args: project_id: The project ID of the generation to cancel

Returns: Details of the cancelled generation

POST /codenull/ai/api/v1/cancel-website/{project_id}

Cancel Website Generation

cURL

curl --request POST \
  --url https://api.example.com/codenull/ai/api/v1/cancel-website/{project_id}

import requests

url = "https://api.example.com/codenull/ai/api/v1/cancel-website/{project_id}"

response = requests.post(url)

print(response.text)

const options = {method: 'POST'};

fetch('https://api.example.com/codenull/ai/api/v1/cancel-website/{project_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/codenull/ai/api/v1/cancel-website/{project_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/codenull/ai/api/v1/cancel-website/{project_id}"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/codenull/ai/api/v1/cancel-website/{project_id}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/codenull/ai/api/v1/cancel-website/{project_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

200

{
  "generation_id": "<string>",
  "project_id": "<string>",
  "message": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

project_id · string · required

Response

200

application/json

Successful Response

generation_id · string · required

Generation ID of the cancelled generation

project_id · string · required

Project ID as UUID

status · enum<string> · required

Updated status (should be FAILED)

Available options: PENDING, GENERATING_PLAN, GENERATING_WEBSITE, COMPLETED, FAILED

previous_status · enum<string> · required

Status before cancellation

Available options: PENDING, GENERATING_PLAN, GENERATING_WEBSITE, COMPLETED, FAILED

message · string · required

Cancellation message

updated_at · string<date-time> · required

Timestamp when the generation was cancelled