Skip to main content
GET
/
v1
/
tasks
/
{taskId}
Get task
curl --request GET \
  --url https://capy.ai/api/v1/tasks/{taskId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "projectId": "<string>",
  "identifier": "<string>",
  "title": "<string>",
  "status": "backlog",
  "labels": [
    "<string>"
  ],
  "pullRequest": {
    "number": 0,
    "url": "<string>",
    "repoFullName": "<string>",
    "state": "<string>",
    "headRef": "<string>",
    "baseRef": "<string>",
    "draft": true
  },
  "slackThreads": [
    {
      "teamId": "<string>",
      "channelId": "<string>",
      "threadTs": "<string>",
      "url": "<string>"
    }
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "prompt": "<string>",
  "jams": [
    {
      "id": "<string>",
      "status": "idle",
      "model": "auto",
      "pullRequest": {
        "number": 0,
        "url": "<string>",
        "repoFullName": "<string>",
        "state": "<string>",
        "headRef": "<string>",
        "baseRef": "<string>",
        "draft": true
      },
      "branches": {},
      "git": {
        "remoteUrl": "<string>",
        "lastCommitSha": "<string>"
      },
      "slackThreads": [
        {
          "teamId": "<string>",
          "channelId": "<string>",
          "threadTs": "<string>",
          "url": "<string>"
        }
      ],
      "credits": {
        "llm": 123,
        "vm": 123
      },
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

API token (capy_xxxx). Generate at capy.ai/settings/tokens

Path Parameters

taskId
string
required

Task identifier. Accepts both UUID and PREFIX-NNN formats.

Response

Success

id
string
required
projectId
string
required
identifier
string
required
title
string
required
status
enum<string>
required
Available options:
backlog,
queued,
in_progress,
needs_review,
archived
labels
string[]
required
pullRequest
object
required
slackThreads
object[]
required
createdAt
string
required
updatedAt
string
required
prompt
string
required
jams
object[]
required