Reviews

Get product review

Returns one product review and its public replies.

GEThttps://api.cevoid.com/v2/product-reviews/{review_id}

Request

curl 'https://api.cevoid.com/v2/product-reviews/rev_abc123' \
  -H "Authorization: Bearer ${CEVOID_API_KEY}"

fetch("https://api.cevoid.com/v2/product-reviews/rev_abc123", {
  headers: {
    Authorization: `Bearer ${process.env.CEVOID_API_KEY}`,
  },
})
  .then((response) => response.json())
  .then((data) => console.log(data))

const response = await fetch("https://api.cevoid.com/v2/product-reviews/rev_abc123", {
  headers: {
    Authorization: `Bearer ${process.env.CEVOID_API_KEY}`,
  },
})
if (!response.ok) throw new Error(`Request failed: ${response.status}`)
const data = await response.json()
console.log(data)

import os

import requests

response = requests.get(
    "https://api.cevoid.com/v2/product-reviews/rev_abc123",
    headers={
        "Authorization": f"Bearer {os.environ['CEVOID_API_KEY']}",
    },
)
response.raise_for_status()
print(response.json())

<?php

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.cevoid.com/v2/product-reviews/rev_abc123',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('CEVOID_API_KEY'),
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

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

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://api.cevoid.com/v2/product-reviews/rev_abc123", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer " + os.Getenv("CEVOID_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}

require "net/http"

uri = URI("https://api.cevoid.com/v2/product-reviews/rev_abc123")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("CEVOID_API_KEY")}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.body

Response

{
  "data": {
    "rating": 5,
    "title": "Bekväm passform varje dag",
    "body": "Bekväm och normal i storleken.",
    "language": "en",
    "purchase_verification": "UNVERIFIED",
    "is_incentivized": false,
    "is_insider": false,
    "channel": "IMPORT",
    "submitted_at": "2026-09-01T10:00:00.000Z",
    "media": [],
    "answers": [],
    "responses": [],
    "id": "rev_abc123",
    "status": "PENDING",
    "rejection_reasons": [],
    "identity_verification": "CONFIRMED",
    "profile_id": "prf_abc123",
    "helpful_up_count": 0,
    "helpful_down_count": 0,
    "created_at": "2026-09-01T10:00:00.000Z",
    "updated_at": "2026-09-01T10:00:00.000Z",
    "product_id": "prd_abc123",
    "variant_id": "var_abc123"
  },
  "included": {
    "localization": {
      "product_reviews": [
        {
          "id": "rev_abc123",
          "has_translations": true,
          "original": {
            "title": "Comfortable everyday fit",
            "body": "Comfortable and true to size."
          }
        }
      ],
      "review_responses": [],
      "review_media": [],
      "questions": []
    }
  }
}

Show all 44 linesShow fewer lines

{
  "additional_data": {
    "errors": [
      {
        "field": "query.market",
        "message": "Invalid input: expected string, received array"
      }
    ]
  },
  "status": 400,
  "code": "bad_request",
  "message": "Bad request",
  "request_id": "req_abc123"
}

{
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "request_id": "req_abc123"
}

{
  "status": 403,
  "code": "forbidden",
  "message": "Forbidden",
  "request_id": "req_abc123"
}

{
  "additional_data": {
    "errors": [
      {
        "field": "query.market",
        "message": "Invalid input: expected string, received array"
      }
    ]
  },
  "status": 404,
  "code": "not_found",
  "message": "Route not found",
  "request_id": "req_abc123"
}

{
  "status": 409,
  "code": "conflict",
  "message": "Conflict",
  "request_id": "req_abc123"
}

{
  "additional_data": {
    "errors": [
      {
        "field": "query.market",
        "message": "Invalid input: expected string, received array"
      }
    ]
  },
  "status": 422,
  "code": "validation_error",
  "message": "Validation error",
  "request_id": "req_abc123"
}

{
  "status": 429,
  "code": "too_many_requests",
  "message": "Too many requests",
  "request_id": "req_abc123"
}

{
  "status": 500,
  "code": "internal_server_error",
  "message": "Internal server error",
  "request_id": "req_abc123"
}

Authorizations

Authorizationbearer tokenheaderrequired

Send Authorization: Bearer <key>, where the key is your API key.

Path parameters

review_idstringrequired

Opaque Cevoid identifier.

Length: 1 to 200
Example: rev_abc123

Query parameters

marketstring

Presentation market. Defaults to the workspace default; does not filter collection origin.

Length: 1 to 200
Example: mar_abc123

includestring

Comma-separated includes: products, questions, localization. Products requires products:read. Question originals require questions and localization together.

Maximum length: 100
Example: products,questions,localization

viewenum<string>Default: private

Private includes retained moderation states and operational references. Public applies shopper visibility, masking, and reviewer privacy.

Allowed values: private public
Example: private

Response

200 Successful response application/json

dataobjectrequired

Option 1: object

idstringrequired

Cevoid public product review identifier.

Example: rev_abc123

ratingintegerrequired

Score from 1 to 5.

Range: 1 <= x <= 5
Example: 5

titlestring

Reviewer-supplied headline. In localized responses, title and body both use source text unless a complete translation is available.

Example: Comfortable everyday fit

bodystring

Reviewer-supplied text. Absent for star-only reviews. In localized responses, title and body both use source text unless a complete translation is available.

Example: Comfortable and true to size.

languagestringrequired

BCP-47 language of the original submission, even when the returned text is translated.

Example: en

statusenum<string>required

Moderation and conversion state.

Allowed values: PENDING PUBLISHED REJECTED CONVERTED
Example: PUBLISHED

rejection_reasonsenum<string>[]required

Policy reasons recorded when moderation rejected the review. Empty unless status is REJECTED; a single take-down can carry several.

Allowed values: SPAM FAKE DUPLICATE OFF_TOPIC PROFANE ILLEGAL PII

identity_verificationenum<string>required

Author verification state. Public display requires CONFIRMED.

Allowed values: PENDING CONFIRMED EXPIRED
Example: CONFIRMED

purchase_verificationenum<string>required

Purchase evidence state behind verified-buyer display.

Allowed values: VERIFIED UNVERIFIED
Example: UNVERIFIED

is_incentivizedbooleanrequired

Whether a reward influenced submission.

Example: false

is_insiderbooleanrequired

Whether the reviewer is brand-connected.

Example: false

channelenum<string>required

How the review entered Cevoid.

Allowed values: REQUEST WIDGET LINK IMPORT SYNDICATED_IN
Example: IMPORT

sourceobject

External provenance. Present for imported or syndicated reviews.

Properties (3)

platformstringrequired

Source-system slug, such as okendo or yotpo.

Example: yotpo

external_idstring

Review identifier in the source system.

Example: review_123

urlstring

Link to the review in its source system.

Example: https://example.com/reviews/123

profile_idstring | nullrequired

Reviewer reference; null when the profile no longer resolves.

Length: 1 to 200
Example: prf_abc123

market_idstring

Cevoid public market identifier.

Example: mar_abc123

order_idstring

Cevoid public identifier of the matched order.

Example: ord_abc123

reward_idstring

Granted reward, when the review was incentivized.

Example: rwd_abc123

converted_from_idstring

Review this one was converted from.

Example: rev_original

converted_to_idstring

Replacement review created by conversion.

Example: crv_replacement

mediaobject[]required

Item properties (12)

typeenum<string>required

Whether the item is an image or a video.

Allowed values: IMAGE VIDEO
Example: IMAGE

urlstringrequired

Delivery URL for the full asset.

Example: https://example.com/reviews/123

thumbnail_urlstringrequired

Delivery URL for the thumbnail.

Example: https://example.com/reviews/123

aspect_rationumberrequired

Width divided by height.

Example: 1.5

aspect_ratio_typeenum<string>required

Coarse orientation bucket.

Allowed values: LANDSCAPE PORTRAIT SQUARE
Example: LANDSCAPE

video_lengthnumber

Video duration in seconds.

Example: 12

moderation_statusenum<string>

Moderation state for this asset, independent from the review itself.

Allowed values: PENDING APPROVED DECLINED
Example: APPROVED

idstringrequired

Stable opaque asset identity shared by detail and preview.

Example: rmed_abc123

altstring

Available image alternative text, localized with source fallback.

Example: Blue shirt worn outdoors

thumbnail_altstring

Available video poster alternative text.

Example: Blue shirt video preview

video_descriptionstring

Available description of video imagery.

Example: A shopper shows the fit of a blue shirt.

video_captionsstring

Available WebVTT captions with cue timing, localized with source fallback.

Example: WEBVTT 00:00.000 --> 00:01.000 The fit is comfortable.

responsesobject[]required

Item properties (5)

bodystringrequired

Reply text as published.

Example: Comfortable and true to size.

author_typeenum<string>required

Whether the workspace or a named team member authored the reply.

Allowed values: WORKSPACE TEAM_MEMBER
Example: WORKSPACE

created_atstring<date-time>required

ISO 8601 timestamp when the reply was created.

Example: 2026-09-01T10:00:00.000Z

updated_atstring<date-time>

ISO 8601 timestamp when the reply was last edited.

Example: 2026-09-01T10:00:00.000Z

idstringrequired

Opaque Cevoid identifier.

Length: 1 to 200
Example: rev_abc123

helpful_up_countnumberrequired

Positive helpful votes from shoppers.

Example: 3

helpful_down_countnumberrequired

Negative helpful votes, when down-voting is enabled.

Example: 0

submitted_atstring<date-time>

ISO 8601 timestamp when submission completed.

Example: 2026-09-01T10:00:00.000Z

approved_atstring<date-time>

ISO 8601 timestamp when moderation approved it.

Example: 2026-09-01T10:00:00.000Z

published_atstring<date-time>

ISO 8601 timestamp when it first became public.

Example: 2026-09-01T10:00:00.000Z

created_atstring<date-time>required

ISO 8601 timestamp when Cevoid created the review.

Example: 2026-09-01T10:00:00.000Z

updated_atstring<date-time>required

ISO 8601 timestamp when Cevoid last updated the review.

Example: 2026-09-01T10:00:00.000Z

answersobject[]required

Item properties (2)

question_idstringrequired

Opaque Cevoid identifier.

Length: 1 to 200
Example: rvq_abc123

valuenumber | string | boolean | string[]required

Original submitted value; selection keys are never translated.

Example: 4

pinned_atstring<date-time>

ISO 8601 timestamp when pinned to its product.

Example: 2026-09-01T10:00:00.000Z

edited_atstring<date-time>

Last reviewer edit; unrelated processing does not change this timestamp.

Example: 2026-09-01T10:00:00.000Z

product_idstring | nullrequired

Opaque Cevoid identifier.

Length: 1 to 200
Example: prd_abc123

variant_idstring | nullrequired

Opaque Cevoid identifier.

Length: 1 to 200
Example: var_abc123

Option 2: object

idstringrequired

Opaque Cevoid identifier.

Length: 1 to 200
Example: rev_abc123

ratingintegerrequired

Score from 1 to 5.

Range: 1 <= x <= 5
Example: 5

titlestring

Reviewer-supplied headline. In localized responses, title and body both use source text unless a complete translation is available.

Example: Comfortable everyday fit

bodystring

Reviewer-supplied text. Absent for star-only reviews. In localized responses, title and body both use source text unless a complete translation is available.

Example: Comfortable and true to size.

languagestringrequired

BCP-47 language of the original submission, even when the returned text is translated.

Example: en

purchase_verificationenum<string>required

Purchase evidence state behind verified-buyer display.

Allowed values: VERIFIED UNVERIFIED
Example: UNVERIFIED

is_incentivizedbooleanrequired

Whether a reward influenced submission.

Example: false

is_insiderbooleanrequired

Whether the reviewer is brand-connected.

Example: false

channelenum<string>required

How the review entered Cevoid.

Allowed values: REQUEST WIDGET LINK IMPORT SYNDICATED_IN
Example: IMPORT

submitted_atstring<date-time>

ISO 8601 timestamp when submission completed.

Example: 2026-09-01T10:00:00.000Z

published_atstring<date-time>

ISO 8601 timestamp when it first became public.

Example: 2026-09-01T10:00:00.000Z

edited_atstring<date-time>

Last reviewer edit; unrelated processing does not change this timestamp.

Example: 2026-09-01T10:00:00.000Z

reviewerobjectrequired

Properties (2)

display_namestringrequired

Example: Jane S

avatar_urlstring

Example: https://example.com/reviews/123

mediaobject[]required

Item properties (11)

typeenum<string>required

Whether the item is an image or a video.

Allowed values: IMAGE VIDEO
Example: IMAGE

urlstringrequired

Delivery URL for the full asset.

Example: https://example.com/reviews/123

thumbnail_urlstringrequired

Delivery URL for the thumbnail.

Example: https://example.com/reviews/123

aspect_rationumberrequired

Width divided by height.

Example: 1.5

aspect_ratio_typeenum<string>required

Coarse orientation bucket.

Allowed values: LANDSCAPE PORTRAIT SQUARE
Example: LANDSCAPE

video_lengthnumber

Video duration in seconds.

Example: 12

idstringrequired

Stable opaque asset identity shared by detail and preview.

Example: rmed_abc123

altstring

Available image alternative text, localized with source fallback.

Example: Blue shirt worn outdoors

thumbnail_altstring

Available video poster alternative text.

Example: Blue shirt video preview

video_descriptionstring

Available description of video imagery.

Example: A shopper shows the fit of a blue shirt.

video_captionsstring

Available WebVTT captions with cue timing, localized with source fallback.

Example: WEBVTT 00:00.000 --> 00:01.000 The fit is comfortable.

responsesobject[]required

Item properties (5)

idstringrequired

Opaque Cevoid identifier.

Length: 1 to 200
Example: rrsp_abc123

bodystringrequired

Example: Comfortable and true to size.

created_atstring<date-time>required

Example: 2026-09-01T10:00:00.000Z

updated_atstring<date-time>

Example: 2026-09-01T10:00:00.000Z

authorobjectrequired

Properties (1)

display_namestringrequired

Example: Jane S

helpfulobject

Properties (2)

up_countnumberrequired

Example: 3

down_countnumber

Example: 0

is_pinnedbooleanrequired

Example: false

product_idstring | nullrequired

Opaque Cevoid identifier.

Length: 1 to 200
Example: prd_abc123

variant_idstring | nullrequired

Opaque Cevoid identifier.

Length: 1 to 200
Example: var_abc123

answersobject[]required

Item properties (2)

question_idstringrequired

Opaque Cevoid identifier.

Length: 1 to 200
Example: rvq_abc123

valuenumber | string | boolean | string[]required

Original submitted value; selection keys are never translated.

Example: 4

includedobject

Properties (3)

localizationobject

Properties (4)

product_reviewsobject[]

Item properties (3)

idstringrequired

Public ID matching the returned entity or nested item.

Length: 1 to 200
Example: rev_abc123

has_translationsbooleanrequired

True when the returned translatable content differs from its source representation. Does not mean every field was translated.

Example: true

originalobject | nullrequired

Complete source projection of translatable fields, with the same visibility and masking rules. Null when no returned content differs. Not edit history.

Properties (2)

titlestring

Reviewer-supplied headline. In localized responses, title and body both use source text unless a complete translation is available.

Example: Comfortable everyday fit

bodystring

Reviewer-supplied text. Absent for star-only reviews. In localized responses, title and body both use source text unless a complete translation is available.

Example: Comfortable and true to size.

review_responsesobject[]

Item properties (3)

idstringrequired

Public ID matching the returned entity or nested item.

Length: 1 to 200
Example: rev_abc123

has_translationsbooleanrequired

True when the returned translatable content differs from its source representation. Does not mean every field was translated.

Example: true

originalobject | nullrequired

Complete source projection of translatable fields, with the same visibility and masking rules. Null when no returned content differs. Not edit history.

Properties (1)

bodystringrequired

Reply text as published.

Example: Comfortable and true to size.

review_mediaobject[]

Item properties (3)

idstringrequired

Public ID matching the returned entity or nested item.

Length: 1 to 200
Example: rev_abc123

has_translationsbooleanrequired

True when the returned translatable content differs from its source representation. Does not mean every field was translated.

Example: true

originalobject | nullrequired

Complete source projection of translatable fields, with the same visibility and masking rules. Null when no returned content differs. Not edit history.

Properties (4)

altstring

Available image alternative text, localized with source fallback.

Example: Blue shirt worn outdoors

thumbnail_altstring

Available video poster alternative text.

Example: Blue shirt video preview

video_descriptionstring

Available description of video imagery.

Example: A shopper shows the fit of a blue shirt.

video_captionsstring

Available WebVTT captions with cue timing, localized with source fallback.

Example: WEBVTT 00:00.000 --> 00:01.000 The fit is comfortable.

questionsobject[]

Item properties (3)

idstringrequired

Public ID matching the returned entity or nested item.

Length: 1 to 200
Example: rev_abc123

has_translationsbooleanrequired

True when the returned translatable content differs from its source representation. Does not mean every field was translated.

Example: true

originalobject | nullrequired

Complete source projection of translatable fields, with the same visibility and masking rules. Null when no returned content differs. Not edit history.

Properties (3)

promptstringrequired

Example: How does it fit?

optionsobject[]

Current selection options. Labels are localized; values remain stable selection keys.

Item properties (2)

valuestringrequired

Example: blue

labelstringrequired

Example: Blue

scaleobject

Properties (4)

start_labelstringrequired

Example: Too small

end_labelstringrequired

Example: Too large

center_labelstring

Example: Just right

step_labelsstring[]

productsobject[]

Option 1: object

market_idstringrequired

Cevoid market ID for this product presentation.

Example: mar_sweden

external_idstring

Product identifier from the connected commerce platform.

Example: shopify_product_123

titlestring

Market-specific product title.

Example: Merino crew neck

variant_titlestring

Market-specific variant option label.

Example: Navy / M

skustring

Market-specific stock keeping unit.

Example: MERINO-NAVY-M

urlstring<uri>

Storefront URL for the selected market presentation.

Example: https://shop.example/products/merino-crew

image_urlstring<uri>

Primary image for the selected market presentation.

Example: https://cdn.cevoid.com/products/merino-crew/0.jpg

availabilityenum<string>

Availability for the selected market presentation.

Allowed values: IN_STOCK OUT_OF_STOCK
Example: IN_STOCK

idstringrequired

Cevoid product or variant ID.

Example: prd_abc123def456gh

typeenum<string>required

Product family.

Allowed value: PRODUCT
Example: PRODUCT

priceobject

Market-specific Product price range.

Properties (3)

currencystringrequired

ISO 4217 currency code.

Example: SEK

min_amountnumberrequired

Lowest Variant price.

Range: 0 <= x
Example: 799

max_amountnumberrequired

Highest Variant price.

Range: 0 <= x
Example: 999

Option 2: object

market_idstringrequired

Cevoid market ID for this product presentation.

Example: mar_sweden

external_idstring

Product identifier from the connected commerce platform.

Example: shopify_product_123

titlestring

Market-specific product title.

Example: Merino crew neck

variant_titlestring

Market-specific variant option label.

Example: Navy / M

skustring

Market-specific stock keeping unit.

Example: MERINO-NAVY-M

urlstring<uri>

Storefront URL for the selected market presentation.

Example: https://shop.example/products/merino-crew

image_urlstring<uri>

Primary image for the selected market presentation.

Example: https://cdn.cevoid.com/products/merino-crew/0.jpg

availabilityenum<string>

Availability for the selected market presentation.

Allowed values: IN_STOCK OUT_OF_STOCK
Example: IN_STOCK

idstringrequired

Cevoid product or variant ID.

Example: prd_abc123def456gh

typeenum<string>required

Purchasable Product variant.

Allowed value: VARIANT
Example: VARIANT

parent_product_idstringrequired

Cevoid product ID. Present when type is VARIANT.

Example: prd_abc123def456gh

priceobject

Market-specific Variant price.

Properties (3)

currencystringrequired

ISO 4217 currency code.

Example: SEK

amountnumberrequired

Current Variant price.

Range: 0 <= x
Example: 899

sale_amountnumber

Sale price when active.

Range: 0 <= x
Example: 799

questionsobject[]

Item properties (9)

idstringrequired

Opaque Cevoid identifier.

Length: 1 to 200
Example: rev_abc123

scopeenum<string>required

Allowed values: PRODUCT COMPANY
Example: PRODUCT

typeenum<string>required

Allowed values: PRODUCT_ATTRIBUTE COMPANY_ATTRIBUTE PROFILE_PROPERTY
Example: PRODUCT_ATTRIBUTE

promptstringrequired

Example: How does it fit?

formatenum<string>required

Allowed values: SCALE CENTERED_RANGE SINGLE_SELECT MULTI_SELECT WOULD_RECOMMEND NUMERIC
Example: SCALE

scaleobject

Current scale size and labels, localized for the selected market. Not a submission-time snapshot.

Properties (5)

stepsnumberrequired

Example: 5

start_labelstringrequired

Example: Too small

end_labelstringrequired

Example: Too large

center_labelstring

Example: Just right

step_labelsstring[]

optionsobject[]

Current selection options. Labels are localized; values remain stable selection keys.

Item properties (2)

valuestringrequired

Example: blue

labelstringrequired

Example: Blue

numericobject

Properties (1)

unitstring

Example: cm

is_archivedbooleanrequired

Example: false

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

400 Bad request application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

401 Unauthorized application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

403 Forbidden application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

404 Not found application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

409 Conflict application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

422 Validation error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

429 Too many requests application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (6)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

Retry-Afterinteger

Seconds to wait before retrying the request

500 Internal server error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available