Skip to main content
POST
/
api
/
v1
/
teams
/
{team_id}
/
cycle
Create Cycle
curl --request POST \
  --url https://api.example.com/api/v1/teams/{team_id}/cycle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "duration_days": 183,
  "start_anchor": "monday",
  "custom_start_date": "2023-12-25",
  "timezone": "UTC",
  "phases": [
    {
      "name": "<string>",
      "start_pct": 50,
      "end_pct": 50,
      "color": "<string>"
    }
  ]
}
'
{
  "cycle": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "duration_type": "<string>",
    "duration_days": 123,
    "start_anchor": "<string>",
    "custom_start_date": "2023-12-25",
    "timezone": "<string>",
    "phases": [
      {}
    ],
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "loops": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cycle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "parent_loop_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "agent_member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phase": "<string>",
      "schedule_type": "<string>",
      "cadence": {},
      "task_type": "<string>",
      "task_template": {},
      "priority": "<string>",
      "sort_order": 123,
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "signals": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cycle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "emitter_loop_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "receiver_loop_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "signal_name": "<string>",
      "action": "<string>",
      "delay_minutes": 123,
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "active_instance": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cycle_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "instance_number": 123,
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "current_phase": "<string>",
    "status": "<string>",
    "metrics": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.aitasker.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
team_id
string<uuid>
required

Body

application/json
​
name
string
required
Required string length: 1 - 255
​
duration_type
enum<string>
required
Available options:
daily,
weekly,
biweekly,
monthly,
quarterly,
yearly,
custom
​
duration_days
integer | null

Required if duration_type='custom'

Required range: 1 <= x <= 366
​
start_anchor
enum<string>
default:monday
Available options:
monday,
first_of_month,
custom_date
​
custom_start_date
string<date> | null
​
timezone
string
default:UTC
​
phases
PhaseConfig · object[]

Response

Successful Response

Full cycle view: cycle definition + loops + signals + active instance.

​
cycle
StrategyCycleResponse · object
required
​
loops
WorkLoopResponse · object[]
required
​
signals
LoopSignalResponse · object[]
required
​
active_instance
CycleInstanceResponse · object
required