Delete a review

DELETE

/v1/reviews/{id}

curl --request DELETE \
  --url https://api.proofql.dev/v1/reviews/2f1c9e5a-3b7d-4c1e-9f0a-6d2b8e4a1c3f \
  --header 'Authorization: Bearer <token>'

• Production.
• Local `wrangler dev` (see infra/environments.md).

Removes the review and its excerpts and purges the project’s query cache. Not idempotent at the HTTP level: a second call is a 404.

Authorizations

• secretKey

Parameters

Path Parameters

id

required

string format: uuid

The review’s id. A value that is not a UUID is a 404.

Example

2f1c9e5a-3b7d-4c1e-9f0a-6d2b8e4a1c3f

Responses

204

Deleted. No body.

Headers

x-request-id

required

string

>= 1 characters <= 128 characters

This request’s id, on every response. Reuses the caller’s x-request-id when sent (up to 128 chars), else Cloudflare’s ray id, else a fresh UUID. Also inside every error envelope.

RateLimit-Policy

required

string

/^[0-9]+;w=[0-9]+$/

The key’s rate-limit policy as <limit>;w=<window seconds> (IETF draft ratelimit headers), e.g. 300;w=60 for a secret key, 120;w=60 for a publishable key. Present once the key is known.

RateLimit-Limit

required

integer

>= 1

The request limit per window for this key’s kind.

401

unauthorized: no Authorization header (and no ?key= where that is allowed), a header that is not Bearer <key>, a key that does not look like pq_(sk|pk)_(live|test)_…, a secret key in the URL, a ?key= on POST /v1/query, or an unknown or revoked key. Rate-limit headers are absent (the key was not resolved).

Media typeapplication/json

object

error

required

object

code

required

Stable error codes. Status by code: unauthorized 401, forbidden 403, not_found 404, payload_too_large 413, unsupported_media_type 415, validation_failed 422, review_limit_reached 422, rate_limited 429, query_quota_exceeded 429, internal 500, embedding_unavailable 503, service_unavailable 503.

string

Allowed values: unauthorized forbidden validation_failed review_limit_reached not_found payload_too_large unsupported_media_type rate_limited embedding_unavailable query_quota_exceeded service_unavailable internal

message

required

For humans; may change between releases. Switch on code.

string

doc_url

required

https://docs.proofql.dev/errors#<code>.

string format: uri

request_id

required

Same value as the x-request-id header.

string

details

Present for validation_failed only.

Array<object>

object

path

required

Dotted path to the offending field ("0.rating", "filters.since"); "" or "(body)" for the whole body.

string

message

required

string

error

required

object

code

Allowed value: unauthorized

Examples

Examplemissing

{
  "error": {
    "code": "unauthorized",
    "message": "Missing Authorization header. Send `Authorization: Bearer <api key>`.",
    "doc_url": "https://docs.proofql.dev/errors#unauthorized",
    "request_id": "1b7c3d9e-2f4a-4b6c-8d0e-1f2a3b4c5d6e"
  }
}

Headers

x-request-id

required

string

>= 1 characters <= 128 characters

This request’s id, on every response. Reuses the caller’s x-request-id when sent (up to 128 chars), else Cloudflare’s ray id, else a fresh UUID. Also inside every error envelope.

403

forbidden: a publishable key (pq_pk_…) on a route that requires a secret key. Decided before the key is looked up, so rate-limit headers are absent.

Media typeapplication/json

object

error

required

object

code

required

Stable error codes. Status by code: unauthorized 401, forbidden 403, not_found 404, payload_too_large 413, unsupported_media_type 415, validation_failed 422, review_limit_reached 422, rate_limited 429, query_quota_exceeded 429, internal 500, embedding_unavailable 503, service_unavailable 503.

string

Allowed values: unauthorized forbidden validation_failed review_limit_reached not_found payload_too_large unsupported_media_type rate_limited embedding_unavailable query_quota_exceeded service_unavailable internal

message

required

For humans; may change between releases. Switch on code.

string

doc_url

required

https://docs.proofql.dev/errors#<code>.

string format: uri

request_id

required

Same value as the x-request-id header.

string

details

Present for validation_failed only.

Array<object>

object

path

required

Dotted path to the offending field ("0.rating", "filters.since"); "" or "(body)" for the whole body.

string

message

required

string

error

required

object

code

Allowed value: forbidden

Example

{
  "error": {
    "code": "forbidden"
  }
}

Headers

x-request-id

required

string

>= 1 characters <= 128 characters

This request’s id, on every response. Reuses the caller’s x-request-id when sent (up to 128 chars), else Cloudflare’s ray id, else a fresh UUID. Also inside every error envelope.

404

not_found: no review with this id in the key’s project and environment (another project’s or environment’s review looks the same as a nonexistent one), or an id that is not a UUID.

Media typeapplication/json

object

error

required

object

code

required

Stable error codes. Status by code: unauthorized 401, forbidden 403, not_found 404, payload_too_large 413, unsupported_media_type 415, validation_failed 422, review_limit_reached 422, rate_limited 429, query_quota_exceeded 429, internal 500, embedding_unavailable 503, service_unavailable 503.

string

Allowed values: unauthorized forbidden validation_failed review_limit_reached not_found payload_too_large unsupported_media_type rate_limited embedding_unavailable query_quota_exceeded service_unavailable internal

message

required

For humans; may change between releases. Switch on code.

string

doc_url

required

https://docs.proofql.dev/errors#<code>.

string format: uri

request_id

required

Same value as the x-request-id header.

string

details

Present for validation_failed only.

Array<object>

object

path

required

Dotted path to the offending field ("0.rating", "filters.since"); "" or "(body)" for the whole body.

string

message

required

string

error

required

object

code

Allowed value: not_found

Example

{
  "error": {
    "code": "not_found"
  }
}

Headers

x-request-id

required

string

>= 1 characters <= 128 characters

This request’s id, on every response. Reuses the caller’s x-request-id when sent (up to 128 chars), else Cloudflare’s ray id, else a fresh UUID. Also inside every error envelope.

RateLimit-Policy

required

string

/^[0-9]+;w=[0-9]+$/

The key’s rate-limit policy as <limit>;w=<window seconds> (IETF draft ratelimit headers), e.g. 300;w=60 for a secret key, 120;w=60 for a publishable key. Present once the key is known.

RateLimit-Limit

required

integer

>= 1

The request limit per window for this key’s kind.

429

rate_limited: over this key’s per-minute limit. Wait Retry-After seconds.

Media typeapplication/json

object

error

required

object

code

required

Stable error codes. Status by code: unauthorized 401, forbidden 403, not_found 404, payload_too_large 413, unsupported_media_type 415, validation_failed 422, review_limit_reached 422, rate_limited 429, query_quota_exceeded 429, internal 500, embedding_unavailable 503, service_unavailable 503.

string

Allowed values: unauthorized forbidden validation_failed review_limit_reached not_found payload_too_large unsupported_media_type rate_limited embedding_unavailable query_quota_exceeded service_unavailable internal

message

required

For humans; may change between releases. Switch on code.

string

doc_url

required

https://docs.proofql.dev/errors#<code>.

string format: uri

request_id

required

Same value as the x-request-id header.

string

details

Present for validation_failed only.

Array<object>

object

path

required

Dotted path to the offending field ("0.rating", "filters.since"); "" or "(body)" for the whole body.

string

message

required

string

error

required

object

code

Allowed value: rate_limited

Example

{
  "error": {
    "code": "rate_limited"
  }
}

Headers

x-request-id

required

string

>= 1 characters <= 128 characters

This request’s id, on every response. Reuses the caller’s x-request-id when sent (up to 128 chars), else Cloudflare’s ray id, else a fresh UUID. Also inside every error envelope.

RateLimit-Policy

required

string

/^[0-9]+;w=[0-9]+$/

The key’s rate-limit policy as <limit>;w=<window seconds> (IETF draft ratelimit headers), e.g. 300;w=60 for a secret key, 120;w=60 for a publishable key. Present once the key is known.

RateLimit-Limit

required

integer

>= 1

The request limit per window for this key’s kind.

Retry-After

required

integer

>= 1

Whole seconds to wait. For rate_limited, until the current window ends; for query_quota_exceeded, until the next UTC month begins.

500

internal: something unexpected. The message carries the request id and nothing about the cause.

Media typeapplication/json

object

error

required

object

code

required

Stable error codes. Status by code: unauthorized 401, forbidden 403, not_found 404, payload_too_large 413, unsupported_media_type 415, validation_failed 422, review_limit_reached 422, rate_limited 429, query_quota_exceeded 429, internal 500, embedding_unavailable 503, service_unavailable 503.

string

Allowed values: unauthorized forbidden validation_failed review_limit_reached not_found payload_too_large unsupported_media_type rate_limited embedding_unavailable query_quota_exceeded service_unavailable internal

message

required

For humans; may change between releases. Switch on code.

string

doc_url

required

https://docs.proofql.dev/errors#<code>.

string format: uri

request_id

required

Same value as the x-request-id header.

string

details

Present for validation_failed only.

Array<object>

object

path

required

Dotted path to the offending field ("0.rating", "filters.since"); "" or "(body)" for the whole body.

string

message

required

string

error

required

object

code

Allowed value: internal

Example

{
  "error": {
    "code": "internal"
  }
}

Headers

x-request-id

required

string

>= 1 characters <= 128 characters

This request’s id, on every response. Reuses the caller’s x-request-id when sent (up to 128 chars), else Cloudflare’s ray id, else a fresh UUID. Also inside every error envelope.

503

service_unavailable: the database refused or timed out a connection (a connection storm, a paused compute; Retry-After: 1), or a daily platform allowance is spent (Retry-After is the seconds until it renews, at most a day). Nothing about the request was wrong; retry after Retry-After seconds. The message carries the request id and nothing about the cause.

Media typeapplication/json

object

error

required

object

code

required

Stable error codes. Status by code: unauthorized 401, forbidden 403, not_found 404, payload_too_large 413, unsupported_media_type 415, validation_failed 422, review_limit_reached 422, rate_limited 429, query_quota_exceeded 429, internal 500, embedding_unavailable 503, service_unavailable 503.

string

Allowed values: unauthorized forbidden validation_failed review_limit_reached not_found payload_too_large unsupported_media_type rate_limited embedding_unavailable query_quota_exceeded service_unavailable internal

message

required

For humans; may change between releases. Switch on code.

string

doc_url

required

https://docs.proofql.dev/errors#<code>.

string format: uri

request_id

required

Same value as the x-request-id header.

string

details

Present for validation_failed only.

Array<object>

object

path

required

Dotted path to the offending field ("0.rating", "filters.since"); "" or "(body)" for the whole body.

string

message

required

string

error

required

object

code

Allowed value: service_unavailable

Example

{
  "error": {
    "code": "service_unavailable"
  }
}

Headers

x-request-id

required

string

>= 1 characters <= 128 characters

This request’s id, on every response. Reuses the caller’s x-request-id when sent (up to 128 chars), else Cloudflare’s ray id, else a fresh UUID. Also inside every error envelope.

Retry-After

required

integer

>= 1

Whole seconds to wait. For rate_limited, until the current window ends; for query_quota_exceeded, until the next UTC month begins.