Skip to main content
POST
Create Captain

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
name
string
required
Required string length: 1 - 100
brief
string

The Captain's first message from you: what it is for and what to start on. Absent, the Captain greets you and asks.

model
object
avatar
object

Absent, the Captain takes the first preset face on a blue background.

authorId
string

The active member of the key's organization who owns the Captain. A Captain needs a human owner, so a service key must name one; a personal key owns it itself when absent. A replayed requestId returns the existing Captain unchanged.

Response

Captain

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
name
string
required
avatar
object
required
needsYou
boolean
crewNeedsYou
integer
participated
boolean
crewMentionCount
integer
captain
object
crewCount
integer
personal
boolean