Consultar Linhas

Consultar linhas com um predicado tipado, uma especificação de ordenação ordenada e paginação por cursor opaco. As páginas limitadas têm teto de 5MB por padrão e podem conter menos linhas que o limite solicitado; continue até que nextCursor seja null. Um predicado maior que o teto do corpo da requisição é um 413.

POST/api/v2/tables/{tableId}/query
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 path

tableId*string

Identificador único da table.

Tamanho1 <= length

Corpo da requisição

application/json

Workspace scope, optional predicate and sort, and cursor pagination controls. The predicate may be one condition or an all/any group; omitting it matches every row.

Definições TypeScript

Use o tipo request body no TypeScript.

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://agent-studio.seeyu.ai/api/v2/tables/string/query" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "string"  }'
{
  "data": [
    {
      "id": "string",
      "data": {
        "email": "jane@example.com",
        "name": "Jane Doe",
        "age": 30
      },
      "runState": {
        "property1": {
          "status": "string",
          "executionId": "string",
          "workflowId": "string",
          "error": "string",
          "runningBlockIds": [
            "string"
          ],
          "blockErrors": {
            "property1": "string",
            "property2": "string"
          },
          "canceledAt": "2019-08-24T14:15:22Z"
        },
        "property2": {
          "status": "string",
          "executionId": "string",
          "workflowId": "string",
          "error": "string",
          "runningBlockIds": [
            "string"
          ],
          "blockErrors": {
            "property1": "string",
            "property2": "string"
          },
          "canceledAt": "2019-08-24T14:15:22Z"
        }
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "nextCursor": "string"
}
{
  "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": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Request body must be sent as application/json"
  }
}
{
  "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"
  }
}