Skip to main content
A project is the top-level container for all your research work in Boses. Everything — persona groups, briefings, and simulations — lives inside a project. Projects belong to your company and are visible to all users in your organization.

Endpoints

MethodPathAuthDescription
GET/api/v1/projectsYesList all projects for your company
POST/api/v1/projectsYesCreate a new project
GET/api/v1/projects/{project_id}YesGet a single project
PATCH/api/v1/projects/{project_id}YesUpdate project name or description
DELETE/api/v1/projects/{project_id}YesDelete a project and all its resources

GET /projects

List all projects belonging to your company. Returns an array of project objects.

Example

curl https://api.temujintechnologies.com/api/v1/projects \
  -H "Authorization: Bearer <access_token>"

POST /projects

Create a new project. Only name is required.

Request body

name
string
required
A short, descriptive name for the project. Visible to all users in your company.
description
string
An optional longer description of the project’s research objective.

Response

id
string
UUID of the newly created project.
name
string
Project name.
description
string
Project description, if provided.
company_id
string
UUID of your company.
created_at
string
ISO 8601 UTC timestamp of when the project was created.
simulation_count
number
Number of simulations in this project. Starts at 0.
persona_group_count
number
Number of persona groups in this project. Starts at 0.

Example

curl -X POST https://api.temujintechnologies.com/api/v1/projects \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q3 Snack Relaunch",
    "description": "Testing new packaging and messaging for the PH market"
  }'

GET /projects/

Retrieve a single project by its ID.

Path parameters

project_id
string
required
UUID of the project.

Example

curl https://api.temujintechnologies.com/api/v1/projects/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
  -H "Authorization: Bearer <access_token>"

PATCH /projects/

Update a project’s name or description. Only the fields you include in the request body are changed.

Path parameters

project_id
string
required
UUID of the project to update.

Request body

name
string
New name for the project.
description
string
New description for the project.

Example

curl -X PATCH https://api.temujintechnologies.com/api/v1/projects/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q3 Snack Relaunch — Final"
  }'

DELETE /projects/

Permanently delete a project.
Deleting a project permanently removes all resources inside it — persona groups, personas, briefings, and simulations, including their results. This action cannot be undone.

Path parameters

project_id
string
required
UUID of the project to delete.

Example

curl -X DELETE https://api.temujintechnologies.com/api/v1/projects/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
  -H "Authorization: Bearer <access_token>"