Sign in
latestOpenAPI 3.0.02026-08-1610635191.3 KB

355890b6b4cc

Projects

Create a new project

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.

post/projects

Request body

namestring required

Name of the project (max 200 characters)

descriptionstring

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

urlstring

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

imageDatastring

Optional base64 encoded PNG/JPG representing the project's brand image. The source image must be fully opaque; images containing any fully or partially transparent pixels are rejected. Any dimensions are accepted and the API resizes the image to 200x50 before storing the hosted copy as imageUrl.

imageUrlstring uri

Optional HTTP/HTTPS URL to an existing PNG or JPG brand image. The source image must be fully opaque; images containing any fully or partially transparent pixels are rejected. The API downloads the source, resizes it to 200x50, and hosts the optimized copy. Cannot be combined with imageData.

textColorstring

Optional hex color (format

backgroundColorstring

Optional hex color (format

brandColorstring

Optional primary accent hex color (format

accentColorstring

Optional secondary accent hex color (format

Example request

{
  "name": "AI Startup Launch",
  "description": "Building an AI-powered SaaS tool for content creators. Focus on automation, efficiency, and user experience.",
  "url": "https://example.com",
  "textColor": "#111827",
  "backgroundColor": "#F9FAFB",
  "brandColor": "#4338CA",
  "accentColor": "#7C72EF"
}

Response

Project created successfully

successboolean

Example response

{
  "success": true,
  "project": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "AI Startup Launch",
    "description": "Building an AI-powered SaaS tool for content creators. Focus on automation, efficiency, and user experience.",
    "url": "https://example.com",
    "token": "abc123-def456-ghi789",
    "createdOn": "2024-01-01T12:00:00Z",
    "updatedOn": "2024-01-02T14:30:00Z",
    "active": true,
    "textColor": "#111827",
    "backgroundColor": "#F9FAFB",
    "brandColor": "#4338CA",
    "accentColor": "#7C72EF"
  }
}