API Reference

An overview on error codes you might see from Proxy API. Some error codes mentioned in the overview have a dedicated section with further guidance.

StatusTypeCodeMessage
400bad_request_errorinvalid_deployment_nameNot valid deployment name
400bad_request_errorinvalid_modelNot a valid model name
400bad_request_errormissing_modelMissing model in the request body
400bad_request_errormissing_authorization_headerMissing Authorization request header
400bad_request_errorinvalid_authorization_headerInvalid Authorization request header
400bad_request_errormissing_cogcache-openai-api-base_headerMissing CogCache-OpenAI-Api-Base request header
400bad_request_errorinvalid_cogcache-openai-api-base_headerInvalid CogCache-OpenAI-Api-Base request header
400bad_request_errormissing_cogcache-auth_headerMissing CogCache-Auth request header
400n/acontent_filterThe response was filtered due to the prompt triggering Azure OpenAI's content management policy. Please modify your prompt and retry. To learn more about our content filtering policies please read our documentation:
https://go.microsoft.com/fwlink/?linkid=2198766
401authorization_errorinvalid_cogcache-auth_headerInvalid CogCache-Auth request header
401authorization_errortemporarily_disabled_cogcache_api_keyThe provided CogCache API key is temporarily disabled
401authorization_errorno_active_subscriptionThe provided CogCache API key is disabled, no active subscription
401authorization_errorwrong_subscription_typeYou have a cache only subscription that works with your own Azure OpenAI deployment. Learn more here:
https://cogcache.readme.io/reference/integrations-your-azure-deployment
504gateway_timeoutresponse_not_found_in_cacheNo response was found in cache for the provided prompt.

400 - bad_request_error - missing_cogcache-openai-api-base_header

This error is thrown only if you have a standard subscription where you pay by cache items (not by tokens) and you fail to send the CogCache-OpenAI-Api-Base request header.

401 - authorization_error - temporarily_disabled_cogcache_api_key

This error is thrown if your subscription was temporarily paused. This might happen if there is a problem with subscription payment.

401 - authorization_error - no_active_subscription

This error is thrown when your CogCache subscription was cancelled. To restore the service you need to purchase a new CogCache subscription.