# Patchworks Core API

## Introduction

As you'd expect from a [MACH Alliance member](https://machalliance.org/), the Core Patchworks platform is API-driven - every action performed from the dashboard is associated with an API request.

In this section, you'll find general information about working with the API.&#x20;

## API reference documentation

Our API reference is available in this documentation set and also via Postman. Both sets of documentation are the same, so you can use whichever platform you prefer.

{% embed url="<https://doc.wearepatchworks.com/product-documentation/api-reference>" %}

{% embed url="<https://postman.wearepatchworks.com/#intro>" %}

## Our OpenAPI specification

The Patchworks Core OpenAPI specification (and associated reference documentation) is synced with our regular releases. You can download the latest OpenAPI specification via the link below:

{% embed url="<https://doc.wearepatchworks.com/product-documentation/api-reference>" %}


---

# 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://doc.wearepatchworks.com/product-documentation/developer-hub/patchworks-core-api.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.
