Skip to content
Skip to main content
API reference

Task Agent

API reference

Explore public endpoint parameters, authentication, and response schemas.

OpenAPI JSON

Definitions come from the Backplane OpenAPI specification. Public endpoints are grouped below; expand one to see parameters, request bodies, statuses, and schemas. Start with the quickstart; see events for streaming.

39 public endpoints are included in this snapshot. Parameters, responses, and authentication come directly from OpenAPI JSON; endpoint descriptions retain the source language.

Download OpenAPI JSON · View upstream OpenAPI JSON

Snapshot date: 2026-09-17 · Format: Swagger / OpenAPI 2.0 · Base URL: https://backend.hast.so/api/public/v1.

The download contains only public Task Agent endpoints and their referenced models. Import it into API tools supporting Swagger 2.0. The upstream specification also includes other services.

Authentication

Every request requires a personal API key. Use Authorization: Bearer hast_pk_... and keep the key on your server.

JSON
{
  "description": "Personal API key as `Bearer hast_pk_*` for `/api/public/v1`.",
  "in": "header",
  "name": "Authorization",
  "type": "apiKey"
}

Prompt

POST /api/public/v1/promptsSubmit a public Task Agent prompt

Creates a normal conversational Task Agent session when session_id is omitted, or appends a turn to an existing session. request_id is idempotent.

Request format: application/json; Response format: application/json.

Parameters

request · body · Required

JSON
{
  "description": "Public prompt request",
  "in": "body",
  "name": "request",
  "required": true,
  "schema": {
    "properties": {
      "dynamic_tools": {
        "items": {
          "additionalProperties": {},
          "type": "object"
        },
        "type": "array"
      },
      "files": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "model": {
        "example": "hast/auto",
        "type": "string"
      },
      "prompt": {
        "example": "Summarize the release notes.",
        "type": "string"
      },
      "reasoning_effort": {
        "example": "medium",
        "type": "string"
      },
      "request_id": {
        "example": "client-turn-1",
        "type": "string"
      },
      "secret_bindings": {
        "items": {
          "additionalProperties": {},
          "type": "object"
        },
        "type": "array"
      },
      "session_id": {
        "example": "sess_abc123",
        "type": "string"
      },
      "skill_ids": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "system_prompt": {
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

202 Accepted

JSON
{
  "properties": {
    "request_id": {
      "example": "client-turn-1",
      "type": "string"
    },
    "session_id": {
      "example": "sess_abc123",
      "type": "string"
    },
    "status": {
      "example": "dispatch_pending",
      "type": "string"
    }
  },
  "type": "object"
}

401 Unauthorized

JSON
{
  "properties": {
    "code": {
      "description": "Code is the business status code (0 = success; see pkg/utils/errors.go).",
      "example": 0,
      "type": "integer"
    },
    "message": {
      "description": "Message is a human-readable status or error description.",
      "example": "ok",
      "type": "string"
    }
  },
  "type": "object"
}

409 Conflict

JSON
{
  "properties": {
    "code": {
      "description": "Code is the business status code (0 = success; see pkg/utils/errors.go).",
      "example": 0,
      "type": "integer"
    },
    "message": {
      "description": "Message is a human-readable status or error description.",
      "example": "ok",
      "type": "string"
    }
  },
  "type": "object"
}

413 Request Entity Too Large

JSON
{
  "properties": {
    "code": {
      "description": "Code is the business status code (0 = success; see pkg/utils/errors.go).",
      "example": 0,
      "type": "integer"
    },
    "message": {
      "description": "Message is a human-readable status or error description.",
      "example": "ok",
      "type": "string"
    }
  },
  "type": "object"
}

Sessions and events

GET /api/public/v1/sessionsList public Task Agent sessions

Request format: No request body format specified; Response format: application/json.

Parameters

limit · query · Optional

JSON
{
  "description": "Page size (1-100, default 50)",
  "in": "query",
  "name": "limit",
  "type": "integer"
}

cursor · query · Optional

JSON
{
  "description": "Opaque cursor returned by the previous page",
  "in": "query",
  "name": "cursor",
  "type": "string"
}

Responses

200 OK

JSON
{
  "properties": {
    "has_more": {
      "type": "boolean"
    },
    "next_cursor": {
      "type": "string"
    },
    "sessions": {
      "items": {
        "properties": {
          "event_cursor": {
            "type": "integer"
          },
          "mode": {
            "type": "string"
          },
          "runtime_provider": {
            "type": "string"
          },
          "session_id": {
            "example": "sess_abc123",
            "type": "string"
          },
          "status": {
            "example": "running",
            "type": "string"
          },
          "task_origin": {
            "example": "session",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}
GET /api/public/v1/sessions/{id}Read a public Task Agent session

Request format: No request body format specified; Response format: application/json.

Parameters

id · path · Required

JSON
{
  "description": "Session ID",
  "in": "path",
  "name": "id",
  "required": true,
  "type": "string"
}

Responses

200 OK

JSON
{
  "properties": {
    "session": {
      "properties": {
        "event_cursor": {
          "type": "integer"
        },
        "mode": {
          "type": "string"
        },
        "runtime_provider": {
          "type": "string"
        },
        "session_id": {
          "example": "sess_abc123",
          "type": "string"
        },
        "status": {
          "example": "running",
          "type": "string"
        },
        "task_origin": {
          "example": "session",
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
DELETE /api/public/v1/sessions/{id}Delete a public Task Agent session

Request format: No request body format specified; Response format: application/json.

Parameters

id · path · Required

JSON
{
  "description": "Session ID",
  "in": "path",
  "name": "id",
  "required": true,
  "type": "string"
}

Responses

200 OK

JSON
{
  "properties": {
    "task": {
      "properties": {
        "client_id": {
          "example": "client-main-user-123",
          "type": "string"
        },
        "config": {
          "additionalProperties": {},
          "type": "object"
        },
        "created_at": {
          "type": "string"
        },
        "event_cursor": {
          "example": 42,
          "type": "integer"
        },
        "id": {
          "example": "task-agent-123",
          "type": "string"
        },
        "mode": {
          "example": "agent_run",
          "type": "string"
        },
        "profile_id": {
          "example": "user_123",
          "type": "string"
        },
        "prompt": {
          "type": "string"
        },
        "runtime_provider": {
          "example": "cubesandbox",
          "type": "string"
        },
        "sandbox_id": {
          "example": "sandbox-main-user-123",
          "type": "string"
        },
        "sandbox_scope": {
          "example": "main",
          "type": "string"
        },
        "status": {
          "example": "needs_input",
          "type": "string"
        },
        "task_origin": {
          "example": "session",
          "type": "string"
        },
        "title": {
          "example": "Release validation",
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        },
        "workspace_object_prefix": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
POST /api/public/v1/sessions/{id}/cancelCancel a public Task Agent session

Request format: No request body format specified; Response format: application/json.

Parameters

id · path · Required

JSON
{
  "description": "Session ID",
  "in": "path",
  "name": "id",
  "required": true,
  "type": "string"
}

Responses

200 OK

JSON
{
  "properties": {
    "task": {
      "properties": {
        "client_id": {
          "example": "client-main-user-123",
          "type": "string"
        },
        "config": {
          "additionalProperties": {},
          "type": "object"
        },
        "created_at": {
          "type": "string"
        },
        "event_cursor": {
          "example": 42,
          "type": "integer"
        },
        "id": {
          "example": "task-agent-123",
          "type": "string"
        },
        "mode": {
          "example": "agent_run",
          "type": "string"
        },
        "profile_id": {
          "example": "user_123",
          "type": "string"
        },
        "prompt": {
          "type": "string"
        },
        "runtime_provider": {
          "example": "cubesandbox",
          "type": "string"
        },
        "sandbox_id": {
          "example": "sandbox-main-user-123",
          "type": "string"
        },
        "sandbox_scope": {
          "example": "main",
          "type": "string"
        },
        "status": {
          "example": "needs_input",
          "type": "string"
        },
        "task_origin": {
          "example": "session",
          "type": "string"
        },
        "title": {
          "example": "Release validation",
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        },
        "workspace_object_prefix": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
GET /api/public/v1/sessions/{id}/eventsList public Task Agent Event v2 events

Request format: No request body format specified; Response format: application/json.

Parameters

id · path · Required

JSON
{
  "description": "Session ID",
  "in": "path",
  "name": "id",
  "required": true,
  "type": "string"
}

after · query · Optional

JSON
{
  "description": "Return persisted events after this sequence",
  "in": "query",
  "name": "after",
  "type": "integer"
}

Responses

200 OK

JSON
{
  "properties": {
    "events": {
      "items": {
        "discriminator": "type",
        "properties": {
          "created_at": {
            "example": "2026-08-16T12:00:00Z",
            "format": "date-time",
            "type": "string"
          },
          "data": {
            "allOf": [
              {
                "properties": {
                  "attempt": {
                    "minimum": 1,
                    "type": "integer"
                  },
                  "attempts": {
                    "minimum": 1,
                    "type": "integer"
                  },
                  "channel": {
                    "enum": [
                      "stdout",
                      "stderr",
                      "progress"
                    ],
                    "type": "string"
                  },
                  "code": {
                    "type": "string"
                  },
                  "context_window": {
                    "minimum": 0,
                    "type": "integer"
                  },
                  "cost": {},
                  "delta": {
                    "type": "string"
                  },
                  "duration_ms": {
                    "minimum": 0,
                    "type": "integer"
                  },
                  "error": {
                    "type": "string"
                  },
                  "exit_code": {
                    "type": "integer"
                  },
                  "files": {
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "final_message_id": {
                    "type": "string"
                  },
                  "finish_reason": {
                    "type": "string"
                  },
                  "input": {},
                  "is_error": {
                    "type": "boolean"
                  },
                  "kind": {
                    "type": "string"
                  },
                  "last": {
                    "properties": {
                      "cache_read_tokens": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "cache_write_tokens": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "input_tokens": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "output_tokens": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "reasoning_tokens": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "total_tokens": {
                        "minimum": 0,
                        "type": "integer"
                      }
                    },
                    "required": [
                      "cache_read_tokens",
                      "cache_write_tokens",
                      "input_tokens",
                      "output_tokens",
                      "reasoning_tokens",
                      "total_tokens"
                    ],
                    "type": "object"
                  },
                  "message": {
                    "type": "string"
                  },
                  "message_id": {
                    "type": "string"
                  },
                  "model": {
                    "type": "string"
                  },
                  "model_source": {
                    "type": "string"
                  },
                  "modified_at": {
                    "format": "date-time",
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "operation": {
                    "enum": [
                      "update",
                      "delete"
                    ],
                    "type": "string"
                  },
                  "options": {
                    "items": {},
                    "type": "array"
                  },
                  "output": {},
                  "parent_tool_call_id": {
                    "type": "string"
                  },
                  "path": {
                    "type": "string"
                  },
                  "plan_id": {
                    "type": "string"
                  },
                  "prompt": {
                    "type": "string"
                  },
                  "reason": {
                    "type": "string"
                  },
                  "reasoning_id": {
                    "type": "string"
                  },
                  "request_id": {
                    "type": "string"
                  },
                  "retryable": {
                    "type": "boolean"
                  },
                  "role": {
                    "enum": [
                      "user",
                      "assistant",
                      "system"
                    ],
                    "type": "string"
                  },
                  "scope": {
                    "type": "string"
                  },
                  "size_bytes": {
                    "minimum": 0,
                    "type": "integer"
                  },
                  "status": {
                    "enum": [
                      "starting",
                      "ready",
                      "failed",
                      "released",
                      "succeeded",
                      "interrupted"
                    ],
                    "type": "string"
                  },
                  "steps": {
                    "items": {
                      "properties": {
                        "status": {
                          "enum": [
                            "pending",
                            "in_progress",
                            "completed"
                          ],
                          "example": "in_progress",
                          "type": "string"
                        },
                        "step": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "status",
                        "step"
                      ],
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "text": {
                    "type": "string"
                  },
                  "tokens_after": {
                    "minimum": 0,
                    "type": "integer"
                  },
                  "tokens_before": {
                    "minimum": 0,
                    "type": "integer"
                  },
                  "tool_call_id": {
                    "type": "string"
                  },
                  "total": {
                    "properties": {
                      "cache_read_tokens": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "cache_write_tokens": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "input_tokens": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "output_tokens": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "reasoning_tokens": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "total_tokens": {
                        "minimum": 0,
                        "type": "integer"
                      }
                    },
                    "required": [
                      "cache_read_tokens",
                      "cache_write_tokens",
                      "input_tokens",
                      "output_tokens",
                      "reasoning_tokens",
                      "total_tokens"
                    ],
                    "type": "object"
                  },
                  "turn_type": {
                    "type": "string"
                  }
                },
                "type": "object"
              }
            ],
            "description": "Data is the HAST-owned payload union; Type selects its required shape as\ndefined in docs/reference/task-agent-event-v2.md."
          },
          "engine": {
            "enum": [
              "codex_cli",
              "pi_agent_cli"
            ],
            "example": "codex_cli",
            "type": "string"
          },
          "event_id": {
            "example": "evt_123",
            "type": "string"
          },
          "replayable": {
            "example": true,
            "type": "boolean"
          },
          "run_id": {
            "example": "run_123",
            "type": "string"
          },
          "schema_version": {
            "enum": [
              2
            ],
            "example": 2,
            "type": "integer"
          },
          "sequence": {
            "description": "Sequence is a positive durable order, or null for volatile events.",
            "example": 42,
            "minimum": 1,
            "type": "integer",
            "x-nullable": true
          },
          "session_id": {
            "example": "session_123",
            "type": "string"
          },
          "source": {
            "enum": [
              "runtime",
              "backplane",
              "workspace"
            ],
            "example": "runtime",
            "type": "string"
          },
          "task_id": {
            "example": "task_123",
            "type": "string"
          },
          "type": {
            "enum": [
              "runtime.status",
              "run.queued",
              "run.started",
              "run.retrying",
              "run.completed",
              "run.failed",
              "run.interrupted",
              "message.started",
              "message.delta",
              "message.completed",
              "reasoning.started",
              "reasoning.delta",
              "reasoning.completed",
              "tool.started",
              "tool.updated",
              "tool.completed",
              "plan.updated",
              "plan.completed",
              "usage.updated",
              "file.changed",
              "input.requested",
              "context.compacted",
              "warning",
              "error"
            ],
            "example": "message.completed",
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "data",
          "engine",
          "event_id",
          "replayable",
          "schema_version",
          "sequence",
          "source",
          "task_id",
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "has_more": {
      "example": true,
      "type": "boolean"
    },
    "next_after": {
      "example": 42,
      "format": "int64",
      "type": "integer",
      "x-nullable": true
    }
  },
  "type": "object"
}
GET /api/public/v1/sessions/{id}/events/streamStream public Task Agent events

Event v2 SSE supports after and Last-Event-ID replay.

Request format: No request body format specified; Response format: text/event-stream.

Parameters

id · path · Required

JSON
{
  "description": "Session ID",
  "in": "path",
  "name": "id",
  "required": true,
  "type": "string"
}

after · query · Optional

JSON
{
  "description": "Return persisted events after this sequence",
  "in": "query",
  "name": "after",
  "type": "integer"
}

Responses

200 SSE stream

JSON
{
  "type": "string"
}
POST /api/public/v1/sessions/{id}/interruptInterrupt a public Task Agent turn

Request format: No request body format specified; Response format: application/json.

Parameters

id · path · Required

JSON
{
  "description": "Session ID",
  "in": "path",
  "name": "id",
  "required": true,
  "type": "string"
}

Responses

200 OK

JSON
{
  "properties": {
    "request_id": {
      "example": "task-agent-turn-1710000000000000000",
      "type": "string"
    },
    "status": {
      "example": "queued",
      "type": "string"
    }
  },
  "type": "object"
}

202 Accepted

JSON
{
  "properties": {
    "request_id": {
      "example": "task-agent-turn-1710000000000000000",
      "type": "string"
    },
    "status": {
      "example": "queued",
      "type": "string"
    }
  },
  "type": "object"
}

Skills

GET /api/public/v1/skillsList public Task Agent skills

Request format: No request body format specified; Response format: application/json.

Parameters

No parameters declared in the specification.

Responses

200 OK

JSON
{
  "properties": {
    "skills": {
      "items": {
        "properties": {
          "capability_id": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "directory_name": {
            "example": "e2e-summary",
            "type": "string"
          },
          "display_name": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "entrypoint_path": {
            "example": "SKILL.md",
            "type": "string"
          },
          "files": {
            "items": {
              "properties": {
                "content": {
                  "type": "string"
                },
                "path": {
                  "example": "SKILL.md",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "type": "array"
          },
          "hash": {
            "example": "sha256:abc123",
            "type": "string"
          },
          "skill_id": {
            "example": "e2e-summary",
            "type": "string"
          },
          "source": {
            "example": "user",
            "type": "string"
          },
          "status": {
            "example": "active",
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}
POST /api/public/v1/skillsCreate a public Task Agent skill

Request format: application/json; Response format: application/json.

Parameters

request · body · Required

JSON
{
  "description": "Skill request",
  "in": "body",
  "name": "request",
  "required": true,
  "schema": {
    "properties": {
      "description": {
        "type": "string"
      },
      "directory_name": {
        "example": "e2e-summary",
        "type": "string"
      },
      "display_name": {
        "example": "E2E Summary",
        "type": "string"
      },
      "enabled": {
        "type": "boolean"
      },
      "entrypoint_path": {
        "example": "SKILL.md",
        "type": "string"
      },
      "expected_checksum_sha256": {
        "type": "string"
      },
      "files": {
        "items": {
          "properties": {
            "content": {
              "type": "string"
            },
            "path": {
              "example": "SKILL.md",
              "type": "string"
            }
          },
          "type": "object"
        },
        "type": "array"
      },
      "skill_id": {
        "example": "e2e-summary",
        "type": "string"
      },
      "source_type": {
        "example": "upload",
        "type": "string"
      },
      "url": {
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "skill": {
      "properties": {
        "capability_id": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "directory_name": {
          "example": "e2e-summary",
          "type": "string"
        },
        "display_name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "entrypoint_path": {
          "example": "SKILL.md",
          "type": "string"
        },
        "files": {
          "items": {
            "properties": {
              "content": {
                "type": "string"
              },
              "path": {
                "example": "SKILL.md",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        },
        "hash": {
          "example": "sha256:abc123",
          "type": "string"
        },
        "skill_id": {
          "example": "e2e-summary",
          "type": "string"
        },
        "source": {
          "example": "user",
          "type": "string"
        },
        "status": {
          "example": "active",
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
GET /api/public/v1/skills/{skillID}Read, update, or delete a public Task Agent skill

Request format: application/json; Response format: application/json.

Parameters

skillID · path · Required

JSON
{
  "description": "Skill ID",
  "in": "path",
  "name": "skillID",
  "required": true,
  "type": "string"
}

request · body · Optional

JSON
{
  "description": "Skill request",
  "in": "body",
  "name": "request",
  "schema": {
    "properties": {
      "description": {
        "type": "string"
      },
      "directory_name": {
        "example": "e2e-summary",
        "type": "string"
      },
      "display_name": {
        "example": "E2E Summary",
        "type": "string"
      },
      "enabled": {
        "type": "boolean"
      },
      "entrypoint_path": {
        "example": "SKILL.md",
        "type": "string"
      },
      "expected_checksum_sha256": {
        "type": "string"
      },
      "files": {
        "items": {
          "properties": {
            "content": {
              "type": "string"
            },
            "path": {
              "example": "SKILL.md",
              "type": "string"
            }
          },
          "type": "object"
        },
        "type": "array"
      },
      "skill_id": {
        "example": "e2e-summary",
        "type": "string"
      },
      "source_type": {
        "example": "upload",
        "type": "string"
      },
      "url": {
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "skill": {
      "properties": {
        "capability_id": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "directory_name": {
          "example": "e2e-summary",
          "type": "string"
        },
        "display_name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "entrypoint_path": {
          "example": "SKILL.md",
          "type": "string"
        },
        "files": {
          "items": {
            "properties": {
              "content": {
                "type": "string"
              },
              "path": {
                "example": "SKILL.md",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        },
        "hash": {
          "example": "sha256:abc123",
          "type": "string"
        },
        "skill_id": {
          "example": "e2e-summary",
          "type": "string"
        },
        "source": {
          "example": "user",
          "type": "string"
        },
        "status": {
          "example": "active",
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
PUT /api/public/v1/skills/{skillID}Read, update, or delete a public Task Agent skill

Request format: application/json; Response format: application/json.

Parameters

skillID · path · Required

JSON
{
  "description": "Skill ID",
  "in": "path",
  "name": "skillID",
  "required": true,
  "type": "string"
}

request · body · Optional

JSON
{
  "description": "Skill request",
  "in": "body",
  "name": "request",
  "schema": {
    "properties": {
      "description": {
        "type": "string"
      },
      "directory_name": {
        "example": "e2e-summary",
        "type": "string"
      },
      "display_name": {
        "example": "E2E Summary",
        "type": "string"
      },
      "enabled": {
        "type": "boolean"
      },
      "entrypoint_path": {
        "example": "SKILL.md",
        "type": "string"
      },
      "expected_checksum_sha256": {
        "type": "string"
      },
      "files": {
        "items": {
          "properties": {
            "content": {
              "type": "string"
            },
            "path": {
              "example": "SKILL.md",
              "type": "string"
            }
          },
          "type": "object"
        },
        "type": "array"
      },
      "skill_id": {
        "example": "e2e-summary",
        "type": "string"
      },
      "source_type": {
        "example": "upload",
        "type": "string"
      },
      "url": {
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "skill": {
      "properties": {
        "capability_id": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "directory_name": {
          "example": "e2e-summary",
          "type": "string"
        },
        "display_name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "entrypoint_path": {
          "example": "SKILL.md",
          "type": "string"
        },
        "files": {
          "items": {
            "properties": {
              "content": {
                "type": "string"
              },
              "path": {
                "example": "SKILL.md",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        },
        "hash": {
          "example": "sha256:abc123",
          "type": "string"
        },
        "skill_id": {
          "example": "e2e-summary",
          "type": "string"
        },
        "source": {
          "example": "user",
          "type": "string"
        },
        "status": {
          "example": "active",
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
PATCH /api/public/v1/skills/{skillID}Read, update, or delete a public Task Agent skill

Request format: application/json; Response format: application/json.

Parameters

skillID · path · Required

JSON
{
  "description": "Skill ID",
  "in": "path",
  "name": "skillID",
  "required": true,
  "type": "string"
}

request · body · Optional

JSON
{
  "description": "Skill request",
  "in": "body",
  "name": "request",
  "schema": {
    "properties": {
      "description": {
        "type": "string"
      },
      "directory_name": {
        "example": "e2e-summary",
        "type": "string"
      },
      "display_name": {
        "example": "E2E Summary",
        "type": "string"
      },
      "enabled": {
        "type": "boolean"
      },
      "entrypoint_path": {
        "example": "SKILL.md",
        "type": "string"
      },
      "expected_checksum_sha256": {
        "type": "string"
      },
      "files": {
        "items": {
          "properties": {
            "content": {
              "type": "string"
            },
            "path": {
              "example": "SKILL.md",
              "type": "string"
            }
          },
          "type": "object"
        },
        "type": "array"
      },
      "skill_id": {
        "example": "e2e-summary",
        "type": "string"
      },
      "source_type": {
        "example": "upload",
        "type": "string"
      },
      "url": {
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "skill": {
      "properties": {
        "capability_id": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "directory_name": {
          "example": "e2e-summary",
          "type": "string"
        },
        "display_name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "entrypoint_path": {
          "example": "SKILL.md",
          "type": "string"
        },
        "files": {
          "items": {
            "properties": {
              "content": {
                "type": "string"
              },
              "path": {
                "example": "SKILL.md",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        },
        "hash": {
          "example": "sha256:abc123",
          "type": "string"
        },
        "skill_id": {
          "example": "e2e-summary",
          "type": "string"
        },
        "source": {
          "example": "user",
          "type": "string"
        },
        "status": {
          "example": "active",
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
DELETE /api/public/v1/skills/{skillID}Read, update, or delete a public Task Agent skill

Request format: application/json; Response format: application/json.

Parameters

skillID · path · Required

JSON
{
  "description": "Skill ID",
  "in": "path",
  "name": "skillID",
  "required": true,
  "type": "string"
}

request · body · Optional

JSON
{
  "description": "Skill request",
  "in": "body",
  "name": "request",
  "schema": {
    "properties": {
      "description": {
        "type": "string"
      },
      "directory_name": {
        "example": "e2e-summary",
        "type": "string"
      },
      "display_name": {
        "example": "E2E Summary",
        "type": "string"
      },
      "enabled": {
        "type": "boolean"
      },
      "entrypoint_path": {
        "example": "SKILL.md",
        "type": "string"
      },
      "expected_checksum_sha256": {
        "type": "string"
      },
      "files": {
        "items": {
          "properties": {
            "content": {
              "type": "string"
            },
            "path": {
              "example": "SKILL.md",
              "type": "string"
            }
          },
          "type": "object"
        },
        "type": "array"
      },
      "skill_id": {
        "example": "e2e-summary",
        "type": "string"
      },
      "source_type": {
        "example": "upload",
        "type": "string"
      },
      "url": {
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "skill": {
      "properties": {
        "capability_id": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "directory_name": {
          "example": "e2e-summary",
          "type": "string"
        },
        "display_name": {
          "type": "string"
        },
        "enabled": {
          "type": "boolean"
        },
        "entrypoint_path": {
          "example": "SKILL.md",
          "type": "string"
        },
        "files": {
          "items": {
            "properties": {
              "content": {
                "type": "string"
              },
              "path": {
                "example": "SKILL.md",
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": "array"
        },
        "hash": {
          "example": "sha256:abc123",
          "type": "string"
        },
        "skill_id": {
          "example": "e2e-summary",
          "type": "string"
        },
        "source": {
          "example": "user",
          "type": "string"
        },
        "status": {
          "example": "active",
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Channels

POST /api/public/v1/channels/{connection_id}/wechat-kf/accountsDiscover WeChat customer service accounts without saving credentials

Requires channels:write on a Profile key. Returns account names, IDs and management eligibility for an owned WeChat channel. Does not save the Secret or change bindings. Select an account with manage_privilege=true, then PATCH the WeChat setup with corp_secret and open_kfid.

Request format: application/json; Response format: application/json.

Parameters

connection_id · path · Required

JSON
{
  "type": "string",
  "description": "Owned WeChat channel connection ID",
  "name": "connection_id",
  "in": "path",
  "required": true
}

request · body · Required

JSON
{
  "description": "Application Secret; never include in prompts or logs",
  "name": "request",
  "in": "body",
  "required": true,
  "schema": {
    "type": "object",
    "required": [
      "corp_secret"
    ],
    "properties": {
      "corp_secret": {
        "type": "string",
        "maxLength": 4096
      }
    }
  }
}

Responses

200 OK

JSON
{
  "type": "object",
  "properties": {
    "accounts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "manage_privilege": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "open_kfid": {
            "type": "string"
          }
        }
      }
    }
  }
}

400 wechat_credentials_invalid

JSON
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "error": {
      "type": "string"
    }
  }
}

401 Missing or invalid API key

JSON
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "error": {
      "type": "string"
    }
  }
}

403 Requires a Profile key with channels:write

JSON
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "error": {
      "type": "string"
    }
  }
}

404 WeChat channel not found

JSON
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "error": {
      "type": "string"
    }
  }
}

409 Channel account unavailable

JSON
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "error": {
      "type": "string"
    }
  }
}

422 wechat_credentials_invalid, wechat_permission_denied, wechat_ip_not_allowed or wechat_accounts_unavailable

JSON
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "error": {
      "type": "string"
    }
  }
}

502 wechat_accounts_unavailable

JSON
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    },
    "error": {
      "type": "string"
    }
  }
}
PATCH /api/public/v1/channels/{connection_id}/wechat-kfComplete WeChat customer service setup

Request format: application/json; Response format: application/json.

Parameters

connection_id · path · Required

JSON
{
  "type": "string",
  "description": "connection_id",
  "name": "connection_id",
  "in": "path",
  "required": true
}

request · body · Required

JSON
{
  "description": "Complete WeChat customer service setup request",
  "name": "request",
  "in": "body",
  "required": true,
  "schema": {
    "type": "object",
    "required": [
      "corp_secret",
      "open_kfid"
    ],
    "properties": {
      "corp_secret": {
        "type": "string"
      },
      "open_kfid": {
        "type": "string"
      }
    }
  }
}

Responses

200 OK

JSON
{
  "type": "object",
  "additionalProperties": true
}

Memory

GET /api/public/v1/memoriesList public Task Agent memories

Request format: No request body format specified; Response format: application/json.

Parameters

No parameters declared in the specification.

Responses

200 OK

JSON
{
  "properties": {
    "memories": {
      "items": {
        "properties": {
          "content": {
            "type": "string"
          },
          "created_at": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {},
            "type": "object"
          },
          "name": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}
POST /api/public/v1/memoriesCreate a public Task Agent memory

Request format: application/json; Response format: application/json.

Parameters

request · body · Required

JSON
{
  "description": "Memory request",
  "in": "body",
  "name": "request",
  "required": true,
  "schema": {
    "properties": {
      "content": {
        "example": "Prefer concise validation notes.",
        "type": "string"
      },
      "metadata": {
        "additionalProperties": {},
        "type": "object"
      },
      "name": {
        "example": "project-preferences",
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "memory": {
      "properties": {
        "content": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "metadata": {
          "additionalProperties": {},
          "type": "object"
        },
        "name": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
GET /api/public/v1/memories/{name}Read, update, or delete a public Task Agent memory

Request format: application/json; Response format: application/json.

Parameters

name · path · Required

JSON
{
  "description": "Memory name",
  "in": "path",
  "name": "name",
  "required": true,
  "type": "string"
}

request · body · Optional

JSON
{
  "description": "Memory request",
  "in": "body",
  "name": "request",
  "schema": {
    "properties": {
      "content": {
        "example": "Prefer concise validation notes.",
        "type": "string"
      },
      "metadata": {
        "additionalProperties": {},
        "type": "object"
      },
      "name": {
        "example": "project-preferences",
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "memory": {
      "properties": {
        "content": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "metadata": {
          "additionalProperties": {},
          "type": "object"
        },
        "name": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
PUT /api/public/v1/memories/{name}Read, update, or delete a public Task Agent memory

Request format: application/json; Response format: application/json.

Parameters

name · path · Required

JSON
{
  "description": "Memory name",
  "in": "path",
  "name": "name",
  "required": true,
  "type": "string"
}

request · body · Optional

JSON
{
  "description": "Memory request",
  "in": "body",
  "name": "request",
  "schema": {
    "properties": {
      "content": {
        "example": "Prefer concise validation notes.",
        "type": "string"
      },
      "metadata": {
        "additionalProperties": {},
        "type": "object"
      },
      "name": {
        "example": "project-preferences",
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "memory": {
      "properties": {
        "content": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "metadata": {
          "additionalProperties": {},
          "type": "object"
        },
        "name": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
PATCH /api/public/v1/memories/{name}Read, update, or delete a public Task Agent memory

Request format: application/json; Response format: application/json.

Parameters

name · path · Required

JSON
{
  "description": "Memory name",
  "in": "path",
  "name": "name",
  "required": true,
  "type": "string"
}

request · body · Optional

JSON
{
  "description": "Memory request",
  "in": "body",
  "name": "request",
  "schema": {
    "properties": {
      "content": {
        "example": "Prefer concise validation notes.",
        "type": "string"
      },
      "metadata": {
        "additionalProperties": {},
        "type": "object"
      },
      "name": {
        "example": "project-preferences",
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "memory": {
      "properties": {
        "content": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "metadata": {
          "additionalProperties": {},
          "type": "object"
        },
        "name": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
DELETE /api/public/v1/memories/{name}Read, update, or delete a public Task Agent memory

Request format: application/json; Response format: application/json.

Parameters

name · path · Required

JSON
{
  "description": "Memory name",
  "in": "path",
  "name": "name",
  "required": true,
  "type": "string"
}

request · body · Optional

JSON
{
  "description": "Memory request",
  "in": "body",
  "name": "request",
  "schema": {
    "properties": {
      "content": {
        "example": "Prefer concise validation notes.",
        "type": "string"
      },
      "metadata": {
        "additionalProperties": {},
        "type": "object"
      },
      "name": {
        "example": "project-preferences",
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "memory": {
      "properties": {
        "content": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "metadata": {
          "additionalProperties": {},
          "type": "object"
        },
        "name": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Files

GET /api/public/v1/filesList, download, or delete public workspace files

Request format: No request body format specified; Response format: application/json.

Parameters

session_id · query · Optional

JSON
{
  "description": "Session ID",
  "in": "query",
  "name": "session_id",
  "type": "string"
}

path · query · Optional

JSON
{
  "description": "Workspace directory path",
  "in": "query",
  "name": "path",
  "type": "string"
}

Responses

200 OK

JSON
{
  "properties": {
    "has_more": {
      "type": "boolean"
    },
    "items": {
      "items": {
        "properties": {
          "file_id": {
            "example": "opaque-file-id",
            "type": "string"
          },
          "id": {
            "example": "opaque-file-id",
            "type": "string"
          },
          "name": {
            "example": "report.csv",
            "type": "string"
          },
          "path": {
            "example": "uploads/upload-id/report.csv",
            "type": "string"
          },
          "relative_path": {
            "example": "uploads/upload-id/report.csv",
            "type": "string"
          },
          "session_id": {
            "type": "string"
          },
          "size_bytes": {
            "example": 1024,
            "type": "integer"
          },
          "type": {
            "example": "file",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "next_cursor": {
      "type": "string"
    }
  },
  "type": "object"
}
POST /api/public/v1/filesUpload a public Task Agent file

Request format: No request body format specified; Response format: application/json.

Parameters

file · formData · Required

JSON
{
  "description": "File",
  "in": "formData",
  "name": "file",
  "required": true,
  "type": "file"
}

Responses

201 Created

JSON
{
  "properties": {
    "file": {
      "properties": {
        "file_id": {
          "example": "opaque-file-id",
          "type": "string"
        },
        "id": {
          "example": "opaque-file-id",
          "type": "string"
        },
        "name": {
          "example": "report.csv",
          "type": "string"
        },
        "path": {
          "example": "uploads/upload-id/report.csv",
          "type": "string"
        },
        "relative_path": {
          "example": "uploads/upload-id/report.csv",
          "type": "string"
        },
        "session_id": {
          "type": "string"
        },
        "size_bytes": {
          "example": 1024,
          "type": "integer"
        },
        "type": {
          "example": "file",
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
GET /api/public/v1/files.zipDownload a public workspace ZIP

Request format: No request body format specified; Response format: application/zip.

Parameters

session_id · query · Optional

JSON
{
  "description": "Session ID",
  "in": "query",
  "name": "session_id",
  "type": "string"
}

Responses

200 Workspace ZIP

JSON
{
  "type": "file"
}
GET /api/public/v1/files/{relativePath}Download or delete a public workspace file

Request format: No request body format specified; Response format: application/octet-stream.

Parameters

relativePath · path · Required

JSON
{
  "description": "Workspace relative path",
  "in": "path",
  "name": "relativePath",
  "required": true,
  "type": "string"
}

session_id · query · Optional

JSON
{
  "description": "Session ID",
  "in": "query",
  "name": "session_id",
  "type": "string"
}

file_id · query · Required

JSON
{
  "description": "Opaque file ID",
  "in": "query",
  "name": "file_id",
  "required": true,
  "type": "string"
}

Responses

200 Workspace file

JSON
{
  "type": "file"
}
DELETE /api/public/v1/files/{relativePath}Download or delete a public workspace file

Request format: No request body format specified; Response format: application/octet-stream.

Parameters

relativePath · path · Required

JSON
{
  "description": "Workspace relative path",
  "in": "path",
  "name": "relativePath",
  "required": true,
  "type": "string"
}

session_id · query · Optional

JSON
{
  "description": "Session ID",
  "in": "query",
  "name": "session_id",
  "type": "string"
}

file_id · query · Required

JSON
{
  "description": "Opaque file ID",
  "in": "query",
  "name": "file_id",
  "required": true,
  "type": "string"
}

Responses

200 Workspace file

JSON
{
  "type": "file"
}

Connectors

GET /api/public/v1/connectors/accountsList public connector accounts

Request format: No request body format specified; Response format: application/json.

Parameters

No parameters declared in the specification.

Responses

200 OK

JSON
{
  "properties": {
    "connector_accounts": {
      "items": {
        "additionalProperties": {},
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}
GET /api/public/v1/connectors/accounts/{id}Read, update, or delete a public connector account

Request format: application/json; Response format: application/json.

Parameters

id · path · Required

JSON
{
  "description": "Connector account ID",
  "in": "path",
  "name": "id",
  "required": true,
  "type": "string"
}

request · body · Optional

JSON
{
  "description": "Connector account request",
  "in": "body",
  "name": "request",
  "schema": {
    "properties": {
      "external_account_ref": {
        "example": "connected-account-id",
        "type": "string"
      },
      "metadata": {
        "additionalProperties": {},
        "type": "object"
      },
      "provider": {
        "example": "github",
        "type": "string"
      },
      "status": {
        "example": "connected",
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "connector_account": {
      "additionalProperties": {},
      "type": "object"
    }
  },
  "type": "object"
}
PUT /api/public/v1/connectors/accounts/{id}Read, update, or delete a public connector account

Request format: application/json; Response format: application/json.

Parameters

id · path · Required

JSON
{
  "description": "Connector account ID",
  "in": "path",
  "name": "id",
  "required": true,
  "type": "string"
}

request · body · Optional

JSON
{
  "description": "Connector account request",
  "in": "body",
  "name": "request",
  "schema": {
    "properties": {
      "external_account_ref": {
        "example": "connected-account-id",
        "type": "string"
      },
      "metadata": {
        "additionalProperties": {},
        "type": "object"
      },
      "provider": {
        "example": "github",
        "type": "string"
      },
      "status": {
        "example": "connected",
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "connector_account": {
      "additionalProperties": {},
      "type": "object"
    }
  },
  "type": "object"
}
PATCH /api/public/v1/connectors/accounts/{id}Read, update, or delete a public connector account

Request format: application/json; Response format: application/json.

Parameters

id · path · Required

JSON
{
  "description": "Connector account ID",
  "in": "path",
  "name": "id",
  "required": true,
  "type": "string"
}

request · body · Optional

JSON
{
  "description": "Connector account request",
  "in": "body",
  "name": "request",
  "schema": {
    "properties": {
      "external_account_ref": {
        "example": "connected-account-id",
        "type": "string"
      },
      "metadata": {
        "additionalProperties": {},
        "type": "object"
      },
      "provider": {
        "example": "github",
        "type": "string"
      },
      "status": {
        "example": "connected",
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "connector_account": {
      "additionalProperties": {},
      "type": "object"
    }
  },
  "type": "object"
}
DELETE /api/public/v1/connectors/accounts/{id}Read, update, or delete a public connector account

Request format: application/json; Response format: application/json.

Parameters

id · path · Required

JSON
{
  "description": "Connector account ID",
  "in": "path",
  "name": "id",
  "required": true,
  "type": "string"
}

request · body · Optional

JSON
{
  "description": "Connector account request",
  "in": "body",
  "name": "request",
  "schema": {
    "properties": {
      "external_account_ref": {
        "example": "connected-account-id",
        "type": "string"
      },
      "metadata": {
        "additionalProperties": {},
        "type": "object"
      },
      "provider": {
        "example": "github",
        "type": "string"
      },
      "status": {
        "example": "connected",
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "connector_account": {
      "additionalProperties": {},
      "type": "object"
    }
  },
  "type": "object"
}
GET /api/public/v1/connectors/catalogList public connector catalog

Request format: No request body format specified; Response format: application/json.

Parameters

No parameters declared in the specification.

Responses

200 OK

JSON
{
  "properties": {
    "agent_id": {
      "type": "string"
    },
    "connection_scope": {
      "type": "string"
    },
    "connectors": {
      "items": {
        "properties": {
          "account_label": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "label": {
            "example": "GitHub",
            "type": "string"
          },
          "logo": {
            "type": "string"
          },
          "provider": {
            "example": "github",
            "type": "string"
          },
          "runtime_provider": {
            "example": "composio",
            "type": "string"
          },
          "start_url": {
            "type": "string"
          },
          "status": {
            "example": "connected",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "has_more": {
      "type": "boolean"
    },
    "limit": {
      "example": 20,
      "type": "integer"
    },
    "next_cursor": {
      "type": "string"
    },
    "profile_id": {
      "type": "string"
    },
    "search": {
      "example": "github",
      "type": "string"
    }
  },
  "type": "object"
}
GET /api/public/v1/connectors/statusList public connector status

Request format: No request body format specified; Response format: application/json.

Parameters

No parameters declared in the specification.

Responses

200 OK

JSON
{
  "properties": {
    "agent_id": {
      "type": "string"
    },
    "connection_scope": {
      "type": "string"
    },
    "connectors": {
      "items": {
        "properties": {
          "account_label": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "label": {
            "example": "GitHub",
            "type": "string"
          },
          "logo": {
            "type": "string"
          },
          "provider": {
            "example": "github",
            "type": "string"
          },
          "runtime_provider": {
            "example": "composio",
            "type": "string"
          },
          "start_url": {
            "type": "string"
          },
          "status": {
            "example": "connected",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "has_more": {
      "type": "boolean"
    },
    "limit": {
      "example": 20,
      "type": "integer"
    },
    "next_cursor": {
      "type": "string"
    },
    "profile_id": {
      "type": "string"
    },
    "search": {
      "example": "github",
      "type": "string"
    }
  },
  "type": "object"
}
POST /api/public/v1/connectors/{provider}/oauth/authorizeStart public connector OAuth authorization

Request format: application/json; Response format: application/json.

Parameters

provider · path · Required

JSON
{
  "description": "Connector provider",
  "in": "path",
  "name": "provider",
  "required": true,
  "type": "string"
}

Responses

200 OK

JSON
{
  "properties": {
    "auth_url": {
      "type": "string"
    },
    "connected_account_id": {
      "type": "string"
    }
  },
  "type": "object"
}

Secrets

GET /api/public/v1/secretsList User Secrets

Lists owned User Secret metadata. Secret values are write-only and are never returned.

Request format: No request body format specified; Response format: application/json.

Parameters

No parameters declared in the specification.

Responses

200 OK

JSON
{
  "properties": {
    "secrets": {
      "items": {
        "properties": {
          "created_at": {
            "type": "string"
          },
          "id": {
            "example": "sec_123",
            "type": "string"
          },
          "name": {
            "example": "kubeconfig",
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}
POST /api/public/v1/secretsCreate a User Secret

Creates a write-only User Secret. The response returns metadata only.

Request format: application/json; Response format: application/json.

Parameters

request · body · Required

JSON
{
  "description": "Secret request",
  "in": "body",
  "name": "request",
  "required": true,
  "schema": {
    "properties": {
      "name": {
        "example": "kubeconfig",
        "type": "string"
      },
      "value": {
        "example": "write-only",
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

201 Created

JSON
{
  "properties": {
    "secret": {
      "properties": {
        "created_at": {
          "type": "string"
        },
        "id": {
          "example": "sec_123",
          "type": "string"
        },
        "name": {
          "example": "kubeconfig",
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}
PATCH /api/public/v1/secrets/{secretID}Update a User Secret value

Replaces the write-only Secret value. The response returns metadata only.

Request format: application/json; Response format: application/json.

Parameters

secretID · path · Required

JSON
{
  "description": "Secret ID",
  "in": "path",
  "name": "secretID",
  "required": true,
  "type": "string"
}

request · body · Required

JSON
{
  "description": "Secret request",
  "in": "body",
  "name": "request",
  "required": true,
  "schema": {
    "properties": {
      "value": {
        "example": "write-only",
        "type": "string"
      }
    },
    "type": "object"
  }
}

Responses

200 OK

JSON
{
  "properties": {
    "secret": {
      "properties": {
        "created_at": {
          "type": "string"
        },
        "id": {
          "example": "sec_123",
          "type": "string"
        },
        "name": {
          "example": "kubeconfig",
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

404 Not Found

JSON
{
  "properties": {
    "code": {
      "description": "Code is the business status code (0 = success; see pkg/utils/errors.go).",
      "example": 0,
      "type": "integer"
    },
    "message": {
      "description": "Message is a human-readable status or error description.",
      "example": "ok",
      "type": "string"
    }
  },
  "type": "object"
}
DELETE /api/public/v1/secrets/{secretID}Delete a User Secret

Request format: No request body format specified; Response format: application/json.

Parameters

secretID · path · Required

JSON
{
  "description": "Secret ID",
  "in": "path",
  "name": "secretID",
  "required": true,
  "type": "string"
}

Responses

204 No Content

404 Not Found

JSON
{
  "properties": {
    "code": {
      "description": "Code is the business status code (0 = success; see pkg/utils/errors.go).",
      "example": 0,
      "type": "integer"
    },
    "message": {
      "description": "Message is a human-readable status or error description.",
      "example": "ok",
      "type": "string"
    }
  },
  "type": "object"
}

409 Conflict

JSON
{
  "properties": {
    "code": {
      "description": "Code is the business status code (0 = success; see pkg/utils/errors.go).",
      "example": 0,
      "type": "integer"
    },
    "message": {
      "description": "Message is a human-readable status or error description.",
      "example": "ok",
      "type": "string"
    }
  },
  "type": "object"
}

Discover WeChat customer service accounts

After creating a WeChat channel draft and completing WeCom authorization, call POST /api/public/v1/channels/{connection_id}/wechat-kf/accounts with a Profile API key granting channels:write. Write includes read. Single-Agent conversation keys cannot use this endpoint.

Request body (replace the Secret placeholder only through protected client arguments, never prompts or logs):

{"corp_secret":"<APPLICATION_SECRET>"}

Successful response (200):

{"accounts":[{"open_kfid":"wk-example","name":"Customer support","manage_privilege":true}]}

Select by name from accounts with manage_privilege: true. One manageable account may be preselected; several require a user choice. An empty list is valid. Discovery does not save the Secret or change bindings. Confirm setup with PATCH /api/public/v1/channels/{connection_id}/wechat-kf, sending the same corp_secret and selected open_kfid; the server rechecks management permission.

For 400/422 wechat_credentials_invalid, check the application Secret and company ID. For 422 wechat_permission_denied, authorize the application for customer-service APIs. For 422 wechat_ip_not_allowed, configure trusted outbound IPs. Retry 422/502 wechat_accounts_unavailable. Check API-key authentication/scopes for 401/403, channel ownership for 404, and channel account initialization for 409.

Meet HastLearn about Hast AIP, Hast Agent, Hast GTM, and delivery with the FDE team.About AIPConfigure Agents and connect business systems using the FDE delivery workbench.Create your first AgentConfigure, save, and debug an Agent without external services.Configure and manage AgentsSet responsibilities, models, and capabilities, and maintain the active configuration.Manage SkillsWrite, import, and select the skill files used by Agents.Add a knowledge baseIndex URLs or files so an Agent can retrieve information from them.Manage business secretsStore credentials and bind them to Agents without exposing real values in examples.Connect business toolsLet Agents call HTTP services with explicit inputs and authentication.Configure long-term memoryChoose what memory an Agent can read and where new memory is written.Debug an AgentTest saved configurations, conversation continuity, and tool results.Import, export, and copyReuse configurations and recheck resources and credentials after migration.HTTP integrationInvoke an Agent from your server, continue conversations, read replies, and stop execution.MCP integrationConnect external Agent clients to AIP tools with a Public API Key.About Task AgentPlan, execute, and deliver complete tasks with tools, files, and lasting context.Complete your first taskSubmit a request, review the plan, and inspect the final output.Plan, execute, and manage conversationsRefine plans, stop execution, and manage conversation history.Upload, view, and download filesProvide inputs and keep the files created by your tasks.Connect apps and configure capabilitiesAuthorize external apps and maintain context across tasks.Create scheduled tasksSet recurrence and timezone, then inspect each run's result.Task Agent troubleshootingCheck access, connections, task state, and files.API quickstartCreate a key, submit a task, and read execution results.Event streamingRead SSE frames, resume after disconnection, and interpret Event v2.API referenceExplore public endpoint parameters, authentication, and response schemas.About GTMUse a shared website project for research, visibility analysis, and marketing drafts.Create your first GTM projectEnter a website, wait for initialization, and inspect the first results.Manage projects and website contextSwitch projects, refresh site information, and manage project settings.Company analysis and project documentsReview product, competitor, and marketing context before content tasks.SEO and website performanceRead PageSpeed reports for mobile and desktop.AI brand mentionsInspect buyer questions and whether model answers mention your brand.Connect Google AnalyticsAuthorize an account, choose a GA property, and inspect traffic reports.Generate and publish X draftsCreate posts, review previews, and finish publishing on X.Generate article draftsSet style, language, and audience, then review and copy Markdown.Use Growth AgentRead project context or start supported background operations in conversation.Run status and troubleshootingCheck queueing, dependencies, and results without treating unfinished work as missing data.Plans and usageCheck access, consumption, and billing for the current Profile.