Skip to content

Main Navigation Guide API Reference Open XC Scribe

Appearance

Sidebar Navigation

API Reference

Authentication

Endpoints

auth

POST Authenticate user credentials

POST Refresh access token

POST Logout (revoke current token)

POST Logout all sessions

POST Request password reset

POST Reset password with token

GET Verify email address

POST Resend verification email

POST Self-service registration

POST Sign in with Google

POST Sign in with Apple

two-factor

POST Begin 2FA setup

POST Confirm 2FA setup

POST Send 2FA disable code

POST Disable two-factor authentication

POST Verify 2FA login code

POST Resend 2FA email code

POST Begin 2FA setup via temp token

POST Confirm 2FA setup via temp token

users

GET List organization users

POST Create a new user

GET Get current user profile

PATCH Update current user profile

GET Get email notification preferences

PATCH Update email notification preferences

GET Get Chatwoot identity hash

DELETE Deactivate a user

PATCH Update a user

POST Reset user 2FA

POST Disable user 2FA

POST Force logout a user

organization

GET Get current organization

PATCH Update organization details

PATCH Update organization API keys

GET Get billing details

PATCH Update billing details

GET List custom tones

POST Create custom tone

DELETE Delete custom tone

system

GET List AI providers

GET List e-commerce platforms

GET List content types

GET List supported languages

GET List writing tones

projects

GET List plugin integrations

GET List all projects

POST Create a new project

GET Get project details

DELETE Soft-delete a project

PATCH Update a project

POST Restore a deleted project

POST Truncate project data

DELETE Permanently delete a project

content

POST Generate content for items

POST Stream content generation progress

POST Stream full regeneration progress

POST Stream rejected items regeneration

POST Regenerate all project content

POST Regenerate rejected items only

GET List project content items

PATCH Batch update item statuses

POST Exclude items

POST Restore excluded items

PATCH Update a content item

POST Regenerate a single item

GET Export project content CSV

usage

GET List usage records

GET Get usage summary

api-keys

GET List API keys

POST Create API key

DELETE Delete API key

PATCH Deactivate API key

sources

GET List project data sources

POST Detect CSV column mappings

POST Upload file data source

POST Create manual data source

DELETE Delete a data source

GET Export source as CSV

store-connections

GET List store connections

POST Create store connection

GET Get store connection

DELETE Delete store connection

PATCH Update store connection

POST Test store connection

shopify

GET Shopify Install Url

GET Shopify Connect

GET Shopify Callback

POST Shopify Finalize

POST Shopify Uninstalled Webhook

POST Shopify Customers Data Request

POST Shopify Customers Redact

POST Shopify Shop Redact

POST Shopify Compliance Webhook

sync

POST Stream sync to store

POST Sync single item

POST Sync all approved items

GET Get item sync history

jobs

GET List project jobs

POST Create background job

GET Get job status

POST Cancel a job

billing

GET Get XCT balance

GET List XCT transactions

GET Get billing usage summary

GET List model tier pricing

POST Add XCT top-up

GET Get subscription info

PATCH Change subscription tier

POST Reset billing cycle

PATCH Update billing settings

POST Adjust XCT balance

POST Create subscription checkout

POST Create top-up checkout

GET Get customer portal URL

POST Cancel subscription

GET Get payment history

GET Download Dodo invoice PDF

GET Get subscription info (legacy)

POST Create subscription checkout (legacy)

POST Create top-up checkout (legacy)

GET Get customer portal URL (legacy)

POST Self-service plan upgrade

POST Self-service XCT top-up

GET Download invoice PDF

GET List My Invoices

invitations

GET Validate invitation token

POST Accept invitation

GET List invitations

POST Create invitation

POST Resend invitation email

POST Revoke invitation

store-import

GET Get available import filters

POST Preview import count

POST Start store import

blog

GET List blog posts

POST Create blog post

POST Regenerate blog post

GET Get blog post

DELETE Delete blog post

PATCH Update blog post

POST Publish blog post to WordPress

POST Unpublish blog post from WordPress

GET Get SEO score

POST Schedule blog post

POST Unschedule blog post

GET Blog analytics summary

GET List blog post images

POST Add image from stock photo

POST Upload image

POST Generate image with AI

DELETE Delete blog image

GET Search stock photos

GET List stock photo keys

POST Add stock photo key

DELETE Delete stock photo key

PATCH Update stock photo key

blog-connections

GET List blog connections

POST Create blog connection

GET Get blog connection

DELETE Delete blog connection

PATCH Update blog connection

POST Test blog connection

GET Get WordPress categories

GET List Shopify blogs

blog-templates

GET List blog templates

POST Create blog template

GET Get blog template

DELETE Delete blog template

PATCH Update blog template

files

GET Serve file from S3

gdpr

POST Request Data Export

GET Get Gdpr Status

POST Request Account Deletion

notifications

GET Get unread notification count

GET List notifications

POST Mark notification as read

POST Mark all notifications as read

studio-requests

GET List studio requests

POST Submit a new AI Studio quote request

GET Get studio request detail

POST Add a comment to a studio request

paddle-webhooks

POST Handle Paddle Webhook

dodo-webhooks

POST Handle Dodo Webhook

chatbot

POST Chatwoot Webhook

POST Chatwoot Email Webhook

POST Tenant Webhook

plugin

GET Plugin Status

POST Plugin Generate Description

POST Plugin Generate Description Async

POST Plugin Generate Blog

POST Plugin Generate Blog Async

GET Plugin Generation Status

content-profiles

GET List Profiles

POST Create Profile

GET Get Profile

PUT Update Profile

DELETE Delete Profile

PUT Set Default Profile

studio-tools

GET List Studio Tools

studio-store-audit

POST Run Audit

GET List Audits

GET Get Audit

DELETE Delete Audit

POST Create Fix Project

studio-profile-builder

GET List Templates

POST Generate Instructions

tenants

GET List My Tenants

GET Get My Tenant

POST Request Access

GET List Knowledge Sources

POST Add Url Source

DELETE Delete Knowledge Source

POST Trigger Sync

POST Get Upload Url

POST Register Uploaded File

PATCH Link Content Profile

GET Get Custom Attributes

PATCH Update Custom Attributes

POST Link Store

DELETE Unlink Store

PATCH Update Store Settings

GET Get Tenant Analytics

outreach-tracking

GET Track Open

GET Track Click

Default

GET Health Check

List AI providers

GET

/api/v1/system/providers

Returns all registered AI providers and their available models.

Responses

Successful Response

Content-Type

application/json

JSON

[

]

GET

/api/v1/system/providers

Playground

Samples

Powered by VitePress OpenAPI

Pager

Previous page DELETE Delete custom tone

Next page GET List e-commerce platforms

XC AI Content Automation

© 2026 THE XTRACODE