Introduction

This API reference describes the RESTful API for consuming your documents, prompts, tables, and other resources that you created in Snack Prompt.

In the sidebar you will find a complete breakdown of each endpoint available in the integration API for creating, modifying, and managing your elements within the snack prompt.

To interact with the integrations API, you need a valid token, which can be requested by following the step-by-step instructions at Get your API key.

Convention

The base URL to send all API requests is https://api-integrations.snackprompt.com .

HTTPS is required for all API requests.

Authentication

All API requests require authentication via the x-api-key header:

x-api-key: YOUR_API_KEY
Content-Type: application/json

API Key Security Keep your API key secure. Never share it publicly or commit it to version control. API keys do not expire but can be deleted at any time from your account settings.