<commit_before><commit_msg>initial commit of apiary api docs<commit_after>FORMAT: 1A


# Raziel

Raziel is a flexible REST API and web interface that implements a basic versioning
file system with similar concepts as Git.

# Group Collections

## File [/v1/files/{+url}]

+ Parameters
  + url (string) - File storage location.

+ Attributes
  + url (string, required) - File storage location.
  + namespace (string, required) - File namespace (the dirname of the url).
  + name (string, required) - The file name.
  + tag (string) - Symbolic tag name for this version.
  + size (number, required) - The file size, in bytes.
  + timestamp (number, required) - The unix timestamp when the file version was uploaded.
  + version (number, required) - The file version.
  + downloads (number, required) - The number of downloads.
  + lastDownload (number) - THe unix timestamp when the file was last downloaded.
  + md5 (string, required) - The file's MD5 hash.
  + sha1 (string, required) - The file's SHA-1 hash.
  + sha256 (string, required) - The file's SHA-256 hash.
  + apiKey (string, optional) - The write-protect API key. This attribute is only available when the file is first uploaded and the `protect` attribute is set to "true". Otherwise, the `apiKey` attribute will not be present.

### Upload a File [POST]

+ Attributes
  + file (required) - File content.
  + name (string) - Specific file name. If not specified, the upload file's original name is used.
  + tag (string) - Symbolic tag for the new file version.
  + apiKey (string) - If the file is new, write-protect the new file with the specified API key. If the file is not new, the specified API key must match the existing file's.
  + protect (boolean) - Whether to generate a write-protect API key for the new file. Accepts either "true" or "false".


+ Request Upload File (multipart/form-data)


+ Response 200 (application/json)

  File was successfully saved.

  + Attributes (File)


+ Response 401 (application/json)

  Access denied; The file already exists and is protected by an API key and the request's API Key did not match.

  + Attributes
      + error (string) - The error message.
{'fraction_non_alphanumeric': 0.0886426592797784, 'fraction_numerical': 0.008310249307479225, 'mean_word_length': 3.542976939203354, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '702919', 'n_tokens_mistral': 636, 'n_tokens_neox': 600, 'n_words': 294}