API Endpoints

Browse all available Scribe API endpoints below. Each endpoint includes request/response schemas, parameters, and example payloads.

v1.0.0

Scribe API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

API for XC AI Content Automation platform

Servers

https://api.scribe.thextracode.comProduction

https://demoapi.scribe.thextracode.comDemo

http://localhost:8000Local development

---

auth

Authentication — login, token refresh, 2FA verification

Operations

POST/api/v1/auth/loginPOST/api/v1/auth/refreshPOST/api/v1/auth/googlePOST/api/v1/auth/apple

---

Authenticate user credentials

POST

/api/v1/auth/login

Validate email and password, returning a JWT access token on success. If the user has 2FA enabled, returns a temporary token and triggers the 2FA verification flow instead.

Request Body

application/json

{

"email": "string",

"password": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"access_token": "string",

"token_type": "bearer",

"two_factor_required": false,

"two_factor_setup_required": false,

"two_factor_method": "string",

"temp_token": "string"

}

POST

/api/v1/auth/login

Playground

Server

Body

Samples

---

Refresh access token

POST

/api/v1/auth/refresh

Return a new JWT access token for the currently authenticated user.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

{

"access_token": "string",

"token_type": "bearer"

}

POST

/api/v1/auth/refresh

Playground

Server

Authorization

HTTPBearer

Samples

---

Sign in with Google

POST

/api/v1/auth/google

Verify a Google ID token and return a JWT access token. Links to existing account if email matches, or creates new account.

Request Body

application/json

{

"credential": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"access_token": "string",

"token_type": "bearer",

"two_factor_required": false,

"two_factor_setup_required": false,

"two_factor_method": "string",

"temp_token": "string"

}

POST

/api/v1/auth/google

Playground

Server

Body

Samples

---

Sign in with Apple

POST

/api/v1/auth/apple

Verify an Apple ID token and return a JWT access token. Links to existing account if email matches, or creates new account.

Request Body

application/json

{

"id_token": "string",

"first_name": null,

"last_name": null

}

Responses

Successful Response

Content-Type

application/json

{

"access_token": "string",

"token_type": "bearer",

"two_factor_required": false,

"two_factor_setup_required": false,

"two_factor_method": "string",

"temp_token": "string"

}

POST

/api/v1/auth/apple

Playground

Server

Body

Samples

---

two-factor

Two-factor authentication setup and management

Operations

POST/api/v1/auth/2fa/setupPOST/api/v1/auth/2fa/confirmPOST/api/v1/auth/2fa/send-disable-codePOST/api/v1/auth/2fa/disablePOST/api/v1/auth/verify-2faPOST/api/v1/auth/resend-2faPOST/api/v1/auth/2fa/setup-with-tempPOST/api/v1/auth/2fa/confirm-with-temp

---

Begin 2FA setup

POST

/api/v1/auth/2fa/setup

Initiate two-factor authentication setup for the current user. For TOTP, returns a secret and otpauth URI; for email, sends a verification code.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

{

"method": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"method": "string",

"secret": "string",

"otpauth_uri": "string",

"message": "string"

}

POST

/api/v1/auth/2fa/setup

Playground

Server

Authorization

HTTPBearer

Body

Samples

---

Confirm 2FA setup

POST

/api/v1/auth/2fa/confirm

Confirm two-factor authentication setup by verifying a code from the chosen method. Returns a set of one-time backup codes on success.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

{

"code": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"backup_codes": [

"string"

],

"message": "string"

}

POST

/api/v1/auth/2fa/confirm

Playground

Server

Authorization

HTTPBearer

Body

Samples

---

Send 2FA disable code

POST

/api/v1/auth/2fa/send-disable-code

Send an email OTP code to the current user for the purpose of disabling 2FA. Only applicable when the 2FA method is email.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

[

]

POST

/api/v1/auth/2fa/send-disable-code

Playground

Server

Authorization

HTTPBearer

Samples

---

Disable two-factor authentication

POST

/api/v1/auth/2fa/disable

Disable 2FA for the current user after verifying a valid OTP or backup code. Blocked if the organization enforces 2FA.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

{

"code": "string"

}

Responses

Successful Response

Content-Type

application/json

[

]

POST

/api/v1/auth/2fa/disable

Playground

Server

Authorization

HTTPBearer

Body

Samples

---

Verify 2FA login code

POST

/api/v1/auth/verify-2fa

Complete the second step of login by verifying a TOTP, email OTP, or backup code. Returns a full JWT access token on success.

Request Body

application/json

{

"temp_token": "string",

"code": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"access_token": "string",

"token_type": "bearer",

"two_factor_required": false,

"two_factor_setup_required": false,

"two_factor_method": "string",

"temp_token": "string"

}

POST

/api/v1/auth/verify-2fa

Playground

Server

Body

Samples

---

Resend 2FA email code

POST

/api/v1/auth/resend-2fa

Resend the email OTP code during the login 2FA verification step. Only works for users with the email 2FA method.

Request Body

application/json

{

"temp_token": "string"

}

Responses

Successful Response

Content-Type

application/json

[

]

POST

/api/v1/auth/resend-2fa

Playground

Server

Body

Samples

---

Begin 2FA setup via temp token

POST

/api/v1/auth/2fa/setup-with-temp

Initiate two-factor authentication setup using a temporary token, intended for organization-enforced 2FA setup during login.

Request Body

application/json

{

"temp_token": "string",

"method": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"method": "string",

"secret": "string",

"otpauth_uri": "string",

"message": "string"

}

POST

/api/v1/auth/2fa/setup-with-temp

Playground

Server

Body

Samples

---

Confirm 2FA setup via temp token

POST

/api/v1/auth/2fa/confirm-with-temp

Confirm two-factor authentication setup using a temporary token by verifying a code. Returns backup codes on success.

Request Body

application/json

{

"temp_token": "string",

"code": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"backup_codes": [

"string"

],

"message": "string"

}

POST

/api/v1/auth/2fa/confirm-with-temp

Playground

Server

Body

Samples

---

users

User management within your organization

Operations

GET/api/v1/usersPOST/api/v1/usersGET/api/v1/users/mePATCH/api/v1/users/meDELETE/api/v1/users/{user_id}PATCH/api/v1/users/{user_id}POST/api/v1/users/{user_id}/2fa/resetPOST/api/v1/users/{user_id}/2fa/disableGET/api/v1/users/me/email-preferencesPATCH/api/v1/users/me/email-preferences

---

List organization users

GET

/api/v1/users

Returns all users belonging to the admin's organization.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

[

{

"id": "string",

"email": "string",

"first_name": "string",

"last_name": "string",

"phone_number": "string",

"role": "string",

"is_active": true,

"is_super_admin": false,

"two_factor_enabled": false,

"two_factor_method": "string",

"created_at": "string",

"last_login_at": "string",

"organization": {

"id": "string",

"name": "string",

"slug": "string",

"settings": {

},

"address": "string",

"phone_number": "string",

"tax_id": "string",

"billing_email": "string",

"byok_enabled": false,

"has_anthropic_key": false,

"has_deepseek_key": false,

"has_google_key": false,

"enforce_2fa": false,

"created_at": "string"

}

}

]

GET

/api/v1/users

Playground

Server

Authorization

HTTPBearer

Samples

---

Create a new user

POST

/api/v1/users

Creates a new user in the admin's organization and sends a welcome email with credentials.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

{

"email": "string",

"password": "string",

"role": "member"

}

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"email": "string",

"first_name": "string",

"last_name": "string",

"phone_number": "string",

"role": "string",

"is_active": true,

"is_super_admin": false,

"two_factor_enabled": false,

"two_factor_method": "string",

"created_at": "string",

"last_login_at": "string",

"organization": {

"id": "string",

"name": "string",

"slug": "string",

"settings": {

},

"address": "string",

"phone_number": "string",

"tax_id": "string",

"billing_email": "string",

"byok_enabled": false,

"has_anthropic_key": false,

"has_deepseek_key": false,

"has_google_key": false,

"enforce_2fa": false,

"created_at": "string"

}

}

POST

/api/v1/users

Playground

Server

Authorization

HTTPBearer

Body

Samples

---

Get current user profile

GET

/api/v1/users/me

Returns the profile of the currently authenticated user.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"email": "string",

"first_name": "string",

"last_name": "string",

"phone_number": "string",

"role": "string",

"is_active": true,

"is_super_admin": false,

"two_factor_enabled": false,

"two_factor_method": "string",

"created_at": "string",

"last_login_at": "string",

"organization": {

"id": "string",

"name": "string",

"slug": "string",

"settings": {

},

"address": "string",

"phone_number": "string",

"tax_id": "string",

"billing_email": "string",

"byok_enabled": false,

"has_anthropic_key": false,

"has_deepseek_key": false,

"has_google_key": false,

"enforce_2fa": false,

"created_at": "string"

}

}

GET

/api/v1/users/me

Playground

Server

Authorization

HTTPBearer

Samples

---

Update current user profile

PATCH

/api/v1/users/me

Updates the authenticated user's own profile fields such as name, phone number, or password.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

{

"email": "string",

"first_name": "string",

"last_name": "string",

"phone_number": "string",

"password": "string",

"role": "string",

"is_active": true

}

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"email": "string",

"first_name": "string",

"last_name": "string",

"phone_number": "string",

"role": "string",

"is_active": true,

"is_super_admin": false,

"two_factor_enabled": false,

"two_factor_method": "string",

"created_at": "string",

"last_login_at": "string",

"organization": {

"id": "string",

"name": "string",

"slug": "string",

"settings": {

},

"address": "string",

"phone_number": "string",

"tax_id": "string",

"billing_email": "string",

"byok_enabled": false,

"has_anthropic_key": false,

"has_deepseek_key": false,

"has_google_key": false,

"enforce_2fa": false,

"created_at": "string"

}

}

PATCH

/api/v1/users/me

Playground

Server

Authorization

HTTPBearer

Body

Samples

---

Deactivate a user

DELETE

/api/v1/users/{user_id}

Soft-deletes a user by setting their active status to false.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

user_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

DELETE

/api/v1/users/{user_id}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

user_id*

Samples

---

Update a user

PATCH

/api/v1/users/{user_id}

Allows an admin to update any user's profile within their organization.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

user_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

"email": "string",

"first_name": "string",

"last_name": "string",

"phone_number": "string",

"password": "string",

"role": "string",

"is_active": true

}

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"email": "string",

"first_name": "string",

"last_name": "string",

"phone_number": "string",

"role": "string",

"is_active": true,

"is_super_admin": false,

"two_factor_enabled": false,

"two_factor_method": "string",

"created_at": "string",

"last_login_at": "string",

"organization": {

"id": "string",

"name": "string",

"slug": "string",

"settings": {

},

"address": "string",

"phone_number": "string",

"tax_id": "string",

"billing_email": "string",

"byok_enabled": false,

"has_anthropic_key": false,

"has_deepseek_key": false,

"has_google_key": false,

"enforce_2fa": false,

"created_at": "string"

}

}

PATCH

/api/v1/users/{user_id}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

user_id*

Body

Samples

---

Reset user 2FA

POST

/api/v1/users/{user_id}/2fa/reset

Clears a user's 2FA secret and backup codes, forcing re-setup on next login.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

user_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

[

]

POST

/api/v1/users/{user_id}/2fa/reset

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

user_id*

Samples

---

Disable user 2FA

POST

/api/v1/users/{user_id}/2fa/disable

Temporarily disables a user's 2FA check while preserving their secret for re-enabling later.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

user_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

[

]

POST

/api/v1/users/{user_id}/2fa/disable

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

user_id*

Samples

---

Get email notification preferences

GET

/api/v1/users/me/email-preferences

Returns the current user's email notification preferences.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

{

"usage_billing": true,

"ai_studio": true,

"system_alerts": true

}

GET

/api/v1/users/me/email-preferences

Playground

Server

Authorization

HTTPBearer

Samples

---

Update email notification preferences

PATCH

/api/v1/users/me/email-preferences

Updates the current user's email notification preferences.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

{

"usage_billing": null,

"ai_studio": null,

"system_alerts": null

}

Responses

Successful Response

Content-Type

application/json

{

"usage_billing": true,

"ai_studio": true,

"system_alerts": true

}

PATCH

/api/v1/users/me/email-preferences

Playground

Server

Authorization

HTTPBearer

Body

Samples

---

organization

Organization settings, API keys, and preferences

Operations

GET/api/v1/organizationPATCH/api/v1/organizationPATCH/api/v1/organization/api-keysGET/api/v1/organization/tonesPOST/api/v1/organization/tonesDELETE/api/v1/organization/tones/{tone_id}

---

Get current organization

GET

/api/v1/organization

Retrieve the organization details associated with the currently authenticated user.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"name": "string",

"slug": "string",

"settings": {

},

"address": "string",

"phone_number": "string",

"tax_id": "string",

"billing_email": "string",

"byok_enabled": false,

"has_anthropic_key": false,

"has_deepseek_key": false,

"has_google_key": false,

"enforce_2fa": false,

"created_at": "string"

}

GET

/api/v1/organization

Playground

Server

Authorization

HTTPBearer

Samples

---

Update organization details

PATCH

/api/v1/organization

Update the organization's name, settings, address, phone number, tax ID, billing email, or 2FA enforcement. Requires admin privileges.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

{

"name": "string",

"settings": {

},

"address": "string",

"phone_number": "string",

"tax_id": "string",

"billing_email": "string",

"enforce_2fa": true

}

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"name": "string",

"slug": "string",

"settings": {

},

"address": "string",

"phone_number": "string",

"tax_id": "string",

"billing_email": "string",

"byok_enabled": false,

"has_anthropic_key": false,

"has_deepseek_key": false,

"has_google_key": false,

"enforce_2fa": false,

"created_at": "string"

}

PATCH

/api/v1/organization

Playground

Server

Authorization

HTTPBearer

Body

Samples

---

Update organization API keys

PATCH

/api/v1/organization/api-keys

Update the organization's third-party API keys for Anthropic, DeepSeek, or Google. Requires admin privileges and BYOK to be enabled.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

{

"anthropic_api_key": "string",

"deepseek_api_key": "string",

"google_api_key": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"name": "string",

"slug": "string",

"settings": {

},

"address": "string",

"phone_number": "string",

"tax_id": "string",

"billing_email": "string",

"byok_enabled": false,

"has_anthropic_key": false,

"has_deepseek_key": false,

"has_google_key": false,

"enforce_2fa": false,

"created_at": "string"

}

PATCH

/api/v1/organization/api-keys

Playground

Server

Authorization

HTTPBearer

Body

Samples

---

List custom tones

GET

/api/v1/organization/tones

Retrieve all custom tones configured for the current user's organization.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

[

{

"id": "string",

"name": "string",

"description": "string",

"system_prompt": "string"

}

]

GET

/api/v1/organization/tones

Playground

Server

Authorization

HTTPBearer

Samples

---

Create custom tone

POST

/api/v1/organization/tones

Create a new custom tone for the organization. Requires admin privileges. Fails if a tone with the same ID already exists.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

{

"id": "string",

"name": "string",

"description": "string",

"system_prompt": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"name": "string",

"description": "string",

"system_prompt": "string"

}

POST

/api/v1/organization/tones

Playground

Server

Authorization

HTTPBearer

Body

Samples

---

Delete custom tone

DELETE

/api/v1/organization/tones/{tone_id}

Delete a custom tone by its ID from the organization. Requires admin privileges. Returns 404 if the tone is not found.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

tone_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

[

]

DELETE

/api/v1/organization/tones/{tone_id}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

tone_id*

Samples

---

system

System configuration — languages, tones, platforms, AI providers

Operations

GET/api/v1/system/providersGET/api/v1/system/platformsGET/api/v1/system/content-typesGET/api/v1/system/languagesGET/api/v1/system/tones

---

List AI providers

GET

/api/v1/system/providers

Returns all registered AI providers and their available models.

Responses

Successful Response

Content-Type

application/json

[

]

GET

/api/v1/system/providers

Playground

Samples

---

List e-commerce platforms

GET

/api/v1/system/platforms

Returns the supported e-commerce platforms (e.g., Magento, WooCommerce, Shopify).

Responses

Successful Response

Content-Type

application/json

[

]

GET

/api/v1/system/platforms

Playground

Samples

---

List content types

GET

/api/v1/system/content-types

Returns the available content item types (e.g., product, category).

Responses

Successful Response

Content-Type

application/json

[

]

GET

/api/v1/system/content-types

Playground

Samples

---

List supported languages

GET

/api/v1/system/languages

Returns the available output languages for content generation.

Responses

Successful Response

Content-Type

application/json

[

]

GET

/api/v1/system/languages

Playground

Samples

---

List writing tones

GET

/api/v1/system/tones

Returns built-in writing tones plus any custom tones defined in the authenticated user's organization settings.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

[

]

GET

/api/v1/system/tones

Playground

Server

Authorization

HTTPBearer

Samples

---

projects

Project lifecycle — create, list, update, delete

Operations

GET/api/v1/projectsPOST/api/v1/projectsGET/api/v1/projects/{project_id}DELETE/api/v1/projects/{project_id}PATCH/api/v1/projects/{project_id}POST/api/v1/projects/{project_id}/restoreDELETE/api/v1/projects/{project_id}/permanent

---

List all projects

GET

/api/v1/projects

Retrieve all projects for the current user's organization. Supports filtering to show only active or only deleted (trashed) projects.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Query Parameters

include_deleted

Type

boolean

Default

false

Responses

Successful Response

Content-Type

application/json

[

{

"id": "string",

"name": "string",

"platform": "string",

"status": "string",

"settings": {

},

"created_at": "string",

"completed_at": "string",

"item_count": 0,

"flagged_count": 0,

"source_count": 0,

"deleted_at": "string",

"status_counts": {

"pending": 0,

"generated": 0,

"flagged": 0,

"approved": 0,

"rejected": 0,

"synced": 0

},

"store_connection_id": "string",

"store_connection_name": "string"

}

]

GET

/api/v1/projects

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

include_deleted

Samples

---

Create a new project

POST

/api/v1/projects

Create a new content project by providing a name and selecting a target platform. The project is initialized in draft status.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/x-www-form-urlencoded

object

Valid values"woocommerce""shopify""magento2"

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"name": "string",

"platform": "string",

"status": "string",

"settings": {

},

"created_at": "string",

"completed_at": "string",

"item_count": 0,

"flagged_count": 0,

"source_count": 0,

"deleted_at": "string",

"status_counts": {

"pending": 0,

"generated": 0,

"flagged": 0,

"approved": 0,

"rejected": 0,

"synced": 0

},

"store_connection_id": "string",

"store_connection_name": "string"

}

POST

/api/v1/projects

Playground

Server

Authorization

HTTPBearer

Body

name*

platform*

Samples

---

Get project details

GET

/api/v1/projects/{project_id}

Retrieve a single project by ID, including computed item counts and status breakdowns.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"name": "string",

"platform": "string",

"status": "string",

"settings": {

},

"created_at": "string",

"completed_at": "string",

"item_count": 0,

"flagged_count": 0,

"source_count": 0,

"deleted_at": "string",

"status_counts": {

"pending": 0,

"generated": 0,

"flagged": 0,

"approved": 0,

"rejected": 0,

"synced": 0

},

"store_connection_id": "string",

"store_connection_name": "string"

}

GET

/api/v1/projects/{project_id}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Samples

---

Soft-delete a project

DELETE

/api/v1/projects/{project_id}

Move a project to the trash by setting its deleted timestamp. The project can be restored later.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

DELETE

/api/v1/projects/{project_id}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Samples

---

Update a project

PATCH

/api/v1/projects/{project_id}

Partially update a project's name, settings, or store connection. Only provided fields are modified.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

"name": "string",

"settings": {

},

"store_connection_id": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"name": "string",

"platform": "string",

"status": "string",

"settings": {

},

"created_at": "string",

"completed_at": "string",

"item_count": 0,

"flagged_count": 0,

"source_count": 0,

"deleted_at": "string",

"status_counts": {

"pending": 0,

"generated": 0,

"flagged": 0,

"approved": 0,

"rejected": 0,

"synced": 0

},

"store_connection_id": "string",

"store_connection_name": "string"

}

PATCH

/api/v1/projects/{project_id}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Body

Samples

---

Restore a deleted project

POST

/api/v1/projects/{project_id}/restore

Restore a previously soft-deleted project from the trash, clearing its deleted timestamp.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"name": "string",

"platform": "string",

"status": "string",

"settings": {

},

"created_at": "string",

"completed_at": "string",

"item_count": 0,

"flagged_count": 0,

"source_count": 0,

"deleted_at": "string",

"status_counts": {

"pending": 0,

"generated": 0,

"flagged": 0,

"approved": 0,

"rejected": 0,

"synced": 0

},

"store_connection_id": "string",

"store_connection_name": "string"

}

POST

/api/v1/projects/{project_id}/restore

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Samples

---

Permanently delete a project

DELETE

/api/v1/projects/{project_id}/permanent

Permanently remove a soft-deleted project and all its associated data. This action cannot be undone.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

DELETE

/api/v1/projects/{project_id}/permanent

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Samples

---

content

Content generation, review, approval, and export

Operations

POST/api/v1/projects/{project_id}/generatePOST/api/v1/projects/{project_id}/generate/streamPOST/api/v1/projects/{project_id}/regenerate/streamPOST/api/v1/projects/{project_id}/regenerate-rejected/streamPOST/api/v1/projects/{project_id}/regeneratePOST/api/v1/projects/{project_id}/regenerate-rejectedGET/api/v1/projects/{project_id}/itemsPATCH/api/v1/projects/{project_id}/items/batchPATCH/api/v1/projects/{project_id}/items/{item_id}POST/api/v1/projects/{project_id}/items/{item_id}/regenerateGET/api/v1/projects/{project_id}/export

---

Generate content for items

POST

/api/v1/projects/{project_id}/generate

Generates AI content for all pending non-variant items in the project using the specified provider, model, and AI settings. Records token usage and deducts XCT balance.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

"content_type": "string",

"content_variant": "short",

"language": "en",

"tone": "professional",

"ai_provider": "anthropic",

"ai_model": "string",

"custom_instructions": "string",

"max_short_chars": 200,

"max_long_chars": 1000,

"translate_name": true,

"use_html": true,

"generate_short": true,

"generate_long": true,

"item_ids": [

"string"

]

}

Responses

Successful Response

Content-Type

application/json

[

]

POST

/api/v1/projects/{project_id}/generate

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Body

Samples

---

Stream content generation progress

POST

/api/v1/projects/{project_id}/generate/stream

Generates AI content for pending or selected items via SSE streaming, sending real-time progress events. Uses the specified provider, model, and AI settings.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

"content_type": "string",

"content_variant": "short",

"language": "en",

"tone": "professional",

"ai_provider": "anthropic",

"ai_model": "string",

"custom_instructions": "string",

"max_short_chars": 200,

"max_long_chars": 1000,

"translate_name": true,

"use_html": true,

"generate_short": true,

"generate_long": true,

"item_ids": [

"string"

]

}

Responses

Successful Response

Content-Type

application/json

[

]

POST

/api/v1/projects/{project_id}/generate/stream

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Body

Samples

---

Stream full regeneration progress

POST

/api/v1/projects/{project_id}/regenerate/stream

Resets all items to pending and streams AI content regeneration progress via SSE using the specified provider, model, and AI settings.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

"content_type": "string",

"content_variant": "short",

"language": "en",

"tone": "professional",

"ai_provider": "anthropic",

"ai_model": "string",

"custom_instructions": "string",

"max_short_chars": 200,

"max_long_chars": 1000,

"translate_name": true,

"use_html": true,

"generate_short": true,

"generate_long": true,

"item_ids": [

"string"

]

}

Responses

Successful Response

Content-Type

application/json

[

]

POST

/api/v1/projects/{project_id}/regenerate/stream

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Body

Samples

---

Stream rejected items regeneration

POST

/api/v1/projects/{project_id}/regenerate-rejected/stream

Resets only rejected items to pending and streams AI content regeneration progress via SSE using the specified provider, model, and AI settings.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

"content_type": "string",

"content_variant": "short",

"language": "en",

"tone": "professional",

"ai_provider": "anthropic",

"ai_model": "string",

"custom_instructions": "string",

"max_short_chars": 200,

"max_long_chars": 1000,

"translate_name": true,

"use_html": true,

"generate_short": true,

"generate_long": true,

"item_ids": [

"string"

]

}

Responses

Successful Response

Content-Type

application/json

[

]

POST

/api/v1/projects/{project_id}/regenerate-rejected/stream

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Body

Samples

---

Regenerate all project content

POST

/api/v1/projects/{project_id}/regenerate

Resets all items to pending and regenerates AI content using the specified provider, model, and AI settings. Records token usage and deducts XCT balance.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

"content_type": "string",

"content_variant": "short",

"language": "en",

"tone": "professional",

"ai_provider": "anthropic",

"ai_model": "string",

"custom_instructions": "string",

"max_short_chars": 200,

"max_long_chars": 1000,

"translate_name": true,

"use_html": true,

"generate_short": true,

"generate_long": true,

"item_ids": [

"string"

]

}

Responses

Successful Response

Content-Type

application/json

[

]

POST

/api/v1/projects/{project_id}/regenerate

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Body

Samples

---

Regenerate rejected items only

POST

/api/v1/projects/{project_id}/regenerate-rejected

Resets only rejected items to pending and regenerates AI content using the specified provider, model, and AI settings. Records token usage and deducts XCT balance.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

"content_type": "string",

"content_variant": "short",

"language": "en",

"tone": "professional",

"ai_provider": "anthropic",

"ai_model": "string",

"custom_instructions": "string",

"max_short_chars": 200,

"max_long_chars": 1000,

"translate_name": true,

"use_html": true,

"generate_short": true,

"generate_long": true,

"item_ids": [

"string"

]

}

Responses

Successful Response

Content-Type

application/json

[

]

POST

/api/v1/projects/{project_id}/regenerate-rejected

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Body

Samples

---

List project content items

GET

/api/v1/projects/{project_id}/items

Returns all content items for the project, optionally filtered by status or data source.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Query Parameters

status

Type

string

source_id

Type

string

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

[

{

"id": "string",

"external_id": "string",

"item_type": "string",

"source_data": {

},

"generated_content": {

},

"confidence_score": 0,

"status": "string",

"ai_model_used": "string",

"created_at": "string",

"data_source_id": "string",

"data_source_name": "string"

}

]

GET

/api/v1/projects/{project_id}/items

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

status

source_id

Samples

---

Batch update item statuses

PATCH

/api/v1/projects/{project_id}/items/batch

Updates the status of multiple content items at once within the project.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

"item_ids": [

"string"

],

"status": "string"

}

Responses

Successful Response

Content-Type

application/json

[

{

"id": "string",

"external_id": "string",

"item_type": "string",

"source_data": {

},

"generated_content": {

},

"confidence_score": 0,

"status": "string",

"ai_model_used": "string",

"created_at": "string",

"data_source_id": "string",

"data_source_name": "string"

}

]

PATCH

/api/v1/projects/{project_id}/items/batch

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Body

Samples

---

Update a content item

PATCH

/api/v1/projects/{project_id}/items/{item_id}

Updates the generated content or status of a single content item.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

item_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

"generated_content": {

},

"status": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"external_id": "string",

"item_type": "string",

"source_data": {

},

"generated_content": {

},

"confidence_score": 0,

"status": "string",

"ai_model_used": "string",

"created_at": "string",

"data_source_id": "string",

"data_source_name": "string"

}

PATCH

/api/v1/projects/{project_id}/items/{item_id}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

item_id*

Body

Samples

---

Regenerate a single item

POST

/api/v1/projects/{project_id}/items/{item_id}/regenerate

Regenerates AI content for a single content item using the specified provider, model, and AI settings.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

item_id*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

"content_type": "string",

"content_variant": "short",

"language": "en",

"tone": "professional",

"ai_provider": "anthropic",

"ai_model": "string",

"custom_instructions": "string",

"max_short_chars": 200,

"max_long_chars": 1000,

"translate_name": true,

"use_html": true,

"generate_short": true,

"generate_long": true,

"item_ids": [

"string"

]

}

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"external_id": "string",

"item_type": "string",

"source_data": {

},

"generated_content": {

},

"confidence_score": 0,

"status": "string",

"ai_model_used": "string",

"created_at": "string",

"data_source_id": "string",

"data_source_name": "string"

}

POST

/api/v1/projects/{project_id}/items/{item_id}/regenerate

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

item_id*

Body

Samples

---

Export project content CSV

GET

/api/v1/projects/{project_id}/export

Exports generated content as a CSV file, with platform-specific formatting for Magento. Supports filtering by status, data source, and search query.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Query Parameters

status_filter

Type

string

Default

"approved"

source_id

Type

string

Format

"uuid"

search

Type

string

Responses

Successful Response

Content-Type

application/json

[

]

GET

/api/v1/projects/{project_id}/export

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

status_filter

source_id

search

Samples

---

usage

Usage records and consumption analytics

Operations

GET/api/v1/usageGET/api/v1/usage/summary

---

List usage records

GET

/api/v1/usage

Returns AI usage records for the organization, optionally filtered by start and end date.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Query Parameters

start_date

Type

string

Format

"date-time"

end_date

Type

string

Format

"date-time"

Responses

Successful Response

Content-Type

application/json

[

{

"id": "string",

"ai_provider": "string",

"ai_model": "string",

"content_type": "string",

"input_tokens": 0,

"output_tokens": 0,

"credits_used": 0,

"cost_estimate": 0,

"created_at": "string"

}

]

GET

/api/v1/usage

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

start_date

end_date

Samples

---

Get usage summary

GET

/api/v1/usage/summary

Aggregates token usage and estimated cost over the specified number of days, broken down by AI provider and content type.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Query Parameters

days

Type

integer

Default

30

Responses

Successful Response

Content-Type

application/json

{

"total_input_tokens": 0,

"total_output_tokens": 0,

"total_cost": 0,

"by_provider": {

},

"by_content_type": {

}

}

GET

/api/v1/usage/summary

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

days

Samples

---

api-keys

API key management for programmatic access

Operations

GET/api/v1/api-keysPOST/api/v1/api-keysDELETE/api/v1/api-keys/{key_id}PATCH/api/v1/api-keys/{key_id}/deactivate

---

List API keys

GET

/api/v1/api-keys

Returns all API keys for the organization, ordered by most recent first. Admin only.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Responses

Successful Response

Content-Type

application/json

[

{

"id": "string",

"name": "string",

"is_active": true,

"last_used_at": "string",

"created_at": "string"

}

]

GET

/api/v1/api-keys

Playground

Server

Authorization

HTTPBearer

Samples

---

Create API key

POST

/api/v1/api-keys

Generates a new API key for the organization. The raw key is returned only once in the response and cannot be retrieved again. Admin only.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Request Body

application/json

{

"name": "string"

}

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"name": "string",

"key": "string",

"created_at": "string"

}

POST

/api/v1/api-keys

Playground

Server

Authorization

HTTPBearer

Body

Samples

---

Delete API key

DELETE

/api/v1/api-keys/{key_id}

Permanently deletes an API key, immediately revoking access for any client using it. Admin only.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

key_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

DELETE

/api/v1/api-keys/{key_id}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

key_id*

Samples

---

Deactivate API key

PATCH

/api/v1/api-keys/{key_id}/deactivate

Deactivates an API key without deleting it, disabling authentication for any client using it. Admin only.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

key_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

{

"id": "string",

"name": "string",

"is_active": true,

"last_used_at": "string",

"created_at": "string"

}

PATCH

/api/v1/api-keys/{key_id}/deactivate

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

key_id*

Samples

---

sources

Data source management — upload CSV/XML, manual entry

Operations

GET/api/v1/projects/{project_id}/sourcesPOST/api/v1/projects/{project_id}/sources/detect-columnsPOST/api/v1/projects/{project_id}/sources/filePOST/api/v1/projects/{project_id}/sources/manualDELETE/api/v1/projects/{project_id}/sources/{source_id}GET/api/v1/projects/{project_id}/sources/{source_id}/export

---

List project data sources

GET

/api/v1/projects/{project_id}/sources

Retrieves all data sources for the specified project, ordered by creation date descending, along with a total item count across all sources.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Responses

Successful Response

Content-Type

application/json

{

"sources": [

{

"id": "string",

"project_id": "string",

"type": "string",

"name": "string",

"config": {

},

"status": "string",

"item_count": 0,

"last_synced_at": "string",

"error_message": "string",

"created_at": "string"

}

],

"total_items": 0

}

GET

/api/v1/projects/{project_id}/sources

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Samples

---

Detect CSV column mappings

POST

/api/v1/projects/{project_id}/sources/detect-columns

Analyzes CSV headers and sample data to auto-detect column mappings for the project's platform.

Authorizations

HTTPBearer

Type

HTTP (bearer)

Parameters

Path Parameters

project_id*

Type

string

Required

Format

"uuid"

Request Body

multipart/form-data

object

Format"binary"

Responses

Successful Response

Content-Type

application/json

[

]

POST

/api/v1/projects/{project_id}/sources/detect-columns

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

project_id*

Body

Samples