Listar Workflows

Listar workflows de um workspace com filtros de pasta e de deployment, busca, ordenação e paginação por cursor opaco. Uma árvore de pastas do workspace com mais de 10.000 pastas é um 413.

GET/api/v2/workflows

Authorization

X-API-Key<token>

Sua API key do Studio, pessoal ou com escopo de workspace. Gere uma em Settings e depois API Keys. As operações que rejeitam API keys de workspace dizem isso na própria descrição.

Em: header

Parâmetros de query

workspaceId*string

Workspace cujos workflows devem ser listados.

Tamanho1 <= length <= 128
scope?string

Which lifecycle set to list: active (default) for live workflows, archived for workflows a DELETE archived. The folder filter resolves against active folders only, so pairing it with archived returns an empty page when the containing folder was archived too.

Padrão"active"
Valor em"active" | "archived"
folderPath?Folder path input

Restrict results to workflows in this folder path. Unknown folder paths contribute no matches.

Tamanholength <= 4096
deployedOnly?boolean

Retornar apenas workflows com deployment ativo quando true.

limit?integer

Máximo de workflows a retornar por página. Deve ser um número inteiro de 1 a 100. O padrão é 50.

Padrão50
Intervalo1 <= value <= 100
cursor?string

Cursor opaco da página anterior. Devolva-o com a mesma ordenação e os mesmos filtros; apenas limit pode mudar. Altere qualquer outra coisa e a paginação precisa recomeçar sem cursor.

Tamanho1 <= length
search?string

Correspondência de substring com o nome do recurso, sem diferenciar maiúsculas de minúsculas.

Tamanho1 <= length <= 200
sortBy?string

Campo usado para ordenar o resultado. A ordenação por name diferencia maiúsculas de minúsculas e segue a collation do armazenamento, então não conte com uma ordem que ignore maiúsculas e minúsculas.

Padrão"position"
Valor em"position" | "name" | "createdAt" | "updatedAt" | "runCount"
sortOrder?string

Direção da ordenação.

Padrão"asc"
Valor em"asc" | "desc"

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://agent-studio.seeyu.ai/api/v2/workflows?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
      "webUrl": "https://agent-studio.seeyu.ai/workspace/a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64/w/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
      "name": "Customer support triage",
      "description": "Roteia as solicitações de suporte recebidas para a equipe certa.",
      "folderPath": "/Operations",
      "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",
      "isDeployed": true,
      "deployedAt": "2026-06-12T10:30:00.000Z",
      "runCount": 42,
      "lastRunAt": "2026-08-09T18:04:11.000Z",
      "createdAt": "2026-05-01T09:00:00.000Z",
      "updatedAt": "2026-08-09T18:04:11.000Z"
    }
  ],
  "nextCursor": null
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}
TypeScriptPOSTCriar Workflow