Deepwriter API

Operations related to the Deepwriter platform API.

PreviousDeepwriter MCP

List all projects for a user

get

Retrieves a list of all projects belonging to the authenticated user.

Authorizations

Responses

200

List of projects retrieved successfully

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

GET /api/listProjects HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "projects": [
    {
      "id": "text",
      "title": "text",
      "created_at": "2025-06-12T10:28:36.421Z"
    }
  ]
}

Get details of a specific project

get

Retrieves all details for a specific project that belongs to the authenticated user.

Authorizations

Query parameters

projectIdstringRequired

ID of the project to retrieve

Responses

200

Project details retrieved successfully

application/json

400

Bad Request - Project ID is required

application/json

401

Unauthorized

application/json

403

Forbidden - User does not have access to this project

application/json

404

Project not found

application/json

500

Internal Server Error

application/json

get

GET /api/getProjectDetails?projectId=text HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "project": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "title": "text",
    "author": "text",
    "email": "name@gmail.com",
    "model": "text",
    "outline_text": "text",
    "prompt": "text",
    "style_text": "text",
    "supplemental_info": "text",
    "work_description": "text",
    "work_details": "text",
    "work_vision": "text",
    "created_at": "2025-06-12T10:28:36.421Z",
    "updated_at": "2025-06-12T10:28:36.421Z"
  }
}

Delete a specific project

delete

Permanently deletes a project that belongs to the authenticated user.

Authorizations

Query parameters

projectIdstringRequired

ID of the project to delete

Responses

200

Project deleted successfully

application/json

400

Bad Request - Project ID is required

application/json

401

Unauthorized

application/json

403

Forbidden - User does not have access to this project

application/json

404

Project not found

application/json

500

Internal Server Error

application/json

delete

DELETE /api/deleteProject?projectId=text HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "message": "Project deleted successfully"
}

Get user jobs

get

Retrieves a list of jobs for the authenticated user, optionally filtered by project ID.

Authorizations

Query parameters

projectIdstringOptional

Optional project ID to filter jobs.

Responses

200

List of jobs

application/json

401

Unauthorized - Invalid or missing authentication

application/json

500

Internal Server Error

application/json

get

GET /api/jobs HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "queued",
    "progress": 1,
    "progress_stage": "text",
    "created_at": "2025-06-12T10:28:36.421Z",
    "updated_at": "2025-06-12T10:28:36.421Z"
  }
]

Initiate a new content generation job

post

Creates a new content generation job and queues it for processing. Supports multiple authentication methods and includes subscription validation.

Authorizations

Body

userIdstringRequired

ID of the user initiating the job

projectIdstringRequired

ID of the project to generate content for

Responses

200

Job created successfully

application/json

401

Unauthorized - Invalid or missing authentication

application/json

403

Forbidden - No generations remaining in subscription

application/json

404

Not Found - No active subscription found

application/json

409

Conflict - Another job is already in progress

application/json

500

Internal Server Error

application/json

post

POST /api/generateWork HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "userId": "text",
  "projectId": "text"
}

{
  "message": "Job started successfully",
  "jobId": "text"
}

Create a new project

post

Creates a new project associated with the authenticated user.

Authorizations

Body

newProjectNamestringRequired

The name for the new project.

Responses

200

Project created successfully

application/json

400

Bad Request - Missing or invalid project name

application/json

401

Unauthorized - Invalid or missing authentication

application/json

500

Internal Server Error

application/json

post

POST /api/createProject HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "newProjectName": "text"
}

{
  "id": "text"
}

Update a project's details

patch

Update any number of fields for a project. All fields are optional. Requires projectId as a query parameter.

Authorizations

Query parameters

projectIdstringRequired

ID of the project to update

Body

authorstringOptional

outline_textstringOptional

promptstringOptional

style_textstringOptional

supplemental_infostringOptional

titlestringOptional

work_descriptionstringOptional

work_detailsstringOptional

work_visionstringOptional

Responses

200

Project updated successfully

application/json

400

Bad Request - Invalid project ID or no fields to update

application/json

401

Unauthorized

application/json

403

Forbidden - User does not have access to this project

application/json

404

Project not found

application/json

500

Internal Server Error

application/json

patch

PATCH /api/updateProject?projectId=text HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "author": "text",
  "outline_text": "text",
  "prompt": "text",
  "style_text": "text",
  "supplemental_info": "text",
  "title": "text",
  "work_description": "text",
  "work_details": "text",
  "work_vision": "text"
}

{
  "id": "text"
}