Skip to main content
POST
Create thread

Authorizations

Authorization
string
header
required

An API key created in Capy under Settings → API.

Body

application/json
requestId
string
required
Required string length: 1 - 191
projectId
string
required
message
string
required
title
string
model
object
machineSize
enum<string>
Available options:
small,
medium,
large,
ultra,
hyper,
bigguy
device
object
authorId
string
personal
boolean
pullRequestAuthor
enum<string>

Who authors this thread's pull requests on GitHub: capy for the Capy GitHub App, user for the thread's acting human (the authorId member, or the key's creator for a service key). Commits and pushes keep the Git identity preference. Absent leaves the preference in charge; a replayed requestId keeps the original value.

Available options:
user,
capy

Response

Thread

id
string
required
projectId
string | null
required
authorId
string | null
required
previousAuthorId
string | null
required
title
string | null
required
titleCustom
boolean
required
status
enum<string>
required
Available options:
working,
waiting,
idle,
failed,
archived
archived
boolean
required
lastModelId
string | null
required
pullRequestAuthor
enum<string> | null
required

Who authors this thread's pull requests on GitHub: capy for the Capy GitHub App, user for the thread's acting human. Null means the acting human's Git identity preference decides.

Available options:
user,
capy
usage
object
required
createdAt
string
required
updatedAt
string
required
lastActivityAt
string | null
required
hasUnreads
boolean
required
mentionCount
integer
required
owed
boolean
required
member
boolean
required
needsYou
boolean
crewNeedsYou
integer
participated
boolean
crewMentionCount
integer
captain
object
crewCount
integer
personal
boolean