Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Tasks and projects

Create a project

Adds a project for tasks to belong to. Names are unique in a workspace.

post/api/v1/projects

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy projects create
MCP tooltroopy_create_project
Rate limit30 calls in 60 seconds, for each key
RetriesSend an Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.

Body

application/json
name*string

At least 1 characters · At most 80 characters

summarystring

At most 280 characters

descriptionstring

At most 20000 characters

iconstring

A lucide icon name, like rocket

statusenum<string>

plannedactivepauseddonecanceled

priorityenum<string>

noneurgenthighmediumlow

leadstring | null

A teammate's handle (like writer), a person's user id, me for yourself, or null for nobody

startAtstring | null
targetAtstring | null
milestonesarray<object>

All its milestones, in order: one left out is removed, and its tasks leave it

At most 20 items

3 properties
idstring

Keeps an existing milestone; leave out for a new one

name*string

At least 1 characters · At most 80 characters

targetAtstring | null

Response

201 · application/json
data*object
19 properties
id*string

A 24-character id

name*string
summary*string
description*string
icon*string
status*enum<string>

plannedactivepauseddonecanceled

priority*enum<string>

noneurgenthighmediumlow

lead*object | null
3 properties
type*enum<string>

agentperson

id*string
name*string
startAt*string | null
targetAt*string | null
tasks*object

Its tasks, canceled ones left out

4 properties
total*integer
done*integer
open*integer
needsYou*integer
progress*integer

Percent of its tasks done

milestones*array<object>

Steps on the way, in order, each with its tasks (canceled ones left out)

5 properties
id*string

A 24-character id

name*string
targetAt*string | null
tasks*object
2 properties
total*integer
done*integer
progress*integer
health*enum<string> | null

How it's going, from its latest status update

on_trackat_riskoff_track

lastUpdateAt*string | null
createdBy*object

Who wrote it

3 properties
type*enum<string>

personagentapi

id*string
name*string
createdAt*string

ISO 8601 date and time

updatedAt*string

ISO 8601 date and time

version*integer

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.