v1

latestOpenAPI 3.1.02026-07-265094114.0 KB

Projects

Create a Project

Create a new Project in your workspace

post/v1/projects

Request body

userIdstring required

The ID of the user creating the project

namestring required

The name of the project

accessLevel'PRIVATE' | 'WORKSPACE'

Who can access the new project. PRIVATE (default) restricts access to the owning user; WORKSPACE shares the project with all members of the calling workspace.

metadataobject

An optional set of key-value pairs to attach any data you wish to the project, in a structured format. You can specify up to 10 keys, with key names up to 40 characters long and values up to 500 characters long. null values are accepted but ignored on create (there is nothing to clear yet) and are supported for symmetry with the update endpoint.

Example request

{
  "userId": "usr_535B1EC15F5F41EAB1B400E9ED4077B6",
  "name": "My Project",
  "accessLevel": "PRIVATE",
  "settings": {
    "goal": "Launch announcement for Q3 product release",
    "toneId": "ton_535B1EC15F5F41EAB1B400E9ED4077B6",
    "audienceId": "aud_535B1EC15F5F41EAB1B400E9ED4077B6",
    "styleId": "sty_535B1EC15F5F41EAB1B400E9ED4077B6",
    "knowledgeIds": [
      "kno_535B1EC15F5F41EAB1B400E9ED4077B6"
    ]
  },
  "metadata": {
    "externalId": "ext_123",
    "source": "crm"
  }
}

Response

Project created

requestIdstring required

resourcestring required

Example response

{
  "requestId": "bce766ea-a4ef-48e5-9da1-d9602bfecf2d",
  "resource": "projects",
  "data": [
    {
      "id": "prj_073D2D49094A4AED991A47B614522579",
      "name": "My Canvas",
      "userId": "usr_073D2D49094A4AED991A47B614522579",
      "appUrl": "https://app.jasper.ai/canvas/edit/962e4d4c-ffdc-4c7a-83e3-8f4e715004cf",
      "accessLevel": "PRIVATE",
      "settings": {
        "goal": "Launch announcement for Q3 product release",
        "toneId": "ton_535B1EC15F5F41EAB1B400E9ED4077B6",
        "audienceId": "aud_535B1EC15F5F41EAB1B400E9ED4077B6",
        "styleId": "sty_535B1EC15F5F41EAB1B400E9ED4077B6",
        "knowledgeIds": [
          "kno_535B1EC15F5F41EAB1B400E9ED4077B6"
        ]
      },
      "metadata": {
        "externalId": "ext_123",
        "source": "crm"
      }
    }
  ]
}