SynthAI API Documentation

This document describes the API used by the SynthAI Zapier integration and other API consumers. All endpoints use HTTPS.

Base URL: https://indkkxxhxcrfwraedpze.supabase.co/functions/v1

Authentication

API requests are authenticated using an API key generated in SynthAI (Dashboard → Settings → Integrations → Zapier).

Header name: X-API-Key
Header value: Your API key (no "Bearer" prefix)

Example:

X-API-Key: your-api-key-here

Endpoints

1. Test authentication

Validates the API key and returns the authenticated user.

Method	Path	Description
`GET`	`/zapier-auth`	Verify API key and get user info

Headers: X-API-Key (required)

Response (200): { "user": { "id", "name", "email" }, ... }

Errors: 401 – Invalid or missing API key

2. Zapier API (actions, searches, poll triggers)

Single endpoint for all Zapier actions and searches. The request body specifies the operation by route and payload.

Method	Path	Description
`POST`	`/zapier-api`	Execute an action or search by route

Headers: Content-Type: application/json, X-API-Key (required)

Request body:

{
  "route": "actions/create_lead",
  "payload": { ... }
}

Routes (examples):

Route	Description
`actions/create_lead`	Create a lead
`actions/create_campaign`	Create a campaign
`actions/create_ticket`	Create a support ticket
`actions/create_task`	Create a task
`actions/update_task`	Update a task
`actions/create_social_post`	Create a social post
`actions/schedule_social_post`	Schedule a social post
`actions/send_email`	Send an email
`searches/find_lead`	Find a lead
`searches/find_task`	Find a task
`searches/find_ticket`	Find a ticket
`triggers/new_lead` (poll)	Poll for new leads

Response (200): JSON object with success and data.

Errors: 400 – Invalid route or payload; 401 – Invalid or missing API key; 500 – Server error

3. Webhooks (REST Hook triggers)

Subscribe and unsubscribe from REST Hook triggers.

Method	Path	Description
`POST`	`/zapier-webhooks`	Subscribe or unsubscribe a hook

Subscribe:

{
  "action": "subscribe",
  "trigger_key": "new_lead",
  "target_url": "https://hooks.zapier.com/..."
}

Unsubscribe:

{
  "action": "unsubscribe",
  "subscription_id": "...",
  "target_url": "https://hooks.zapier.com/..."
}

Trigger keys (examples): new_lead, ticket_created, email_sent, social_post_published, task_completed, page_created, video_generated, expense_recorded, campaign_created

Rate limits and errors

Use HTTPS for all requests.
Include X-API-Key on every request.
On error, responses return appropriate HTTP status codes and JSON error details where applicable.

Support

Homepage: https://www.getsynthai.com
API key: Generated in SynthAI Dashboard → Settings → Integrations → Zapier.

Go to SynthAI