Projects

Create a project

Creates a project owned by the caller, optionally grouping existing sessions and files in it. Every listed session and file must be readable by the caller. A project's file_ids and session_ids are shared with it: anyone the project is shared with can read every file and session it groups. Sharing the project later shares them too. Unknown body fields are rejected.

post/api/v1/projects

Request

  • Base URL: https://your-deployment.example.com
  • URL: https://your-deployment.example.com/api/v1/projects
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

namestring required

Unique among your live projects.

descriptionstring required
session_idsstring[]

Sessions to group in the project. Each must be readable by the caller.

file_idsstring[]

Files to group in the project. Each must be readable by the caller.

Example request

{
  "name": "Market research",
  "description": "Sources and notes for the Q3 market analysis.",
  "session_ids": [
    "664f1c2b9a1e4d0012ab34aa"
  ],
  "file_ids": [
    "664f1c2b9a1e4d0012ab34bb"
  ]
}

Response

The created project.

idstring required
namestring required
descriptionstring required
session_idsstring[] required

Sessions grouped in the project. Anyone the project is shared with can read them.

file_idsstring[] required

Files grouped in the project. Anyone the project is shared with can read them.

created_atstring nullable required

ISO 8601 timestamp.

updated_atstring nullable required

ISO 8601 timestamp.

Changes

No recorded changes to this operation across all 1 revision of this API.