API Reference

Error Responses

This page provides an overview of the various error responses you may encounter when using View.

HTTP Status Codes

View uses standard HTTP status codes, including:

  • 200: OK
  • 201: Created
  • 204: No Content
  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not Found
  • 409: Conflict
  • 429: Too Many Requests
  • 500: Internal Server Error
  • 501: Not Implemented
  • 503: Service Unavailable

Error Responses

Should an API request fail, a JSON object should be returned similar to the example below:

{
    "Error": "[error code]",
    "Message": "[human readable message]",
    "StatusCode": [http status code],
    "Context": {
        ... optional contextual object ...
    }
}

Error codes include:

  • NoObjectMetadata: no object metadata was supplied in the request
  • NoObjectData: no object data was supplied in the request
  • NoMetadataRule: no metadata rule was supplied in the request
  • RequiredPropertiesMissing: a required property was missing from the request
  • NoGraphConnectivity: connection could not be established to the graph database
  • GraphOperationFailed: a graph database operation failed
  • NoTypeDetectorConnectivity: connection could not be established to the type detector
  • UnknownTypeDetected: content-type could not be discerned
  • NoUdrConnectivity: connection could not be established to the UDR generator
  • UdrGenerationFailed: UDR could not be generated for the supplied content
  • NoSemanticCellConnectivity: connection could not be established to a semantic cell extractor server
  • SemanticCellExtractionFailed: semantic cells could not be extracted for the supplied content
  • NoDataCatalogConnectivity: connection could not be established to the data catalog
  • DataCatalogPersistFailed: source document could not be persisted within the data catalog
  • UnknownDataCatalogType: the supplied data catalog type was invalid
  • UnknownEmbeddingsGeneratorType: the supplied embeddings generator type was invalid
  • EmbeddingsPersistFailed: embeddings could not be persisted within the vector store
  • EmbeddingsGenerationFailed: embeddings could not be generated for the supplied data
  • AuthenticationFailed: the supplied credentials were invalid
  • AuthorizationFailed: the requestor does not have sufficient rights to perform the operation
  • BadRequest: the request as supplied was invalid
  • Conflict: the operation failed as it would create a conflict with an existing resource
  • DeserializationError: the supplied data could not be deserialized to the specified content-type
  • Inactive: the specified resource, tenant, user, or credential is marked inactive
  • InternalError: the operation failed due to an internal error
  • InvalidRange: the specified range could not be satisfied
  • InUse: the specified resource is in use
  • NotEmpty: the specified resource is not empty
  • NotFound: the specified resource could not be found
  • TooLarge: the request is too large and cannot be satisfied

Should you encounter status codes in the 500 range, please contact [email protected] .