Skip to main content
If you build with an AI assistant, give it this page’s prompt first. The prompt teaches the assistant how the Pazy API works, makes it ask you the right questions before it writes code, and points it at the documentation for every endpoint.

How to use it

1

Create an API key

In the Pazy app, go to Settings → Developer → Create API Key. Give the key only the permissions your integration needs.Store the key in an environment variable such as PAZY_API_KEY.
Don’t paste your API key into the chat with the assistant. The prompt tells it to read the key from an environment variable instead.
2

Copy the prompt

Use the copy button on the code block below.
3

Paste it into your assistant

Use any assistant that can write code, such as ChatGPT, Claude, Cursor or GitHub Copilot. For the best results, use one that can open web pages, so it can read the endpoint documentation.
4

Answer its questions

The assistant will ask what you want to build, your language, which Pazy resources are involved, whether to use a sandbox, and how to handle failures. Then it will give you a plan to confirm before it writes code.
5

Review before you run it

Read the code, and try read-only calls first. Be especially careful with calls that create or change data, and with marking invoices as paid.
A sandbox environment is created on request. Email customer-support@pazy.io to ask for one, and test write operations there before you run them in production.

The prompt

Pazy integration prompt

What the assistant will ask you

The prompt makes the assistant ask these questions before it writes any code, so have the answers ready:
  • What you’re building, such as syncing vendors, creating purchase orders, uploading invoices or recording payments.
  • Your language, framework, and where the code runs.
  • Which Pazy resources you need, and whether you only read data or also write it.
  • Whether this is a sandbox or production.
  • Which permissions your API key has, and how you store it.
  • How often it runs and how many records it handles.
  • Whether it runs on a schedule, on demand, or when something changes in Pazy.
  • What should happen when a call fails.

Prefer to work in your AI client directly?

Set up the Pazy MCP server instead, so the assistant can use your Pazy data without you writing integration code. See the MCP integration guide.

API overview

Authentication, rate limits, pagination and the quickstart.

Webhooks

Get notified when things change, instead of polling.