Get a loop

v1.0.0

API for managing loops — named, cloud-executed agent automations triggered by schedule, GitHub events or authenticated API calls. See products/tasks/docs/LOOPS.md.

Input

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "project_id": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "project_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Detail/create/update response for a loop, including its triggers.",
  "required": [
    "behaviors",
    "connectors",
    "consecutive_failures",
    "created_at",
    "created_by_id",
    "description",
    "disabled_reason",
    "enabled",
    "id",
    "instructions",
    "internal",
    "last_error",
    "last_run_at",
    "last_run_status",
    "model",
    "name",
    "notifications",
    "origin_product",
    "overlap_policy",
    "reasoning_effort",
    "repositories",
    "runtime_adapter",
    "sandbox_environment_id",
    "skill_bundles",
    "team_id",
    "triggers",
    "updated_at",
    "visibility"
  ],
  "properties": {
    "behaviors": {
      "description": "PR / CI-follow-up behavior configuration.",
      "type": "object"
    },
    "connectors": {
      "description": "MCP connector configuration for this loop's runs.",
      "type": "object"
    },
    "consecutive_failures": {
      "type": "integer"
    },
    "context_target": {
      "description": "Context this loop is attached to, or null when unattached.",
      "type": "object"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "created_by_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "description": {
      "type": "string"
    },
    "disabled_reason": {
      "type": [
        "string",
        "null"
      ]
    },
    "enabled": {
      "type": "boolean"
    },
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "instructions": {
      "type": "string"
    },
    "internal": {
      "type": "boolean"
    },
    "last_error": {
      "type": [
        "string",
        "null"
      ]
    },
    "last_run_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "last_run_status": {
      "type": [
        "string",
        "null"
      ]
    },
    "model": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "notifications": {
      "description": "Per-channel notification configuration.",
      "type": "object"
    },
    "origin_product": {
      "type": "string"
    },
    "overlap_policy": {
      "type": "string"
    },
    "reasoning_effort": {
      "type": [
        "string",
        "null"
      ]
    },
    "repositories": {
      "type": "array",
      "description": "Repositories this loop operates on.",
      "items": {
        "type": "object",
        "required": [
          "full_name",
          "github_integration_id"
        ],
        "properties": {
          "full_name": {
            "type": "string"
          },
          "github_integration_id": {
            "type": "integer"
          }
        }
      }
    },
    "runtime_adapter": {
      "type": "string"
    },
    "sandbox_environment_id": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "skill_bundles": {
      "type": "array",
      "description": "Skill bundles attached to this loop, seeded into every fired run.",
      "items": {
        "type": "object",
        "required": [
          "content_sha256",
          "id",
          "size",
          "skill_name",
          "skill_source",
          "uploaded_at"
        ],
        "properties": {
          "content_sha256": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "size": {
            "type": "integer"
          },
          "skill_name": {
            "type": "string"
          },
          "skill_source": {
            "type": "string"
          },
          "uploaded_at": {
            "type": "string"
          }
        }
      }
    },
    "team_id": {
      "type": "integer"
    },
    "triggers": {
      "type": "array",
      "description": "Triggers attached to this loop.",
      "items": {
        "type": "object",
        "description": "Read response for a single loop trigger.",
        "required": [
          "config",
          "created_at",
          "enabled",
          "id",
          "last_fired_at",
          "loop_id",
          "schedule_sync_status",
          "type",
          "updated_at"
        ],
        "properties": {
          "config": {
            "type": "object"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "enabled": {
            "type": "boolean"
          },
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "last_fired_at": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          },
          "loop_id": {
            "type": "string",
            "format": "uuid"
          },
          "schedule_sync_status": {
            "type": [
              "string",
              "null"
            ]
          },
          "type": {
            "type": "string"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "visibility": {
      "type": "string"
    }
  }
}