> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ampersand.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Ampersand REST APIs: Write, Read, Platform, and Proxy

> Learn when to use Ampersand's four REST APIs (Write, Read, Platform, and Proxy) instead of your amp.yaml manifest, and try them in the Postman Collection.

Reference documentation for Ampersand's REST APIs.

Most integration behavior is declared in your `amp.yaml` manifest rather than called directly. If you're setting up your first integration, start with [how Ampersand works](/concepts) and the [starter project](/starter-project). Come back here when you need to trigger a read on demand, write records from your backend, manage installations programmatically, or call a provider endpoint Ampersand doesn't model.

Ampersand offers 4 APIs:

* **Write API**: for writing data to your customer's SaaS instance. Learn more in [Write Actions](/write-actions).
* **Read API**: for advanced read use cases like triggering an off-schedule read of your customer's SaaS instance, or for managing read schedules. If you simply want to do scheduled reads, you do not need to use this API. Please refer to [Read Actions](/read-actions).
* **Platform API**: for advanced use cases in managing integrations and customer installations. Most customers do not use the Platform API directly, but interact with the Ampersand Dashboard, CLI or UI library instead.
* **Proxy API**: for making direct API requests to your customer's SaaS instance without any transformations. Learn more in [Proxy Actions](/proxy-actions).

> If you prefer exploring APIs interactively, check out the official Ampersand Postman Collection.
> [<img src="https://run.pstmn.io/button.svg#noZoom" alt="Run In Postman" />](https://god.gw.postman.com/run-collection/29973051-00c27855-f4bf-48be-8730-a63a19aada9b?action=collection%2Ffork\&source=rip_markdown\&collection-url=entityId%3D29973051-00c27855-f4bf-48be-8730-a63a19aada9b%26entityType%3Dcollection%26workspaceId%3D4646d536-d0c0-45a7-a2ad-058b0eae9c2b#?env%5BProduction%5D=W3sia2V5IjoiYmFzZVVybCIsInZhbHVlIjoiaHR0cHM6Ly9hcGkud2l0aGFtcGVyc2FuZC5jb20vdjEiLCJ0eXBlIjoiZGVmYXVsdCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoicmVhZEJhc2VVcmwiLCJ2YWx1ZSI6Imh0dHBzOi8vcmVhZC53aXRoYW1wZXJzYW5kLmNvbS92MSIsInR5cGUiOiJkZWZhdWx0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJ3cml0ZUJhc2VVcmwiLCJ2YWx1ZSI6Imh0dHBzOi8vd3JpdGUud2l0aGFtcGVyc2FuZC5jb20vdjEiLCJ0eXBlIjoiZGVmYXVsdCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiYXBpS2V5IiwidmFsdWUiOiIiLCJ0eXBlIjoic2VjcmV0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJwcm9qZWN0SWQiLCJ2YWx1ZSI6IiIsInR5cGUiOiJkZWZhdWx0IiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJpbnRlZ3JhdGlvbklkIiwidmFsdWUiOiIiLCJ0eXBlIjoiZGVmYXVsdCIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoicHJvdmlkZXJBcHBJZCIsInZhbHVlIjoiIiwidHlwZSI6ImRlZmF1bHQiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6Imluc3RhbGxhdGlvbklkIiwidmFsdWUiOiIiLCJ0eXBlIjoiZGVmYXVsdCIsImVuYWJsZWQiOnRydWV9LHsia2V5Ijoib2JqZWN0TmFtZSIsInZhbHVlIjoiIiwidHlwZSI6ImRlZmF1bHQiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6Imdyb3VwUmVmIiwidmFsdWUiOiIiLCJ0eXBlIjoiZGVmYXVsdCIsImVuYWJsZWQiOnRydWV9XQ==)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.