Cancel a Dream

curl --request POST \
  --url https://api.checkfu.com/v1/dreams/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/dreams/{id}/cancel"

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/dreams/{id}/cancel', 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.checkfu.com/v1/dreams/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/dreams/{id}/cancel"

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	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.checkfu.com/v1/dreams/{id}/cancel")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/dreams/{id}/cancel")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "memory_store": "<string>",
  "session_ids": [
    "<string>"
  ],
  "instructions": "<string>",
  "model_routing_profile_key": "<string>",
  "review": true,
  "status": "pending",
  "output_memory_store": "<string>",
  "proposal": "<string>",
  "curation_run": "<string>",
  "error": "input_memory_store_unavailable",
  "usage": {
    "input_tokens": 1,
    "cached_input_tokens": 1,
    "cache_write_input_tokens": 1,
    "output_tokens": 1,
    "reasoning_output_tokens": 1,
    "total_tokens": 1
  },
  "created_at": "<string>",
  "ended_at": "<string>",
  "archived_at": "<string>",
  "version": 1
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "runtime.invalid_transition",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-invalid-transition"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Cancel a Dream

Cancel a pending or running Dream. Canceling an already-canceled dream is an idempotent no-op, while a completed or failed dream answers runtime.invalid_transition. Cancellation is terminal and cannot be undone — create a new dream to curate the same sessions again. Send Idempotency-Key for safe retries.

Checkfu support posture: preview; rollout_fenced. Required evidence journey: dreams. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.

POST

dreams

{id}

cancel

Cancel a Dream

curl --request POST \
  --url https://api.checkfu.com/v1/dreams/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'checkfu-version: <checkfu-version>'

import requests

url = "https://api.checkfu.com/v1/dreams/{id}/cancel"

headers = {
    "checkfu-version": "<checkfu-version>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'checkfu-version': '<checkfu-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.checkfu.com/v1/dreams/{id}/cancel', 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.checkfu.com/v1/dreams/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "checkfu-version: <checkfu-version>"
  ],
]);

$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.checkfu.com/v1/dreams/{id}/cancel"

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

	req.Header.Add("checkfu-version", "<checkfu-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	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.checkfu.com/v1/dreams/{id}/cancel")
  .header("checkfu-version", "<checkfu-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checkfu.com/v1/dreams/{id}/cancel")

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

request = Net::HTTP::Post.new(url)
request["checkfu-version"] = '<checkfu-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "memory_store": "<string>",
  "session_ids": [
    "<string>"
  ],
  "instructions": "<string>",
  "model_routing_profile_key": "<string>",
  "review": true,
  "status": "pending",
  "output_memory_store": "<string>",
  "proposal": "<string>",
  "curation_run": "<string>",
  "error": "input_memory_store_unavailable",
  "usage": {
    "input_tokens": 1,
    "cached_input_tokens": 1,
    "cache_write_input_tokens": 1,
    "output_tokens": 1,
    "reasoning_output_tokens": 1,
    "total_tokens": 1
  },
  "created_at": "<string>",
  "ended_at": "<string>",
  "archived_at": "<string>",
  "version": 1
}

{
  "error": {
    "type": "validation.malformed",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-malformed"
  }
}

{
  "error": {
    "type": "auth.invalid_key",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-invalid-key"
  }
}

{
  "error": {
    "type": "auth.disabled_tenancy",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#auth-disabled-tenancy"
  }
}

{
  "error": {
    "type": "validation.not_found",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#validation-not-found"
  }
}

{
  "error": {
    "type": "runtime.invalid_transition",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-invalid-transition"
  }
}

{
  "error": {
    "type": "budget.exceeded",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#budget-exceeded"
  }
}

{
  "error": {
    "type": "runtime.internal",
    "message": "<string>",
    "more": "https://docs.checkfu.com/reference/errors#runtime-internal"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version

enum<string>

required

Available options:

2026-08-24

idempotency-key

string

Maximum string length: 255

Path Parameters

string

required

Pattern: ^drm_[0-9a-f]{32}$

Response

an error exactly on failure, an end time exactly on terminal status, and a completed dream always names its output store

string

required

Pattern: ^drm_[0-9a-f]{32}$

memory_store

string

required

Pattern: ^memstore_[0-9a-f]{32}$

session_ids

string[]

required

Required array length: 1 - 100 elements

Pattern: ^sess_[0-9a-f]{32}$

instructions

string | null

required

Required string length: 1 - 4096

model_routing_profile_key

string | null

required

Pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$

review

boolean

required

status

enum<string>

required

Available options:

pending,

running,

completed,

failed,

canceled

output_memory_store

string | null

required

Pattern: ^memstore_[0-9a-f]{32}$

proposal

string | null

required

Pattern: ^mprop_[0-9a-f]{32}$

curation_run

string | null

required

Pattern: ^mcur_[0-9a-f]{32}$

error

enum<string> | null

required

Available options:

input_memory_store_unavailable,

input_session_unavailable,

input_sessions_too_large,

curation_failed,

internal

usage

object

required

Show child attributes

created_at

string

required

ended_at

string | null

required

archived_at

string | null

required

version

integer

required

Required range: x > 0

Developer tools

Canonical tables

Author protocols

Generated HTTP API

Cancel a Dream

Authorizations

Headers

Path Parameters

Response