JAjasper
Documents

Create document

Changed on

Create a new document in your workspace

post/v1/documents

Request

  • Base URL
    https://api.jasper.ai
  • URL
    https://api.jasper.ai/v1/documents
  • Auth
    • API key in header X-API-Key
    • or OAuth 2
      Authorization code: https://api.jasper.ai/oauth2/authorize
      Token URL: https://api.jasper.ai/oauth2/token scopes: user

Request body

userIdstring required

The ID of the user creating the document

contentstring required

The content of the document

namestring required

The name of the document

status'DRAFT' | 'PUBLISHED' | 'IN PROGRESS' | 'IN REVIEW' | 'COMPLETED'

The status of the document

projectIdstring

The ID of the project to associate the document with. When provided, the document is attached to the project so it appears under that project in Jasper.

Example request

{
  "userId": "user123",
  "content": "This is the content of the document.",
  "name": "Document Title",
  "status": "DRAFT",
  "projectId": "prj_E8F0457A95B04D87A11F6B1DD6AA2356"
}

Response

Created. The new document was added successfully.

requestIdstring
resourcestring

Example response

{
  "requestId": "bce766ea-a4ef-48e5-9da1-d9602bfecf2d",
  "resource": "documents",
  "data": [
    {
      "id": "doc_073D2D49094A4AED991A47B614522579",
      "content": "This is the content of the document.",
      "createdAt": "2023-01-01T12:00:00.000Z",
      "updatedAt": "2023-01-02T12:00:00.000Z",
      "name": "My Document",
      "status": "active",
      "userId": "usr_535B1EC15F5F41EAB1B400E9ED4077B6",
      "projectId": "prj_E8F0457A95B04D87A11F6B1DD6AA2356",
      "appUrl": "https://app.jasper.ai/canvas/edit/2efa3e90-34ff-4a61-a251-0d8f93ce0be3?activeNode=962e4d4c-ffdc-4c7a-83e3-8f4e715004cf"
    }
  ]
}

Changes