Projects

Project context management for content generation

Get all projects for the authenticated user

get

Retrieves all active projects owned by the authenticated user. Projects are returned in descending order by last update time.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

List of user's projects

application/json
get
/projects

Create a new project

post

Creates a new project for the authenticated user. Projects can be referenced when generating tweets/threads to provide context.

If a URL is provided without a description, the API will:

  1. Fetch the website content

  2. Use AI to generate a comprehensive project description in markdown format

Either description or url must be provided.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequired

Name of the project (max 200 characters)

Example: AI Startup Launch
descriptionstringOptional

Detailed description of the project. Either description or url must be provided.

Example: Building an AI-powered SaaS tool for content creators. Focus on automation, efficiency, and user experience.
urlstringOptional

Optional URL to fetch website content for auto-generating description. If provided without a description, AI will generate one.

Example: https://example.com
imageDatastringOptional

Optional base64 encoded PNG/JPG representing the project's brand image. Any dimensions are acceptedโ€”the API resizes it to 200x50 and flattens transparency onto a white background before storing the hosted copy as imageUrl.

imageUrlstring ยท uriOptional

Optional HTTP/HTTPS URL to an existing PNG or JPG brand image. The API downloads the source, resizes it to 200x50, flattens transparency onto a white background, and hosts the optimized copy. Cannot be combined with imageData.

textColorstringOptional

Optional hex color (format

Example: #111827Pattern: ^#[0-9A-Fa-f]{6}$
backgroundColorstringOptional

Optional hex color (format

Example: #F9FAFBPattern: ^#[0-9A-Fa-f]{6}$
brandColorstringOptional

Optional primary accent hex color (format

Example: #4338CAPattern: ^#[0-9A-Fa-f]{6}$
accentColorstringOptional

Optional secondary accent hex color (format

Example: #7C72EFPattern: ^#[0-9A-Fa-f]{6}$
Responses
post
/projects

Get a specific project by ID

get

Retrieves a specific project by its ID. Only the project owner can access their projects.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Project ID (GUID)

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
chevron-right
200

Project details

application/json
get
/projects/{id}

Update a project

post

Updates an existing project's name and description. Only the project owner can update their projects.

If a URL is provided without a description, the API will:

  1. Fetch the website content

  2. Use AI to generate a comprehensive project description in markdown format

Either description or url must be provided.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Project ID (GUID)

Example: 123e4567-e89b-12d3-a456-426614174000
Body
namestringRequired

Updated name of the project (max 200 characters)

Example: AI SaaS Platform
descriptionstringOptional

Updated description of the project. Either description or url must be provided.

Example: Revolutionary AI-powered content creation platform with advanced automation features.
urlstringOptional

Optional URL to fetch website content for auto-generating description. If provided without a description, AI will generate one.

Example: https://example.com
imageDatastring ยท nullableOptional

Optional base64 encoded PNG/JPG. Provide null to remove the current brand image. Any size is accepted and will be resized to 200x50 and flattened onto a white background on upload.

imageUrlstring ยท uri ยท nullableOptional

Optional HTTP/HTTPS URL pointing to a PNG or JPG brand image. Provide null to remove the stored image. The API stores a 200x50 white-background version. Cannot be combined with imageData.

textColorstring ยท nullableOptional

Optional hex color (format

Example: #111827Pattern: ^#[0-9A-Fa-f]{6}$
backgroundColorstring ยท nullableOptional

Optional hex color (format

Example: #F9FAFBPattern: ^#[0-9A-Fa-f]{6}$
brandColorstring ยท nullableOptional

Optional primary accent hex color (format

Example: #4338CAPattern: ^#[0-9A-Fa-f]{6}$
accentColorstring ยท nullableOptional

Optional secondary accent hex color (format

Example: #7C72EFPattern: ^#[0-9A-Fa-f]{6}$
Responses
chevron-right
200

Project updated successfully

application/json
post
/projects/{id}/update

Delete a project

post

Soft deletes a project (marks it as inactive). Only the project owner can delete their projects.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Project ID (GUID)

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
chevron-right
200

Project deleted successfully

application/json
post
/projects/{id}/delete

Last updated