1000

BadRequest

The server cannot or will not process the request due to something that is perceived to be a client error.

Check if you have provided a valid URL and all the required params are present in the request body.

1000

BadRequestWithMessage

The request was malformed or invalid.

6004

InvalidBucketConflictResolution

The provided conflict resolution is not supported. Please choose a valid conflict resolution strategy for the bucket.

5001

JobActionEmpty

Invalid job configuration. Action field cannot be empty, and must be one of 'backup' or 'restore'.

Returned when a job is attempting to be added to a backup schedule with no action.

5002

JobSourceEmpty

Invalid job configuration. Source field cannot be empty, and must be one of 'manual' or 'scheduled'.

Returned when a job is attempting to be added to a backup schedule with no source.

5003

NilRestoreJobOptions

Invalid job configuration. All restore jobs must have restore options set.

Returned when a restore job is being added without restore options set.

5008

InvalidTimingDay

The day attribute is invalid. Only an integer between 0 and 6 is allowed.

Returned when the day attribute to the timing struct is not an integer between 0 and 6.

5009

InvalidTimingHour

The hour attribute is invalid. Only an integer between 0 and 23 is allowed.

Returned when the hour attribute to the timing struct is not an integer between 0 and 23.

5011

InvalidIntervalValue

The incrementalEvery attribute is invalid.

Returned when asked to create or modify a backup schedule, but the incremental value provided is not valid. Must be one of '1', '2', '4', '6', '8', '12', or '24'.

5012

InvalidIntervalUnit

The unit attribute is invalid. Must be one of 'minute', 'hourly', 'daily', or 'weekly'.

Returned when the unit attribute is not one of the expected allowed constants.

5013

InvalidFullIntervalUnit

Unsupported type for backup schedule. The full backup type must be 'weekly'.

Returned when the scheduled backup type is not 'weekly'.

5014

InvalidIncrementalIntervalMinimum

Invalid incremental backup interval. The minimum allowed incremental backup interval is every 4 hours.

Returned when the incremental backup interval is quicker than every 4 hours.

5015

InvalidBackupRetentionTime

The backup retention time is invalid.

Returned when the given backup retention time is not supported.

11064

LogStreamingUnsupportedOutputType

Output type is not supported.

14001

UnsupportedModel

Model with the given name cannot be deployed

Returned when asked to deploy an unsupported model.

14011

LanguageModelDeployErrIncorrectStatus

Returned when attempting to deploy a model that is in any state other than pending. This can occur when a deploy job retries or when the model is in an invalid state.

14012

LanguageModelSecurityDeployErrIncorrectStatus

Returned when the user tries to deploy a model with security configuration that is not in healthy state.

14013

LanguageModelDeployErrFailedStatus

Returned when attempting to deploy a model that is in a failed state. Users cannot deploy a failed model.

14014

LanguageModelPauseErrIncorrectStatus

Returned when the user tries to pause a model that is in any other state other than healthy

14015

LanguageModelResumeErrIncorrectStatus

Returned when the user tries to update a model that is in a failed state

14016

LanguageModelUpdateIncorrectStatus

Returned when the user tries to update a model that is not healthy or already updating.

14017

ErrLanguageModelAlreadyUpdating

Language model can not be updated as a previous update is still in progress.

Returned when the user tries to update a model that is already being updated.

14030

UnsupportedModelKind

Model with the given kind cannot be deployed

Returned when asked to deploy an unsupported model kind.

14037

UnsupportedToolkit

Toolkit with the given type is not supported.

Returned when an unsupported toolkit is specified for deployment.

14038

UnsupportedToolkitModel

Returned when attempting to deploy a model using the given toolkit.

14041

InvalidDocumentationURL

The provided documentation URL is invalid or malformed.

Returned when the DocumentationURL field does not contain a valid absolute URI. Ensure the URL includes a valid scheme such as 'http://'; or 'https://';.

1001

Unauthorized

The request is unauthorized. Please ensure you have provided appropriate credentials in the request header. Please make sure the client IP that is trying to access the resource using the API key is in the API key allowlist.

1002

AccessDenied

Access Denied.

Your access to the requested resource is denied. Please make sure you have the necessary permissions to access the resource.

1002

RBACAccessDenied

Access Denied.

Your access to the requested resource is denied. Please make sure you have the necessary permissions to access the resource.

2001

ProjectCountQuotaReached

Unable to create a project. Project count limit is reached.

Please ensure to stay within the quota. If required, please create support ticket in order to increase the quota.

5032

ErrInvalidBackupOperationForSelfService

Returned when attempting to do operations for backups but the cluster is a free tier cluster.

12006

ErrInvalidCMEKOperationForSelfService

Returned when attempting to do operations for CMEK but the cluster is a self service trial cluster.

1011

OrganizationNotFound

Organization not found.

Check if the organization ID is valid.

2000

ProjectNotFound

The server cannot find a project by its ID.

Check if the project ID is valid.

2002

ProjectsNotFoundWithMessage

Check if the project ID is valid.

3000

NotFound

Resource not Found.

4025

ClusterNotFound

The requested cluster details could not be found or fetched. Please ensure that the correct cluster ID is provided.

4026

V3ClusterNetworkInfoNotFound

The cluster network information for the received ID could not be found. Please ensure that the correct ID is provided.

6008

BucketNotFound

The requested bucket does not exist. Please ensure that the correct bucket ID is provided.

5017

BackupRecordNotFound

The requested backup record could not be found.

Returned when the requested backup record could not be found.

5019

ExportRecordNotFound

The requested download record could not be found.

Returned when the download record cannot be found for the given ID and cluster.

5023

UnableToRetrieveBackup

Unable to retrieve the backup specified.

Returned when encountering an error while attempting to retrieve a backup record.

5029

BackupScheduleNotFound

Backup schedule not found.

Returned when a backup schedule is not found for the bucket.

8000

UserNotFound

Check userId is valid.

8013

DeleteUserNotFound

Verify the provided user ID and ensure it corresponds to an existing user before attempting to delete.

8018

UserWithIDNotFound

User not found. The system was unable to locate a user with the specified ID.

Ensure that the provided user ID is correct and corresponds to an existing user.

12000

ErrBYOKMetadataNotFound

Unable to process request for key. The key requested does not exist. Please ensure the ID of the key is correct and try again.

Please double-check the provided ID for the key and ensure it exists before making the request.

11001

CollectionNotFound

The requested collection details could not be found or fetched. Please ensure that the correct collection name is provided.

11002

ScopeNotFound

The requested scope details could not be found or fetched. Please ensure that the correct scope name is provided.

11040

OnOffScheduleNotFound

Returned from the API when a database does not have an existing On/Off schedule.

11062

BackendDatabaseNotFound

App Endpoint not found.

14000

LanguageModelDoesNotExist

Language Model with the provided ID is not deployed and could not be found.

Returned when fetching a record that does not exist.

14020

DefaultVpcNotPresent

A default VPC is required

Returned when attempting to create a shared language model, but a default VPC is not presnet

15000

AgentMemoryServerNotFound

Unable to find the agent memory server deployment.

Returned when the specified agent memory server deployment does not exist. Check that the agent memory server ID is valid and that the deployment exists within the specified cluster.

15008

AgentMemoryApiKeyNotFound

Unable to find the agent memory server API key.

Returned when the specified agent memory server API key does not exist. Check that the API key ID is valid and belongs to the specified agent memory server deployment.

15010

AgentMemoryAllowedCIDRNotFound

Returned when attempting to remove an allowed CIDR that is not present on the agent memory server allowlist. Check that the CIDR value matches an existing entry.

15016

IntegrationNotFound

Unable to find the integration.

Returned when the specified integration does not exist. Check that the integration ID is valid and that the integration exists within the organization.

1010

Conflict

There is a conflict with the current state of a resource.

Returned when trying to create or update a resource that already exists or has conflicting information.

6027

BucketDeletionNotAllowedWithUnHealthySyncGateway

Cannot delete bucket as associated app service is not in healthy state. Please wait for the app service to become healthy before performing the action.

5000

JobAlreadyExists

Unable to add job, as it already exists and is waiting to be processed.

Returned when there is already a backup or restore job with the same key in the backup config schedule.

5018

BackupScheduleAlreadyExists

Unable to add backup schedule, as a schedule already exists for the bucket.

Returned when there is already a backup schedule for the bucket in the backup config schedule.

5031

BackupIDConflict

Unable to process request, as backup ID in the payload does not match backup ID in the path.

Returned when asked to restore a backup and backup IDs in path and payload do not match.

11018

AppServiceInInvalidStateToBeTurnedOn

Returned from the API when an app service cannot be turned on because it is not currently turned off.

11019

AppServiceInInvalidStateToBeTurnedOff

Returned from the API when an app service cannot be turned off because it's in an unhealthy state.

11020

AppEndpointTransitioning

The App Endpoint is currently transitioning between states. Please try your request again once this transitioning has completed.

7010

ClusterInInvalidStateToBeTurnedOn

Returned from the API when a database cannot be turned on because it is not currently turned off.

7011

ClusterInInvalidStateToBeTurnedOff

Returned from the API when a database cannot be turned off because it's in an unhealthy state.

7013

ClusterHasUpcomingMaintenance

Returned from the API when a database cannot be turned off because of upcoming maintenance.

7014

ClusterHasActiveBackupJob

Returned from the API when a database cannot be turned off because of an active backup or restore job.

7015

ClusterHasEphemeralBuckets

Returned from the API when trying to turn off a database with memory only buckets.

7016

ClusterHasPendingRedeployment

Returned from API when given database cannot be turned off because it has a pending redeployment.

7017

ClusterLinkedAppServiceInInvalidStateToBeTurnedOff

Returned from API when given database cannot be turned off because the linked app service is in invalid state.

7019

ClusterLinkedAppServiceIsTurningOn

Returned from API when given database cannot be turned off because a turn on for the linked app service is queued or in progress. Retry once the app service is healthy.

7018

ClusterDataAPIServiceInInvalidStateToBeTurnedOff

Returned from API when given database cannot be turned off because it Data API service is in an invalid state.

7080

ErrInstanceTurnOnInvalidState

Please ensure the analytics cluster is in a valid state to be turned on.

7081

ErrInstanceTurnOffInvalidState

Please ensure the analytics cluster is in a valid state to be turned off.

11055

AppEndpointBucketHasMaxTTL

The bucket has a max time to live set above 0 which is not supported by App Services. Please update the bucket to have a max TTL of 0.

11056

AppEndpointCollectionHasMaxTTL

At least one of the collections has a max TTL set above 0 which is not supported by App Services. Please update the collection(s) to have a max TTL of 0 or unlink the unsupported collection(s).

11057

AppEndpointBucketHasDurability

The bucket has a non-default durability level set which is not supported by App Services. Please update the bucket to have a durability level of 'None'.

11055

ClusterInInvalidStateToTurnOnAppService

The App Service cannot be turned on while the cluster is in it's current state.

14035

ClusterLinkedModelServiceInInvalidStateToBeTurnedOff

Cannot turn off database because linked model service is in invalid state.

Returned when user tries to turn off a cluster but has already a models deployed in an invalid state.

14036

LLMCleanUpInProgress

Cannot deploy langauge model, resource cleanup is in progress try after sometime.

Returned when user tries to deploy a model but cleanup is in progress

14061

BackupAlreadyHasPendingExport

An export for this backup cycle is already pending or being processed.

Returned when attempting to export a backup whose cycle already has an export in the pending or processing state. Only one active export can exist per backup cycle; poll the existing export instead of creating another.

14062

BackupAlreadyHasCompleteExport

An export for this backup cycle has already completed.

Returned when attempting to export a backup whose cycle already has a complete export. Fetch the existing export to obtain a download URL, or wait for its archive to expire before exporting again.

15001

AgentMemoryServerAlreadyExists

An agent memory server deployment already exists for this cluster.

Returned when attempting to create an agent memory server on a cluster that already has one. A cluster can host at most one agent memory server deployment. Delete the existing deployment before creating a new one.

15002

AgentMemoryServerInvalidState

Returned when an operation is attempted on an agent memory server deployment whose current state does not allow it. Wait for the deployment to reach a stable state (e.g. healthy or destroyed) before retrying.

15005

AgentMemoryServerNotHealthy

Agent memory server is not healthy. Allowlist changes require a deployed, healthy agent memory server.

Returned when an allowlist mutation is attempted on an agent memory server that is not in the Healthy state. Wait for the agent memory server to reach a healthy state before modifying the allowlist.

15006

ErrAgentMemoryServerAssociatedWithCluster

An Agent Memory server is associated with the cluster, please delete the Agent Memory server before deleting the cluster.

Returned when attempting to delete a cluster that has an associated agent memory server deployment. Delete the agent memory server deployment before deleting the cluster.

15011

AgentMemoryAllowedCIDRExists

Returned when attempting to add a CIDR that is already present on the agent memory server allowlist. No action is needed.

1012

PreconditionFailed

The request precondition failed. The resource state does not meet the conditions specified in the request headers.

Please Verify the precondition headers (e.g., If-Match, If-Unmodified-Since) and ensure they align with the current state of the resource.

9000

ErrEtagVersionConflict

Please include the correct ETag version with the request.

9001

ErrInvalidETagVersion

The ETag provided is not valid. The version of the document provided does not appear to be an integer.

Please include the correct ETag version with the request.

9002

ErrInvalidETag

The ETag provided is not valid.

Please include the correct ETag version with the request.

9003

ErrEtagVersionConflictInPatchUser

Please retry the request.

1005

UnprocessableEntity

The server was unable to process the request because it contains invalid data. Check the request payload and ensure all required fields are valid.

1006

UnprocessableEntityWithMessage

The server was unable to process the request because it contains invalid data. Check the request payload and ensure all required fields are valid.

2003

ProjectDescriptionTooLong

Retry with a description with a maximum length 256 characters.

2004

ProjectNameTooLong

Retry with a name with a maximum length 128 characters.

4000

ErrClusterNoAZType

Please ensure that Availability Zone type is provided.

4000

InstanceInvalidAvailabilityZoneConfig

Please ensure that Availability Zone type is provided.

4001

ErrProviderNotSupported

Please ensure that the provider provided is supported.

4002

NilSupportPackage

Please ensure that payload or body of the request is not empty.

4003

TimezoneInvalid

Please ensure that a valid timezone is provided.

4004

ErrClusterSpecCountRequired

Please ensure that server group has at least (1) node.

4005

ErrClusterSpecNoServices

Please ensure that server specifications provided contain services.

4008

ErrClusterInvalidCIDR

Please ensure that the provided CIDR is valid.

4009

ErrClusterInvalidCIDRNotNetworkAddress

Please ensure that CIDR range has an IP address of the network address.

4010

ErrClusterInvalidCIDRNotInPrivateRange

Please ensure that the CIDR range is within the private ID address ranges.

4010

ErrClusterInvalidCIDRAlreadyUsed

Please ensure that the CIDR range is unique within this organisation.

4011

ClusterNameTooShort

Please ensure that the provided name has at least the minimum length.

4012

ClusterNameTooLong

Please ensure that the provided cluster name does not exceed the maximum length limit.

4013

ClusterNameInvalidCharacter

Please ensure that the cluster name only contains valid characters when creating or modifying the cluster name.

4014

ClusterDescriptionTooLong

Please ensure that the provided cluster description does not exceed the maximum length limit when creating or modifying the cluster.

4016

ErrRegionNotSupported

Please ensure that the provided region is supported by the given cloud provider.

4017

ErrClusterSpecsDataRequired

Please include the data service in the cluster specifications when creating or modifying the cluster.

4018

ErrClusterCreateProjectInvalid

Please provide a valid project ID when creating a new cluster. The provided project does not exist.

4019

ErrClusterCreateTenantInvalid

Please provide a valid tenant ID when creating a new cluster. The provided tenant does not exist.

4020

ErrClusterInvalidImageName

Please provide a valid image name when performing an operation on the cluster. The provided image name is not valid.

4021

ErrClusterInvalidPackageType

Please provide a valid package type when creating or modifying a cluster. The provided package type is not valid.

4022

ErrClusterInvalidProvider

Please provide a supported provider when creating a cluster. The provided provider is not supported.

4023

ErrClusterSpecInvalidCompute

Please provide a valid instance type when creating or modifying a cluster's specifications. The provided compute type is invalid.

4024

ErrClusterInvalidActivation

The tenant is not able to create a new cluster due to payment issues or revoked activation.

4027

ErrInvalidClusterArchitecture

The requested action is not supported for the cluster's architecture. Please ensure the cluster architecture supports the action.

4028

ErrDiskIopsSpecified

Please do not specify IOPS for this disk type when attempting to deploy a cluster.

4029

ErrDiskSizeAndIopsSpecified

Please do not specify disk size or IOPS for this disk type when attempting to deploy a cluster.

4030

ErrCBVersionNotSupported

Please provide a valid Couchbase Server version when creating a cluster. The provided server version is not supported.

4031

ErrClusterMismatchProjectId

Please provide a valid projectId.

4032

ErrInvalidAllowListExpiry

Please check the expiry for the allowlist.

4033

ErrClusterAuditLogExportRequestStartTooFarInPast

Please specify start time less than 30 days ago.

4034

ErrClusterAuditLogExportRequestStartNotFarEnoughInPast

Please specify start time more than 15 minutes ago.

4035

ErrClusterAuditLogExportRequestEndBeforeStart

Please ensure start time is before end time.

4036

ErrClusterAuditLogExportRequestTimeRangeTooShort

Please specify time range that is more than 15 minutes.

5000

PaginationQueryParamInvalidSortDirection

Please provide a valid sort direction ('asc' or 'desc') when using the 'sortDirection' parameter for pagination in the request.

5001

PaginationSortByFieldNotSupported

Please provide a valid sort by field when using the 'sortBy' parameter for pagination in the request.

6000

BucketMaxBucketsExceeded

The maximum number of buckets has already been reached. Unable to create a new bucket.

6001

BucketNameExists

The bucket name provided already exists. Please choose a different name for the bucket.

6002

BucketMemoryTooBig

The requested bucket size exceeds the maximum allowed size. Please choose a smaller size for the bucket.

6002

ErrBucketMemoryTooBig

The requested bucket size exceeds the maximum allowed size. Please choose a smaller size for the bucket.

6003

MagmaBucketInvalidCBVersion

When creating a bucket with the Magma storage engine, please ensure that the Couchbase Server version is at least 7.1.

6005

InvalidDurabilityLevel

The provided durability level is not supported. The supported levels are 'none', 'majority', 'persistToMajority', and 'majorityAndPersistActive'. Please choose a valid durability level for the bucket.

6006

BucketTooManyReplicasForCluster

The requested number of replicas exceeds the maximum allowed replicas based on the cluster configuration. Please reduce the number of replicas for the bucket.

6007

BucketClusterNotFound

The associated cluster for the bucket could not be located. Please ensure that the cluster exists and try again.

6006

ErrClusterUnsupportedArchitecture

The requested action or configuration change is not supported for the cluster's architecture. Please ensure the cluster has a supported architecture.

6009

ErrClusterArchitectureUnknown

The architecture of the cluster could not be determined.

6010

EphemeralBucketsNotSupported

Memory Only (ephemeral) buckets are not currently enabled.

6011

BucketNameEmpty

The bucket name is not valid. A bucket name cannot be empty. Please provide a valid name for the bucket.

6012

BucketNameDotStart

The bucket name provided is not valid. A bucket name cannot start with a dot ('.'). Please provide a valid name for the bucket.

6013

BucketNameTooLong

The bucket name provided is not valid. The maximum length of the bucket name can be 100 characters. Please provide a valid name for the bucket within the allowed length.

6014

BucketNameInvalidCharacter

The bucket name contains an invalid character. Supported characters are those in the ranges of A-Z, a-z, and 0-9; plus the underscore, period, dash, and percent characters. Please provide a valid name for the bucket.

6015

BucketTypeRequired

Bucket type is required when creating a bucket, and must be one of 'couchbase' or 'ephemeral'. Please specify a valid bucket type for the bucket.

6016

InvalidBucketType

The provided bucket type is invalid. Bucket type must be one of 'couchbase' or 'ephemeral'. Please provide a valid bucket type for the bucket.

6017

EphemeralBucketInvalidStorageBackend

storageBackend is an invalid configuration option for Memory Only buckets. Either switch to a Memory and Disk bucket or remove the 'storageBackend' payload from the request.

6018

EphemeralBucketEvictionPolicyRequired

evictionPolicy is required for Memory Only buckets and must be one of 'nruEviction' or 'noEviction'. Please specify a valid eviction policy for the Memory Only bucket.

6019

EphemeralBucketInvalidEvictionPolicy

The provided evictionPolicy is invalid for Memory Only buckets. evictionPolicy must be one of 'noEviction' or 'nruEviction'. Please provide a valid eviction policy for the Memory Only bucket.

6020

EphemeralBucketInvalidDurabilityLevel

The provided durabilityLevel is invalid for Memory Only buckets. Valid options are none and majority. Please provide a valid durability level for the Memory Only bucket.

6021

CouchbaseBucketInvalidEvictionPolicy

The provided evictionPolicy is an invalid configuration option for Couchbase (Memory and Disk) buckets. Please specify 'fullEviction', or remove the evictionPolicy payload from the request to use the default ('fullEviction').

6022

MagmaBucketSizeTooSmall

Cannot create Magma bucket. The requested size of the Magma bucket is less than the minimum amount of 1024MB. Please choose a larger size for the Magma bucket.

6023

BucketSizeTooSmall

Cannot create bucket. The requested size of the bucket is less than the minimum amount of 100MB. Please choose a larger size for the bucket.

6024

BucketTooManyReplicas

The replica count provided for the bucket is not valid. The maximum number of replicas is 3. Please reduce the number of replicas for the bucket.

6025

MaxTTLTooLarge

The TTL given is too large. The maximum allowed TTL is 2147483647 seconds. Please choose a smaller TTL for the bucket.

6026

BucketTooFewReplicas

The replica count provided for the bucket is not valid. The minimum number of replicas is 1. Please increase the number of replicas for the bucket.

6028

ErrBucketsStorageMigrationNotAvailable

Unable to migrate storage backend. The server version must be at least 7.6.0.

Cannot migrate storage backend from couchstore to magma due to incorrect server version. Please make sure that the server version is >= 7.6.0.

6029

ErrBucketsStorageMigrationClusterNotHealthy

Unable to migrate bucket storage backend. The cluster is currently performing other operations. Please wait until the cluster operations succeed and then try again.

Cannot migrate storage backend from couchstore to magma as the cluster is not in healthy state. Please wait until the cluster operations succeed and then try again.

6031

ErrBucketsAlreadyMigratedToMagma

Returned when trying to update bucket storage backend that is already magma. Please make sure that the bucket storage backend for the buckets is couchstore in order to be migrated to magma.

6032

ErrBucketsUnsupportedTypeForMagmaMigration

Cannot migrate bucket to magma as the backend storage type is not supported for migration. Please note that only couchstore buckets can be migrated to magma.

6033

ErrSingleNodeBucketDurabilityLevelNotAllowed

Cannot modify bucket durability level as only Durability level 'none' is allowed for single node clusters.

7000

EntityNotWritable

Cannot perform the action due to the entity not being in a writable state. Please wait for the entity to become writable before performing the action.

5016

BackupConfigNotFound

Unable to process request. The backup configuration for the cluster is missing. Please submit a support request to resolve this issue.

Returned when an operation against a backup config is requested and the backup config is missing.

5020

InvalidDateRange

The end date of the range cannot be before the start date of the range.

Returned when an end date that is before the start date of a date range is given.

5021

CloudProviderMismatch

Unable to restore to target cluster, as it is on a different cloud provider than the source.

Returned when attempting to restore from a cluster in one provider to a cluster in another.

5022

TargetClusterNotHealthy

Unable to target a restore for a cluster that is not in a healthy state.

Returned when attempting to create a restore job for an unhealthy cluster.

5024

BackupNotReady

Backups must be in a state of 'ready' before being used.

Returned when attempting to use a backup that is not in a 'ready' state.

5025

BackupHasExpired

Backup must not have expired to be used for a restore.

Returned when attempting to restore a backup that has been expired.

5026

InvalidRestoreSource

The source cluster ID is invalid. Please ensure the source cluster id matches the id in the path.

Returned when attempting to restore a backup and the source cluster id does not match the cluster id in the url path of the request.

5027

RestoreOptionsEmptyServices

Invalid restore options. Services list cannot be empty.

Returned when a restore options services list is empty.

5027

RestoreOptionsUnknownCouchbaseService

Returned when a restore options services list contains an unknown service.

5028

CycleHasExpired

Cycle must not have expired to be used for listing backups.

Returned from API when a cycle has been found to be expired.

5030

BackupPending

Unable to process request for backup. Backup in pending state cannot be modified.

Returned when asked to modify or delete a backup in pending state.

8001

ValidationEmailDomain

Check email domain is valid.

8002

BlockedDomainErr

Email accounts using this domain is not accepted.

8003

ValidationEmailError

Validation failed for the email address.

8004

ValidationEmailEmptyString

Email address cannot be empty. Please provide a valid email.

Ensure that you provide a non-empty email address.

8005

ValidationEmailAt

The provided email address email is invalid; the '@' is missing.

Make sure the email address contains the '@' symbol.

8006

ValidationEmailLocalLength

Ensure that the local part of the email address does not exceed 64 characters.

8007

ValidationEmailDomainLength

Check that the domain part of the email address is valid.

8008

ValidationEmailValidString

Ensure that the email address is a valid UTF-8 string.

8010

ErrDuplicateEmail

Sign in with the provided email address or use a different one.

8012

DeleteUserLastOrgOwner

Ensure there is at least one other Organization Owner before attempting to remove this user.

8019

ErrUpdatingRBACForSSOUser

Role based permissions for SSO user cannot be updated when team Group Mapping is enabled.

Any RBAC permission changes for an SSO user should be done through a Team except when group mapping is disabled on the Realm.

8020

InvalidStorageBackendOption

Returned when attempting to create a couchstore bucket and providing an invalid storageBackend value. Use either 'couchstore' or 'magma'.

8021

InvalidTimeToLiveValue

The time-to-live value provided is not supported. It should be a non-negative integer.

Returned when a time-to-live unit that is not supported is given during bucket creation. This should be a non-negative value.

8022

ErrCreateDataplaneUserRoleDoesNotExist

Returned when a trying to set a privilege other than data_reader / read or data_writer / write while creating a database credential.

8023

ErrDeleteDataplaneUserRoleInUse

Remove this database role from every database credential that references it before deleting the role.

8024

ErrDataplaneUserRoleNotFoundOnCluster

Create the application user roles on the cluster, or remove them from the request, before assigning them to a database credential.

11000

BackendInInvalidStateToBeUpdated

Verify the provided appservice is in healthy state before updating.

12001

ErrBYOKInvalidARN

Please double-check the provided ARN and ensure it follows the correct format

12002

ErrBYOKInvalidKeyName

Please double-check the provided key name and ensure it is valid according to GCP's naming conventions.

12003

ErrBYOKMissingConfigs

Please ensure that the configuration for the key includes metadata for either the AWS, GCP, or Azure key, and then try again.

12004

ErrBYOKCreateMissingTenant

Please provide a valid tenant ID when creating a CMEK, and ensure that it is included in the request.

12005

ErrBYOKCanNotDelete

Please ensure that the key is not in use by any nodes in your clusters before attempting to delete it.

11003

InvalidMaxTTL

The time-to-live value provided is not supported. It should be a non-negative integer.

Returned when a time-to-live unit given during collection creation is not supported. This should be a non-negative value.

11003

ScopeNameTooLong

The scope name provided is not valid. The maximum length of the scope name can be (251) characters.

Returned if when attempting to create a scope the name of the scope provided is too long.

11004

ScopeNameEmpty

The scope name is not valid. A scope name can not be empty.

Returned if when attempting to create a scope the name of the scope is empty.

11005

ScopeNameInvalidCharacter

Returned if when attempting to create a scope the name of the scope contains an unsupported character.

11006

ScopeNameInvalidStart

The scope name provided is not valid. A scope name can not start with an underscore or percentage.

Returned if when attempting to create a scope the name of the scope provided starts with an underscore or percentage.

11007

ScopeNameExists

Returned if when attempting to create a scope but the name of the scope already exists.

11008

CollectionNameTooLong

The collection name provided is not valid. The maximum length of the collection name can be (251) characters.

Returned if when attempting to create a collection the name of the collection provided is too long.

11009

CollectionNameEmpty

The collection name is not valid. A collection name can not be empty.

Returned if when attempting to create a collection the name of the collection is empty

11010

CollectionNameInvalidCharacter

Returned if when attempting to create a collection the name of the collection contains an unsupported character.

11011

CollectionNameInvalidStart

The collection name provided is not valid. A collection name can not start with an underscore or percentage.

Returned if when attempting to create a collection the name of the collection provided starts with an underscore or percentage.

11012

CollectionNameExists

Returned if when attempting to create a collection but the name of the collection already exists.

11041

ErrInvalidScheduleTimezone

Returned when the timezone in the schedule is invalid.

11042

ErrInvalidNumOfDays

Returned when the provided schedule is missing weekdays.

11043

ErrOnOffDayHasOnTimeBoundary

Returned when the provided schedule has 'on' or 'off' day with 'on' time boundary.

11044

ErrCustomDayNoFromOnTimeBoundary

Returned when the provided schedule has a 'custom' day without 'from' time boundary.

11045

ErrCustomDayInvalidHour

Returned when the provided schedule has a 'custom' day with an invalid hour value.

11046

ErrCustomDayInvalidMinute

Returned when the provided schedule has a 'custom' day with an invalid minute value.

11047

ErrFromBoundaryAfterToBoundary

Returned when the provided schedule has a 'custom' day with 'from' boundary after 'to' boundary.

11048

ErrDayHasInvalidState

Returned when the provided schedule has Custom days with an invalid state.

11049

ErrWeekDaysInvalidOrder

Returned when the provided schedule has the days in an invalid order than the one specified.

11050

ErrInvalidDayName

Returned when the provided schedule has an invalid day name.

11050

OnOffScheduleAlreadyExists

Returned when trying to create a new on/off schedule for the cluster which already exists.

11060

AuditLogStreamingCannotBeModifiedWithoutConfig

To change an existing Audit Log Streaming config, one must already exist. No Audit Log Streaming config currently exists. A config can be supplied using the appropriate endpoint.

11061

LogStreamingCollectorConfigNotSet

Log Streaming collector config not set.

11065

LogStreamingGenericHTTPCredentialsInvalid

Invalid Generic HTTP credentials. Please provide both a username and password or neither.

11066

AuditLoggingExportInvalidDateFormat

Date/Time format in the payload is incorrect.

11067

AuditLogStreamingEnabledFlagNotSet

The request body must explicitly define whether streamingEnabled is true or false.

11068

AuditLogStreamingOutputTypeNotSet

The request body must have outputType defined. outputType must be set when either streamingEnable=true or when streamingEnabled=false and other collector config fields have been provided.

11069

AuditLogStreamingCollectorConfigNotSet

The request body must have log streaming credentials defined. Credentials must be set when either streamingEnable=true or when streamingEnabled=false and other collector config fields have been provided.

11070

AppserviceSingleNodeFeatureNotAvailable

Returned when attempting to create or modify an app service deployment with instance desired capacity of 1, but the associated cluster is not in single node mode or the single node app service feature is not enabled for the tenant.

11071

AppserviceOnlySingleNodeAvailable

Returned when attempting to create or modify an app service deployment with instance desired capacity of more than 1, but the associated cluster is in single node mode and the single node app service feature is enabled for the tenant.

11072

LogStreamingAppEndpointOperationDisallowed

Log Streaming App Endpoint config reading and writing is only allowed while the log streaming config state is in a paused or enabled state. Try the operation again once in one of these states.

11073

CollectionsLimitReached

Returned when the cluster rejects a collection create request because a collections limit has been reached. Delete unused collections or distribute collections across additional buckets, then try again.

11013

CollectionMaxTTLTooLarge

Returned when the TTL given during collection creation or modification is not valid.

11014

CollectionInvalidServerVersion

Returned when attempting to modify a collection but the server version is not supported. This operation is only supported for server version 7.6.0 and above.

11015

InvalidMaxTTLValue

Returned when a time to live unit that is not supported is given during collection creation or modification.

12000

ErrKMSKeyUsedAsymmetricKey

Returned when attempting to create a CMEK with an asymmetric KMS key. Please provide the ARN of a symmetric KMS key.

13000

ErrAlertIntegrationNotSupportedForTrialUsers

Adding a third party alert notification requires a paid plan. Upgrade to a Capella paid plan to configure an alert integration

Returned when a trial account user tries to use the Alert Integration feature.

4037

ErrClusterTemplatesProviderInvalid

Please ensure cloud provider provided is valid.

4038

ErrClusterTemplatesRegionInvalid

Please enter the valid region for cluster deployment

4039

ErrClusterTemplatesServerVersion

Please ensure couchbase server requested for cluster deployment is supported.

4040

ErrClusterTemplatesAvailabilityZonesCountInvalid

Please ensure availability zones count is sufficient for selected cluster configuration type.

4041

ErrClusterTemplatesAvailabilityZonesNotAllowed

Please ensure cluster configuration provided ensures specifying availability zones.

4042

ErrClusterTemplatesAvailabilityZoneInvalid

Please ensure availability zones specified is valid.

4043

ErrClusterTemplatesAvailabilityZonesConfigInvalidForPlan

Please ensure selected support plan supports specifying availability zones configuration.

4044

ErrClusterTemplatesServiceGroupsTemplateInvalid

Please ensure selected support plan supports specifying availability zones configuration.

4045

ErrClusterTemplatesServiceRepeated

Please ensure any service is not repeated in more than one service group.

4046

ErrClusterSingleNodeSpecCount

Please ensure node count is 1 for single node cluster deployments.

4047

ErrClusterDataServiceNodeCount

Please ensure node count for service group containing data service is between (3) and (27).

4048

ErrClusterServiceGroupNodeCount

Please ensure all service groups have node count more then the allowed minimum. Additional service groups can have 2 nodes minimum and 24 nodes maximum.

4049

ErrClusterInvalidNodeCount

Please ensure that number of nodes for deployment request is between (3) and (27).

4050

ErrClusterDataServiceRequired

Please ensure data service is present in at least one of the service groups while deploying cluster.

4051

ErrTopologyInvalidComputeModification

Please ensure that the current compute type can be modified to the one provided.

4052

ErrTopologyDiskModificationNotAllowed

Please ensure that the type, the size, and the IOPS (if applicable) of a disk are not modified.

4053

ErrTopologyMultiNodeScalingTooFewNodes

Please ensure that the modified number of nodes is between (3) and (27).

4060

ErrDiskUltraIopsStorageRatioInvalid

Please ensure the IOPS value is in the correct range for the selected Ultra disk size.

6034

ErrSingleNodeInvalidReplicaCount

Cannot set replica count other than '0' for single-node clusters.

4060

ErrInvalidPeeringProviderType

Returned when attempting to create a new VPC peering relationship but the cloud service provider provided is not valid.

4061

ErrUnauthenticatedAdminConsentGrant

Returned when trying to retrieve command when the admin consent has not been granted by the customer or the consent granted by the customer has not been successfully verified.

4050

ErrClusterDeletionDisabled

Cannot delete cluster when deletion protection is enabled.

11051

AppServiceDeletionDisabled

Cannot delete app service when deletion protection is enabled on linked cluster.

11053

AppServiceDescriptionTooLong

The description provided is too long. The maximum length of the description can be 256 characters.

11056

AppEndpointOIDCProviderEmptyScopeDefined

The 'scope' field contains an empty value after the leading and trailing whitespace has been trimmed. Please remove this value and resubmit the request.

4050

ErrExpressScalingInvalidState

Cluster state is not valid for express scaling.

14002

InvalidThresholdValue

The given score threshold is invalid.

Returned when asked to use semantic cache with an invalid score threshold.

14003

InvalidComputeValue

The given compute configuration is invalid.

Returned when asked to use an invalid compute configuration.

14004

InvalidComputeSize

The given compute size category is invalid.

Returned when asked to use an invalid compute size category.

14005

InvalidComputeCount

The given compute count is invalid.

Returned when asked to use an invalid compute count.

14006

InvalidRegionParameter

Cannot list models in the given region as it is not supported.

Returned when asked to list language models in an invalid aws region.

14007

ErrModelServiceSingleAZCluster

The given cluster configuration is ineligible for deploying a language model. The cluster should not have a single Availability Zone in the region.

Returned when asked to deploy a language model in a single Availability Zone cluster configuration.

14008

LanguageModelInvalidStatus

Returned when attempting to list language models having a specified deployment status.

14009

ErrUnsupportedModelDeploymentRegion

Returned when asked to deploy a language model without a specified region.

14010

ErrUnsupportedModelDeploymentProvider

Returned when asked to deploy a language model without a specified provider.

14018

LanguageModelServiceMissing

Unable to deploy Language Model. 'Search' service is required to deploy a Language model.

Returned when user tries to deploy a language model but 'Search' service is missing.

14019

LanguageModelSecurityUpdateFailed

Returned when user tries to enable security configuration (guardrails or jailbreak) for a model in a tenant where no security models are already deployed

14021

EmptyName

Name is required

Returned when attempting to create a integration, but the name is empty

14022

EmptyKey

Key is required

Returned when attempting to create a integration, but the key is empty

14023

IntegrationAlreadyExists

Returned when attempting to create an integration with already existing integration name

14024

IntegrationTypeNotSupported

Returned when attempting to process a request with unsupported integration

14025

IntegrationName

Returned when attempting to process a request with unsupported integration

14026

InvalidIntegrationPayload

Returned when attempting to process a request with unsupported integration

14027

InvalidS3Payload

Returned when attempting to create a integration with invalid s3 payload

14028

InvalidOpenAIPayload

Returned when attempting to create a integration with invalid openAI payload

14029

InvalidBedrockPayload

Returned when attempting to create a integration with invalid bedrock payload

14031

EmptyIntegrationName

The integration name provided is not valid. The integration name should not be empty, missing or consist only of whitespace.

Returned when attempting to create a integration with invalid integration Name.

14032

IntegrationNameGreaterThanSupportedLength

The integration name provided is not valid. The integration name should not be greater than 50 characters.

Returned when attempting to create a integration with invalid integration Name.

14033

IntegrationNameIsNotAlphanumeric

The integration name provided is not valid. The integration name should be alphanumeric.

Returned when attempting to create a integration with invalid integration Name.

14034

ErrModelLimitExceeded

Returned when user tries to deploy a model but has already deployed the maximum allowed in the tenant.

14039

InvalidDeploymentProvider

Returned when attempting to deploy a language model but the provider is not supported.

14040

InvalidDeploymentRegion

Returned when attempting to deploy a language model but the region is not supported.

14042

InvalidProviderPayload

Returned when attempting to process a request with invalid provider payload

14043

APIKeyInvalidAllowedIP

Returned when an invalid IP is provided for the APIKey.

14044

APIKeyInvalidTokenExpiryDays

APIKey expiry duration is invalid

Returned when an invalid expiry duration is provided for the APIKey. The expiry duration must be less than or equal to 365 days.

14045

LMPrivateEndpointProviderAlreadyEnabled

Private Endpoint Provider is already enabled for this region and provider.

Returned when attempting to enable private endpoint provider for the region and provider that already has them enabled.

14046

LMPrivateEndpointProviderNotEnabled

Private Endpoint Provider is not enabled for this region and provider.

Returned when attempting to disable private endpoint provider for the region and provider and private endpoint provider is not enabled.

14047

LMEndpointProviderNotFound

Endpoint provider not found.

Returned when id is provided that doesn't exists.

14048

ErrUnsupportedProviderForModelPrivateEndpoints

Returned when attempting to enable private endpoints for a provider that is not supported.

14049

ErrClusterIDEmpty

Cluster ID cannot be empty.

Returned when attempting to add interface endpoint without providing a cluster ID.

14050

ErrPerformingModelAction

Returned when attempting to perform an invalid action on a model.

14051

ErrModelEndpointProviderIDEmpty

Model endpoint provider ID cannot be empty.

Returned when endpoint provider ID is not provided for any endpoint operations.

14052

ErrVPCIDEmpty

VPC ID cannot be empty.

Returned when attempting to add interface endpoint without providing a VPC ID.

14053

ErrSubnetIDsEmpty

Subnet IDs cannot be empty.

Returned when attempting to add interface endpoint without providing subnet IDs.

14054

ErrServiceSourceMissing

Service Source is missing.

Returned while attempting to add an entry to the allowlist; however, the initiating service is missing

14056

BedrockAPIKeyIntegrationNotEnabled

AWS Bedrock API key integration is disabled for your organization. Please speak to Capella support for more information.

Returned when attempting to create or update an AWS Bedrock integration that uses API-key authentication (or to reference one from an AI workflow) while the bedrock-api-key-integration feature flag is disabled for the tenant. IAM-credential Bedrock integrations are not gated.

14057

BedrockPrivateEndpointNotEnabled

Private networking for AWS Bedrock workflows is disabled for your organization. Please speak to Capella support for more information.

Returned when creating an AI workflow that sets privateEndpointEnabled on its external AWS Bedrock embedding model while the bedrock-private-endpoint feature flag is disabled for the tenant.

14058

BedrockIntegrationRegionLockedByPrivateEndpoint

The integration's region cannot be changed while AI workflows with private networking are using it. Delete those workflows first, then update the region.

Returned when attempting to change the region of an AWS Bedrock integration that is referenced by AI workflows with privateEndpointEnabled. The private endpoint is provisioned for the integration's region; changing the region would orphan it. Other integration fields, such as rotated credentials, remain updatable.

14059

BedrockIntegrationDeleteLockedByPrivateEndpoint

The integration cannot be deleted while AI workflows with private networking are using it. Delete those workflows first, then delete the integration.

Returned when attempting to delete an AWS Bedrock integration that is referenced by AI workflows with privateEndpointEnabled. The workflow destroy path resolves the Bedrock region from the integration to tear down the shared private endpoint, so deleting the integration first would leave the workflows undestroyable and the endpoint orphaned.

14060

BackupTooLargeToDownload

The backup exceeds the 5 TB maximum size supported for export.

Returned when attempting to export a backup larger than the 5 TB export size limit. Exports of larger backups are not supported; restore the backup to a cluster instead.

15003

AgentMemoryServerInvalidConfig

The provided agent memory server configuration is invalid.

Returned when the agent memory server configuration fails validation. Verify that all required configuration fields are present and valid, for example that the model is offered by the specified integration and that limits are within the allowed range.

15004

AgentMemoryServerValidationFailed

Returned when the agent memory server request is well-formed but semantically invalid. Check that the target cluster is healthy and meets all prerequisites for the operation.

15007

ClusterNotEligible

The cluster is not eligible for an agent memory server deployment. The cluster must run the data, index, query, and search services and be on Couchbase Server 8.0.0 or later.

Returned when the target cluster does not meet the service or version requirements for an agent memory server deployment. Ensure the cluster has the data, index, query, and search services enabled and is running Couchbase Server version 8.0.0 or later.

15009

AgentMemoryApiKeyInvalidAccessPolicy

The provided access policy is invalid.

Returned when the access policy for an agent memory server API key uses unsupported roles. Check the API documentation for the list of valid access policy roles.

15012

AgentMemoryAllowedCIDRInvalid

Returned when the supplied allowed CIDR does not parse as a valid CIDR block. Ensure the value is a valid IPv4 CIDR (e.g. 10.0.0.0/24).

15013

AgentMemoryAllowedCIDRNotIPv4

Returned when the supplied allowed CIDR is IPv6. The agent memory server load balancer is IPv4-only; provide an IPv4 CIDR block instead.

15014

AgentMemoryAllowedCIDRNotNetworkAddress

Returned when the supplied allowed CIDR has host bits set. Use the network address form of the CIDR (e.g. use 10.1.0.0/16 instead of 10.1.2.3/16).

15015

AgentMemoryAllowedCIDRLimitExceeded

Returned when adding a CIDR would take the agent memory server allowlist past its maximum number of entries. Remove unused CIDR entries before adding new ones.

1004

APIKeyRateLimitExceeded

Oops! You've made too many requests. Please wait for time specified in the retryAfter header before trying again.

The number of requests allowed per API key has exceeded. Please retry after time specified in the retryAfter header has passed.

10000

InternalServerError

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.

10001

InternalServerErrorWithMessage

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.

10002

DeleteUserGetStoreError

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.

10003

CognitoDeleteUser

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.

10004

DeleteUserSessionsStoreError

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.

10005

DeleteUserStoreError

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.

10006

NewUserCreateStoreError

An internal server error occurred.

Something went wrong on our end. We are actively investigating the issue.

SESSION_ALREADY_ENDED

SessionAlreadyEnded

Session has already ended

The session has already been ended and cannot be ended again or written to. Start a new session for further activity.

PROMPT_EXTRACTION_DISABLED

PromptExtractionDisabled

A prompt reference was provided but semantic extraction is disabled for this call

A prompt_id was supplied while semantic extraction was turned off for the request. Enable extraction, or drop the prompt reference.

INVALID_REQUEST

InvalidRequest

Invalid request

The request was rejected as malformed — for example an unparseable filter or other caller-supplied value. Correct the request and resend.

INVALID_TOKEN

InvalidToken

Invalid token

The bearer token is malformed, has invalid claims, or is an ID token rather than an access token. Send a valid OIDC access token in the Authorization header.

TOKEN_EXPIRED

TokenExpired

Token has expired

The access token is past its expiry. Obtain a fresh token from your identity provider and retry.

TOKEN_VALIDATION_FAILED

TokenValidationFailed

Token validation failed

The token could not be validated against the identity provider's keys. Confirm the token was issued by the configured issuer and audience, then retry with a new token.

AUTHENTICATION_REQUIRED

AuthenticationRequired

Authentication required

No bearer token was supplied for a protected route. Include an Authorization=Bearer <access_token> header.

FORBIDDEN

Forbidden

Insufficient permissions

The token is valid but carries no AMS role, or a role below the tier this route requires (ams_ro < ams_rw < ams_admin). The response names the required tier. Grant the caller the needed role.

USER_NOT_FOUND

UserNotFound

User not found

No user exists for the user_id in the path. Create the user first, or check the identifier.

SESSION_NOT_FOUND

SessionNotFound

Session not found

No session exists for the given session_id (and user_id, when the lookup is user-scoped). Create the session first, or check the identifiers.

PROMPT_NOT_FOUND

PromptNotFound

Prompt not found

No prompt exists for the given prompt_id. Register the prompt first, or check the identifier.

PROMPT_VERSION_NOT_FOUND

PromptVersionNotFound

Prompt version not found

The requested version of the prompt does not exist. List the prompt's versions and reference an existing one.

MEMORY_BLOCK_NOT_FOUND

MemoryBlockNotFound

Memory block not found

No memory block exists for the given id (within the session, when the lookup is session-scoped). Check the block id, or note that only READY blocks are retrievable.

NOT_FOUND

NotFound

Resource not found

No route matches the requested method and path. Check the URL and HTTP method against the API reference.

USER_ALREADY_EXISTS

UserAlreadyExists

User already exists

A user with this user_id already exists. Use a different id, or fetch/update the existing user instead of creating it.

SESSION_ALREADY_EXISTS

SessionAlreadyExists

Session already exists

A session with this session_id already exists for the user. Use a different id, or continue with the existing session.

PROMPT_ALREADY_EXISTS

PromptAlreadyExists

Prompt already exists

A prompt with this prompt_id already exists. Use a different id, or update the existing prompt to create a new version.

PROMPT_ID_ARCHIVED

PromptIdArchived

Prompt has been archived and can no longer be referenced or re-created

The whole prompt id has been archived. Reference a different prompt; an archived id cannot be reused or recreated.

PROMPT_ALREADY_ARCHIVED

PromptAlreadyArchived

Prompt has already been archived

The prompt is already archived, so it cannot be archived again. No action needed.

PROMPT_VERSION_ARCHIVED

PromptVersionArchived

Prompt version has been archived and can no longer be pinned to

The referenced prompt version is archived and cannot be pinned to. Pin to a live version instead.

PROMPT_VERSION_ALREADY_ARCHIVED

PromptVersionAlreadyArchived

Prompt version has already been archived

The prompt version is already archived, so it cannot be archived again. No action needed.

PROMPT_CURRENT_VERSION_PURGE

PromptCurrentVersionPurge

Cannot purge the current version of a prompt — update it to a new version first, or purge the whole prompt instead

Purging the version currently in use is not allowed. Update the prompt to a new current version first, then purge the old one, or purge the entire prompt.

PROMPT_CURRENT_VERSION_ARCHIVE

PromptCurrentVersionArchive

Cannot archive the current version of a prompt — update it to a new version first, or archive the whole prompt instead

Archiving the version currently in use is not allowed. Update the prompt to a new current version first, then archive the old one, or archive the entire prompt.

PROMPT_ALREADY_PURGING

PromptAlreadyPurging

Prompt is currently being purged

A purge of this prompt is already in progress. Wait for it to finish before issuing another purge.

MEMORY_BLOCK_BUSY

MemoryBlockBusy

Memory block is currently being processed

The block is mid semantic-extraction and cannot be updated right now. This is transient; retry after the interval in the Retry-After header.

INVALID_REQUEST

ValidationFailed

Request validation failed

The request body or parameters failed schema validation. details.fields lists each offending field and why. Fix those fields and resend.

QUEUE_FULL

QueueFull

Memory processing queue is full

The asynchronous extraction queue is at capacity, so the block was not accepted. Back off and retry after the Retry-After header; details.queue_size and details.queue_max_size report current depth.

USER_ERROR

UserError

User operation failed

An unexpected server-side error occurred while processing the user operation. Retry; if it persists, contact support with the request_id.

SESSION_ERROR

SessionError

Session operation failed

An unexpected server-side error occurred while processing the session operation. Retry; if it persists, contact support with the request_id.

PROMPT_ERROR

PromptError

Prompt operation failed

An unexpected server-side error occurred while processing the prompt operation. Retry; if it persists, contact support with the request_id.

MEMORY_BLOCK_DELETE_FAILED

MemoryBlockDeleteFailed

Failed to delete memory block

The block could not be deleted due to a server-side error. Retry; if it persists, contact support with the request_id.

EMBEDDING_GENERATION_FAILED

EmbeddingGenerationFailed

Failed to generate embeddings for memory blocks

The embedding provider returned an error while embedding the submitted blocks. Retry; if it persists, check the embedding model configuration and provider status.

MEMORY_BLOCK_ERROR

MemoryBlockError

Memory block operation failed

An unexpected server-side error occurred while processing the memory block. Retry; if it persists, contact support with the request_id.

DATABASE_ERROR

DatabaseError

Database operation failed

A non-transient Couchbase failure that will not improve on retry. When a bucket, scope, collection, keyspace, or index is missing, details.service, details.resource, and details.name identify it; other database faults (e.g. a malformed query) carry no details and only a request_id. Check that the configured storage and FTS indexes exist.

INTERNAL_ERROR

InternalError

Internal server error

An unhandled server-side error occurred. Retry; if it persists, contact support with the request_id from the response.

MODEL_SERVICE_CONNECTION_ERROR

ModelServiceConnectionError

Unable to connect to model service

The server could not open a connection to the model provider. The body message is generic by design; the failure is identified by the X-Upstream-Service and X-Error-Class=connection_error response headers, and the underlying error is logged against the request_id. Check network egress to the provider and provider status, then retry.

MODEL_SERVICE_ERROR

ModelServiceError

Model service error

The model provider returned an unexpected error. The body message is generic; X-Upstream-Service and X-Error-Class (the provider error class) name the failure, and the detail is logged against the request_id. Retry; if it persists, check provider status.

TOKEN_VALIDATION_FAILED

AuthServiceUnavailable

Authentication service temporarily unavailable

The identity provider (OIDC discovery or JWKS endpoint) is unreachable, so the token could not be validated. This is transient and unrelated to the token itself; retry after a short delay.

DATABASE_UNAVAILABLE

DatabaseUnavailable

Database is temporarily unavailable

A transient Couchbase failure (timeout or connection loss) occurred. This is retryable; retry after a short delay. details.service is "database".

EMBEDDING_SERVICE_UNAVAILABLE

EmbeddingServiceUnavailable

Embedding service is unavailable

The embedding model failed its health check and requests are being blocked. details.service is "embedding". Retryable once the provider recovers; check the embedding model configuration and provider status.

LLM_SERVICE_UNAVAILABLE

LlmServiceUnavailable

LLM service is unavailable

The LLM (extraction) model failed its health check and requests are being blocked. details.service is "llm". Retryable once the provider recovers; check the LLM model configuration and provider status.

MODEL_SERVICE_AUTH_ERROR

ModelServiceAuthError

Model service authentication failed

The model provider rejected the configured API key. Identified by the X-Upstream-Service and X-Error-Class=authentication_error response headers. This is a server configuration issue, not the caller's; rotate or correct the provider API key.

MODEL_HEALTH_CHECK_FAILED

ModelHealthCheckFailed

Model health check failed

A pre-request model health check failed. The X-Upstream-Service=model response header marks it; no details object is returned. Retryable once the model recovers; check the model configuration and provider status.

UPSTREAM_RATE_LIMITED

UpstreamRateLimited

Model service temporarily unavailable due to upstream rate limiting

The model provider rate-limited this deployment and internal retries were exhausted. details.retry_after_seconds and details.service (embedding/llm/unknown) accompany it, mirrored by the Retry-After and X-Error-Class=rate_limit_exhausted headers. Back off and retry after Retry-After.

UPSTREAM_QUOTA_EXHAUSTED

UpstreamQuotaExhausted

Model provider account quota exhausted — retrying will not help

The model provider account is out of quota or credits. details.service names the affected model and details.retry_after_seconds is 0; the X-Error-Class=quota_exhausted header marks it and no Retry-After is sent. This is permanent until resolved; top up credits or rotate the API key.

MEMORY_PRESSURE

MemoryPressure

Server is under memory pressure

The server is shedding load because memory usage crossed its threshold. No details object is returned; the Retry-After and X-Memory-Usage-Percent response headers carry the specifics. Back off and retry after Retry-After.

MODEL_SERVICE_TIMEOUT

ModelServiceTimeout

Model service request timed out

The model provider did not respond within the timeout. Identified by the X-Upstream-Service and X-Error-Class=timeout response headers. Retry; if it persists, check provider status and latency.