CAcapy
captains

Create Captain

Changed on
post/api/v1/captains

Request

  • Base URL
    https://api.capy.ai
  • Auth
    HTTP bearer

Request body

requestIdstring required
projectIdstring required
namestring required
briefstring

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

authorIdstring

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

idstring required
projectIdstring nullable required
authorIdstring nullable required
previousAuthorIdstring nullable required
titlestring nullable required
titleCustomboolean required
status'working' | 'waiting' | 'idle' | 'failed' | 'archived' required
archivedboolean required
lastModelIdstring nullable required
pullRequestAuthor'user' | 'capy' nullable 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.

createdAtstring required
updatedAtstring required
lastActivityAtstring nullable required
hasUnreadsboolean required
mentionCountinteger required
owedboolean required
needsYouboolean
crewNeedsYouinteger
participatedboolean
crewMentionCountinteger
crewCountinteger
memberboolean required
subscribedboolean
personalboolean
visibility'org' | 'private'
namestring required
descriptionstring nullable required

A short public label saying whose Captain this is and what it covers, at most 140 characters of plain text, for attribution and discovery. Null when unset.

Changes