# APIs

### Welcome to the API Documentation

This API provides a simple and direct way to query the Seal platform for existing vulnerable and sealed packages.

Our goal is to make this process as straightforward as possible for developers.

#### How it Works

The API is a **RESTful** service that accepts and returns **JSON** data.

#### Authentication

To use the Seal API, you will need to authenticate your requests. You will need a [token](/fundamentals/artifact-server/generating-a-token.md) to the Seal server - the same token used to download artifacts. Requests are authenticated using a Bearer Token in the `Authorization` header.

#### Making Your First Request

Here's a quick example of how to use our API:

**Example Request (using cURL):**

Bash

```
curl --location 'https://external.sealsecurity.io/authenticated/api/v1/packages/vulnerable?limit=2' \
--header 'Authorization: Bearer $TOKEN'
```

In the command above, replace `$TOKEN` with your access token to the Seal server.


---

# 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.sealsecurity.io/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.