# Cases

Endpoints for case management

## Request processing of a file batch into cases

 - [POST /cases/process-file-batch](https://hypatos.redocly.app/openapi/cases/processfilebatchintocases.md): Request processing of a batch of files that were previously uploaded.
The fileIds in the request body represent the identifiers of the files
returned by the upload endpoint.

This is an asynchronous operation. A successful response confirms that the
request has been accepted; the actual case creation is carried out in the
background by AI Agents that analyze the file batch to determine which files
belong to which case and what role each file plays. Use the returned
fileBatchId to track the resulting cases via GET /cases.

The projectId in the request body is the identifier of the project in
which the cases will be created.

The optional externalId and externalData fields will be associated with
both the file batch and propagated to each case created from it.

## Create a case manually

 - [POST /cases/create](https://hypatos.redocly.app/openapi/cases/createcase.md): Manually create a case from a list of previously uploaded files. Each file
in the request must be accompanied by a type indicating the role the file
plays in the case (e.g. main document, attachment).

This is the manual case creation path, intended for API clients that
determine case composition directly, as opposed to the AI-driven case
creation triggered by POST /cases/process-file-batch.

This is an asynchronous operation. A successful response confirms that the
request has been accepted and returns the identifier of the case being
created. The case will be processed in the background.

The projectId in the request body is the identifier of the project in
which the case will be created.

## Retrieve a list of cases

 - [GET /cases](https://hypatos.redocly.app/openapi/cases/caseslist.md): Retrieve a list of cases.

## Retrieve a case by id

 - [GET /cases/{id}](https://hypatos.redocly.app/openapi/cases/casesgetbyid.md): Retrieve a case by id.

## Provide information about a transfer of a case to the target system

 - [POST /cases/{id}/transfer](https://hypatos.redocly.app/openapi/cases/casesupdatetransfer.md): Update information about the transfer for the given case.

## Download files of a case

 - [GET /cases/{id}/files](https://hypatos.redocly.app/openapi/cases/casefilesdownload.md): Download the files that are part of a case. The response format is determined
by the Accept header:

- multipart/mixed — returns all files as a multipart response, where each
  part contains the binary content of a file with its own Content-Type and
  Content-Disposition headers. This allows the client to iterate over the
  parts and attach each file individually to a workflow without any unzipping.

- application/zip — returns all files packaged as a ZIP archive. Each file
  is stored under its original filename as provided during upload. Use this if
  your HTTP client does not support multipart response parsing.

The files returned can be filtered by their mainFile flag or by their type
using the query parameters below. If no filters are provided, all files of the
case are returned.