# Hypatos REST API API

> Hypatos REST API API on Apizie: 34 endpoints (Request an access token, Upload a file, Download a file by id, Retrieve a list of documents, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/security:hypatos/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `security:hypatos`
- Category: Security
- Status: byok
- Source: https://hypatos.ai
- Page: https://zieapi.vercel.app/api/security/hypatos
- OpenAPI: https://zieapi.vercel.app/api/security/hypatos/openapi.json

# Introduction The Hypatos API is organized around REST. The majority of the endpoints provide CRUD functionality for resources. The API is also exposing Intent Resources which mimic user intents or actions. The…

## Endpoints

### Request an access token
`POST https://zieapi.vercel.app/v1/security:hypatos/authorization-request-access-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Upload a file
`POST https://zieapi.vercel.app/v1/security:hypatos/files-upload-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Hy-Filename | string | no | Optional name of the file to be stored along with the content. If not provided, a filename will be generated |

### Download a file by id
`GET https://zieapi.vercel.app/v1/security:hypatos/files-download-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | File id to download |

### Retrieve a list of documents
`GET https://zieapi.vercel.app/v1/security:hypatos/documents-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| projectId | array | no | Project ids to to find items by. If ommitted, items from all existing projects are returned. |
| offset | integer | no | A zero-based offset of the first item in the data collection to return. |
| limit | integer | no | Limit the amount of items returned in the response. If the value exceeds the maximum, then the maximum value will be used. |
| sort | string | no | The field to sort reponse items by. |
| state | array | no | Used to retrieve documents that are in specific states only. Multiple states can be used for this filtering. By default, documents in all… |
| fileId | string | no | File identifier to retrieve documents that were created from that file |

### Request processing of a file
`POST https://zieapi.vercel.app/v1/security:hypatos/documents-process-file-into-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a document by id
`GET https://zieapi.vercel.app/v1/security:hypatos/documents-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Id of the document to get. |

### Provide information about a transfer of a document to the target system
`POST https://zieapi.vercel.app/v1/security:hypatos/documents-update-transfer-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Id of of the document to update. |
| body | object | yes | JSON request body |

### Provide external data for a document with given id
`POST https://zieapi.vercel.app/v1/security:hypatos/documents-update-external-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Id of the document to update. |
| body | object | yes | JSON request body |

### Provide an external identifier for a document with given id
`POST https://zieapi.vercel.app/v1/security:hypatos/documents-provide-external-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Id of the document to update. |

### Provide a title for a document with given id
`POST https://zieapi.vercel.app/v1/security:hypatos/documents-provide-title` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Id of the document to update. |

### Retrieve a document states
`GET https://zieapi.vercel.app/v1/security:hypatos/documents-get-document-states` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Id of the document to get states of. |

### Insert invoice including invoice lines
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-insert-invoice-including-invoice-lines` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Mark invoice as deleted
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-mark-invoice-deleted` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalId | string | yes | Previously sent `externalId` |
| lineNumber | string | no | Line number of one of the line numbers inside the Invoice. Optional, omitting means the whole Invoice is deleted. |

### Insert company
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-add-company-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Mark company as deleted
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-mark-company-deleted` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalId | string | yes | Previously sent `externalId` |

### Insert supplier including related subsidiaries
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-insert-supplier-including-subsidiaries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Mark supplier as deleted
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-mark-supplier-deleted` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalId | string | yes | Previously sent `externalId` |

### Insert purchase order including purchase order lines
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-insert-purchase-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Mark purchase Order as deleted
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-mark-purchase-order-deleted` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalId | string | yes | Previously sent `externalId` |
| lineNumber | string | no | Line number of one of the line numbers inside the PO. Optional, omitting means the whole PO is deleted. |

### Insert general ledger account
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-insert-gl-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Mark general ledger account as deleted
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-mark-gl-account-deleted` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalId | string | yes | Previously sent `externalId` |

### Insert cost center
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-insert-cost-center` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Mark cost Center as deleted
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-mark-cost-center-deleted` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalId | string | yes | Previously sent `externalId` |

### Insert approver
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-insert-approver-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Mark approver as deleted
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-mark-approver-deleted` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalId | string | yes | Previously sent `externalId` |

### Insert customer
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-insert-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Mark customer as deleted
`POST https://zieapi.vercel.app/v1/security:hypatos/enrichment-mark-customer-as-deleted` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| externalId | string | yes | Previously sent `externalId` |

### Retrieve a company by id
`GET https://zieapi.vercel.app/v1/security:hypatos/companies-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Id of the company to retrieve |

### Retrieve a list of companies
`GET https://zieapi.vercel.app/v1/security:hypatos/companies-list` (byok)

### Retrieve a projects list for given search criteria
`GET https://zieapi.vercel.app/v1/security:hypatos/projects-list-for-given-search-criteria` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | A zero-based offset of the first item in the data collection to return. |
| limit | integer | no | Limit the amount of items returned in the response. If the value exceeds the maximum, then the maximum value will be used. |
| sort | string | no | The field to sort reponse items by. |
| search | string | no | Search text is used against projects name and id |

### Create a project
`POST https://zieapi.vercel.app/v1/security:hypatos/projects-create-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve a project by id
`GET https://zieapi.vercel.app/v1/security:hypatos/projects-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Project id |

### Retrieve a schema by project id
`GET https://zieapi.vercel.app/v1/security:hypatos/projects-get-schema-by-project-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Project id |

### Retrieve an email merged content for given document ID
`GET https://zieapi.vercel.app/v1/security:hypatos/emails-get-merged-content-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

## Example
```
curl "https://zieapi.vercel.app/v1/security:hypatos/authorization-request-access-token" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Hypatos REST API API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/security:hypatos/authorization-request-access-token with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Hypatos REST API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Hypatos REST API itself also needs your own key from api.cloud.hypatos.ai.

### Can AI agents use the Hypatos REST API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key security:hypatos.

### What is the status of the Hypatos REST API API?
Needs your own provider key (bring your own key)