API & Integrations

Your Integration Hub

The API & Integrations page is your central hub for programmatic access, webhooks, and third-party connections. Manage API keys, set up webhooks, browse the marketplace, and build automations all in one place.

7 Tabs

API Access

Webhooks

Marketplace

Page Tabs Overview

API Keys

Create and manage API keys for programmatic access to PromptOutput

Webhooks

Configure HTTPS endpoints to receive real-time event notifications

Integrations

Ready-to-use templates for Zapier, Make.com, and n8n automation

Request Logs

View recent API request history with status codes and response times

Marketplace

Browse and connect third-party integrations (CRM, helpdesk, etc.)

Connected

Manage active integration connections and their status

Automations

Build automated workflows using connected integrations

API Keys

Create API keys to integrate PromptOutput with external services like Zapier, Make, or custom applications.

Creating an API Key:

Navigate to API & Integrations → API Keys
Click Create API Key
Enter a descriptive name (e.g., "Zapier Integration")
Optionally add IP restrictions for security
Copy the key immediately - it's shown only once!

Available Buttons:

View API Docs

Opens comprehensive API documentation

Create API Key

Opens dialog to create new key

Edit (pencil icon)

Edit IP restrictions

Delete (trash icon)

Permanently delete API key

Security Tips:

Use IP restrictions to limit which servers can use your API key
Rotate keys periodically for enhanced security
Use separate keys for different integrations
Never share your API key publicly

API Authentication

All API requests require authentication using your API key in the headers.

curl -X POST "https://api.promptoutput.ai/api-upload-source" \
  -H "Authorization: Bearer YOUR_SUPABASE_ANON_KEY" \
  -H "X-API-Key: pk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type": "text", "content": "Your content here"}'

Authorization Header

Bearer token with Supabase anon key

X-API-Key Header

Your PromptOutput API key (pk_live_...)

Rate Limit

60 requests per minute (default)

Upload Sources API

POST /api-upload-source

Upload content to use as a source for post generation

Requires: sources:write

Request Body Parameters

Field	Type	Required	Description
`type`	string	Yes	One of: `text`, `url`, `youtube`
`name`	string	No	Display name for the source
`content`	string	text only	Text content (required for type: text)
`url`	string	url/youtube	URL to fetch (required for type: url or youtube)
`folder_id`	string	No	UUID of folder to add source to
`webhook_url`	string	No	One-time callback URL when processing completes

Example: Upload Text

curl -X POST "https://api.promptoutput.ai/api-upload-source" \
  -H "Authorization: Bearer YOUR_ANON_KEY" \
  -H "X-API-Key: pk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "text",
    "name": "Product Launch Notes",
    "content": "We are launching a new AI-powered feature..."
  }'

Example: Upload URL

curl -X POST "https://api.promptoutput.ai/api-upload-source" \
  -H "Authorization: Bearer YOUR_ANON_KEY" \
  -H "X-API-Key: pk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "url",
    "name": "Blog Article",
    "url": "https://example.com/blog/article"
  }'

Example: Upload YouTube Video

curl -X POST "https://api.promptoutput.ai/api-upload-source" \
  -H "Authorization: Bearer YOUR_ANON_KEY" \
  -H "X-API-Key: pk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "youtube",
    "url": "https://www.youtube.com/watch?v=VIDEO_ID"
  }'

Example: Upload File

curl -X POST "https://api.promptoutput.ai/api-upload-source" \
  -H "Authorization: Bearer YOUR_ANON_KEY" \
  -H "X-API-Key: pk_live_YOUR_KEY" \
  -F "file=@document.pdf" \
  -F "name=Q4 Report"

Response

{
  "success": true,
  "data": {
    "source_id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Product Launch Notes",
    "type": "txt",
    "status": "ready"
  }
}

Generate Posts API

POST /api-generate-post

Generate social media posts from your sources

Requires: posts:create

Request Body Parameters

Field	Type	Required	Description
`source_id`	string	Yes*	UUID of source to use
`source_ids`	string[]	Yes*	Array of source UUIDs (alternative to source_id)
`platforms`	string[]	Yes	linkedin, twitter, facebook, instagram, youtube, tiktok, substack, reddit
`prompt`	string	No	Additional instructions for generation
`tone`	string	No	e.g., "professional", "casual", "humorous"
`save_posts`	boolean	No	Save generated posts to library (default: true)
`webhook_url`	string	No	Callback URL when generation completes

* Either source_id or source_ids is required

Example Request

curl -X POST "https://api.promptoutput.ai/api-generate-post" \
  -H "Authorization: Bearer YOUR_ANON_KEY" \
  -H "X-API-Key: pk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "source_id": "550e8400-e29b-41d4-a716-446655440000",
    "platforms": ["linkedin", "twitter"],
    "tone": "professional",
    "prompt": "Focus on the AI automation benefits"
  }'

Response

{
  "success": true,
  "data": {
    "posts": [
      {
        "platform": "linkedin",
        "content": "Excited to share our latest innovation...",
        "post_id": "660e8400-e29b-41d4-a716-446655440001"
      },
      {
        "platform": "twitter",
        "content": "AI is transforming how we create content...",
        "post_id": "660e8400-e29b-41d4-a716-446655440002"
      }
    ],
    "source_ids": ["550e8400-e29b-41d4-a716-446655440000"]
  }
}

Webhooks

Receive real-time notifications when events occur in your account. Webhooks allow external services to be notified instantly.

Creating a Webhook:

Go to Webhooks tab
Click Add Webhook
Enter your HTTPS endpoint URL
Select which events to subscribe to
Click Add Webhook

Available Events:

source.readySource finished processing successfully

source.failedSource processing failed

post.generatedPost was generated from a source

post.publishedPost was published to social media

Available Buttons:

Add Webhook

Opens dialog to add new webhook

Toggle Switch

Enable/disable webhook

Delete (trash icon)

Remove webhook endpoint

Note: Webhooks must use HTTPS. Internal/private network URLs are blocked for security.

Webhook Payloads

When events occur, webhooks receive JSON payloads with event details.

source.ready

Triggered when a source finishes processing successfully

source.failed

Triggered when a source fails to process

post.generated

Triggered when posts are generated from a source

post.published

Triggered when a post is published to social media

Example Webhook Payload

{
  "event": "source.ready",
  "source_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Product Launch Notes",
  "type": "txt",
  "timestamp": "2024-01-15T10:30:00Z"
}

API Error Codes

Common error responses and their meanings when working with the API.

Code	Status	Description
400	Bad Request	Invalid request body or missing required fields
401	Unauthorized	Missing or invalid API key
403	Forbidden	API key lacks required permissions
404	Not Found	Source or resource not found
429	Rate Limited	Too many requests, try again later
500	Server Error	Internal server error

Integration Templates

Ready-to-use configuration templates for popular automation platforms.

🔧

n8n Workflow

Open-source automation tool with HTTP Request node

Copy Template - Copies JSON configuration to clipboard

⚡

Zapier Zap

Connect 5,000+ apps using Webhooks by Zapier

Open Zapier - Opens Zapier webhooks integration page

🔄

Make.com Scenario

Visual workflow builder with HTTP module

Open Make.com - Opens Make.com HTTP integration page

Full API Documentation

Complete API reference with examples for upload sources and generate posts endpoints.

Opens comprehensive API docs page

Request Logs

View the last 50 API requests made to your account. Useful for debugging and monitoring.

Information Displayed:

Timestamp - When the request was made

Endpoint - API endpoint called

Method - HTTP method (POST, GET, etc.)

Status - Success, Client Error, Server Error

Duration - Response time in milliseconds

Error - Error message if applicable

Tip: Use request logs to troubleshoot failed API calls and monitor usage patterns.

Integration Marketplace

Browse and connect to third-party services organized by category.

CRM

HubSpot, Salesforce, Pipedrive, Zoho

Email Marketing

Mailchimp, ConvertKit, ActiveCampaign

Helpdesk

Zendesk, Intercom, Freshdesk

Analytics

Google Analytics, Mixpanel

Storage

Dropbox, Google Drive

E-commerce

Shopify, WooCommerce, BigCommerce

Messaging

Slack, Microsoft Teams

Custom

Webhooks, Custom integrations

Available Buttons:

Add Integration

Add custom integration to marketplace

Details

View integration info and available actions

Connect

Start OAuth or API key connection flow

Adding Custom Integrations

Add your own custom integrations to the marketplace for your organization.

Go to Marketplace tab
Click Add Integration
Fill in the form:
- Name - Display name (e.g., "Twitter")
- Slug - Unique identifier (auto-formatted, lowercase)
- Description - What the integration does
- Category - CRM, Analytics, E-commerce, etc.
- Auth Type - OAuth 2.0, API Key, Basic Auth, Webhook, None
- Icon URL - Link to integration icon
- Website URL - Integration website
- API Base URL - Base URL for API calls
- Beta/Premium - Toggle badges for the integration
Click Add Integration

Managing Connected Integrations

View and manage all your active integration connections.

View Status

Connected, Error, or Expired indicators

Refresh Token

Renew expired OAuth tokens

View Details

Account info and last sync time

Disconnect

Remove integration connection

Available Buttons:

Browse Marketplace

Switches to Marketplace tab (shown when no connections)

Refresh

Refresh expired OAuth token

Disconnect (trash icon)

Remove the integration connection

Automations Tab

Build automated workflows that connect triggers from one integration to actions in another. This requires at least one connected integration with available triggers and actions.

Creating an Automation:

First, connect integrations from the Marketplace
Go to Automations tab
Click Create Automation
Enter a name and optional description
Select a Trigger - "When this happens..."
Select an Action - "Do this..."
Configure action parameters if needed
Click Create Automation

Available Buttons:

Create Automation

Opens dialog to create trigger→action workflow

Toggle Switch

Pause/activate automation

Run Now (from menu)

Manually trigger the automation

Delete (from menu)

Remove the automation

Automations vs Automation Rules

Important Distinction

These are two different features that serve different purposes. Understanding the difference helps you choose the right tool.

Automations Tab

Located in API & Integrations page. For connecting external integrations.

Purpose: Cross-platform integration workflows

Triggers: From connected integrations (Salesforce, HubSpot, etc.)

Actions: Actions from connected integrations

Example: "When new lead in Salesforce → Create post"

Automation Rules

Separate menu item. For reacting to social media events.

Purpose: Social media engagement automation

Triggers: High engagement, sentiment, keywords, mentions

Actions: Notifications, tasks, auto-reply, tagging

Example: "When post gets 1000 likes → Slack notification"

Quick Reference:

Feature	Automations (Integrations)	Automation Rules
Location	API & Integrations → Automations tab	Separate menu item
Scope	External integrations	Social media events
Use When	Connecting CRM, helpdesk, etc.	Responding to engagement
Requires	Connected integrations	No external connections

Your Integration Hub

Page Tabs Overview

API Keys

API Authentication

Upload Sources API

Request Body Parameters

Example: Upload Text

Example: Upload URL

Example: Upload YouTube Video

Example: Upload File

Response

Generate Posts API

Request Body Parameters

Example Request

Response

Webhooks

Webhook Payloads

source.ready

source.failed

post.generated

post.published

Example Webhook Payload

API Error Codes

Integration Templates

Request Logs

Integration Marketplace

Adding Custom Integrations

Managing Connected Integrations

Automations Tab

Automations vs Automation Rules

Automations Tab

Automation Rules

On this page

Related Articles