v1

latestOpenAPI 3.1.02026-07-265094114.0 KB

Projects

Retrieve Project by ID

Retrieve a specific Project in your workspace by ID

get/v1/projects/{id}

Path parameters

idstring required

Example:prj_535B1EC15F5F41EAB1B400E9ED4077B6

The Project's unique ID

Response

Project details

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"
    }
  }
}