# REST APIs

## Alternatives

To simplify integration and enable interoperability with third-party systems, Snow Owl TS offers two  forms of accessing terminology resources via HTTP requests:

* An API compliant with the requirements listed in the FHIR R5 specification for terminology services: <https://hl7.org/fhir/R5/terminology-service.html>
* A native API that is customized to match Snow Owl's internal representation of its supported resources, and so can provide more options

The following pages provide additional information on each method of access:

{% content-ref url="/pages/-MejciA6KTVvufNHScIK" %}
[FHIR API](/snow-owl/9.x/rest-apis/fhir.md)
{% endcontent-ref %}

{% content-ref url="/pages/-Mejci9twml04IUlqBnJ" %}
[Native API](/snow-owl/9.x/rest-apis/native.md)
{% endcontent-ref %}

## Official Examples

A comprehensive set of examples is available in our Postman collection: <https://documenter.getpostman.com/view/16295366/2s93z3h6cP>

## Interactive documentation

Port 8080 and the context path `/snowowl` is assigned in the default installation for serving both APIs. Navigate to `http(s)://<host>:8080/snowowl/` to visit the built-in "interactive playground" which lists all available requests by category in the dropdown on the top left:

<figure><img src="/files/p8uxxqchIZMmvM5SlOqg" alt=""><figcaption><p>API categories</p></figcaption></figure>

Once valid user credentials are entered on the "Authentication" page reachable from the sidebar, it becomes possible to send requests to the server and inspect the returned response body as well as any relevant headers:

<figure><img src="/files/Zpp8Nr11VPbX4yb9tZLu" alt=""><figcaption><p>Authentication settings</p></figcaption></figure>

Select a request from the sidebar so that its documentation page appears in the main area. Each request is accompanied by a short description and the list of parameters it accepts. Fields marked with a <mark style="color:red;">\*</mark> symbol are required.&#x20;

Press the `Try` button after populating the input fields to execute the request:

<figure><img src="/files/BYLUzXM3FILo1qq0JCXU" alt=""><figcaption><p>Output of a handcrafted concept suggestion request</p></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.b2ihealthcare.com/snow-owl/9.x/rest-apis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.