---
last_review: "2025-01-01"
last_reviewer: "-"
documented_code: [ ]
---

```{tags} explanation, administrator
```

# The Entity API

:::{note}
This page has been migrated from the old documentation, and has not yet been fully revised.
There might be inconsistencies or errors when using with current LinkAhead versions.
:::
% TODO: Issue: https://gitlab.indiscale.com/caosdb/src/linkahead-docs/-/issues/90
% TODO: Stub: Extend, then sort into correct section

The details of the specification, including interactive examples, can be found
[here](https://gitlab.com/linkahead/linkahead-server/-/blob/dev/src/doc/development/api/xml/caosdb_openapi.yaml).
Note that some commands may require authentication, which can be done with an authentication cookie
as described in the [api documentation](/how_to/admin_guides/general_functions/Authentication.md).
Specialities of the [scripting api](/tutorial/scripting/server_side_scripting/Server-side-scripting.md)
and the [file api](/explanation/server/Fileserver.md) are explained in the corresponding sections of
the specifications.