> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/tutorials/collibra-apis.md).

# Collibra APIs

Using the Collibra APIs, you can build custom solutions that enable data intelligence across your enterprise. Whether creating applications to automate business processes, transform data, or communicate with external clients, the APIs help you build seamless solutions on top of the Collibra platform.

## API visibility

The Collibra Platform exposes public APIs so you can build extensions. The APIs are safe, easy to use, and backwards/forwards compatible within the same major release. If a break does occur, it will only happen in the next major release and you will receive a deprecation message ahead of time.

{% hint style="info" %}
You can find a list of APIs and documentation in your environment at `https://<your_collibra_url>/docs/index.html`.
{% endhint %}

For workflows, we also consider the following libraries as public:

* Java.time.\*\*
* Java.math.\*\*
* Java.lang.\*\*
* Java.text.\*\*
* Groovy.\*\*

We also use specific APIs internally to build our platform. These APIs are private and are intended for our use only. It is important to note that these APIs are not publicly documented and can break at any time.

## API technologies

The Collibra platform provides three main technologies for public APIs:

* Java APIs.
* REST APIs.
* GraphQL APIs.

The Java APIs are exclusively available through Collibra workflows and allow you to build and interact with your governance processes.

{% hint style="info" %}
Java API scripts run on the same Java Virtual Machine (JVM) as the product and can impact the overall platform performance. Avoid using workflow scripts in for heavy processes.
{% endhint %}

Collibra provides public REST APIs that allow you to integrate with your organization’s technology. Using your favorite language, you can create, update, and retrieve data, write complex scripts, or build friendly user interfaces.

The REST APIs are documented following the OpenAPI Specification 3.0. They are language agnostic and you can use them to generate clients that interact with your data. Each API endpoint has the following characteristics:

* **Stateless**: No context is stored and each client must provide all the necessary information to service the request.
* **Cacheable**: The client's intermediary can cache the responses.
* **Uniform interface**: All responses are provided as JSON.

## API first

Collibra is an API first company. It is our guarantee to treat our APIs as first-class products so you can focus on building quality applications and integrations on top of Collibra Platform.

## Additional resources

To get started with the Collibra APIs, check out these tutorials:

{% columns %}
{% column %}
{% content-ref url="/pages/uB7d2e7W1ix1NcYNfQev" %}
[Getting started with Collibra REST API](/tutorials/getting-started-with-collibra-rest-api.md)
{% endcontent-ref %}

{% content-ref url="/pages/Mo1KMlfRkF9CMQSTX6tE" %}
[Getting started with the Search API](/tutorials/getting-started-with-the-search-api.md)
{% endcontent-ref %}
{% endcolumn %}

{% column %}
{% content-ref url="/pages/2Kcc5khV3MTpP6Q5hLSw" %}
[Getting started with the Import API](/tutorials/getting-started-with-the-import-api.md)
{% endcontent-ref %}

{% content-ref url="/pages/qta3HAOVZQtRw5pDGnnE" %}
[Collibra REST API authentication](/tutorials/collibra-rest-api-authentication.md)
{% endcontent-ref %}
{% endcolumn %}
{% endcolumns %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.collibra.com/tutorials/collibra-apis.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.