> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aibase.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 品牌主题列表查询

> 查询指定品牌下的监控主题列表（如“品牌口碑”“产品对比”等业务主题）。

查询指定品牌下的监控主题列表（如“品牌口碑”“产品对比”等业务主题）。返回结构为数组而非分页，按创建时间倒序排列。

<Info>
  **执行模式：SYNC · 实时请求。**
  请求发出后服务端同步执行业务，结果直接在当前响应的 `data` 中返回，不存在异步任务、无需轮询、无需二次查询。
</Info>

## 接口速查

| 项目 | 当前接口约定 |
| - | - |
| 接口状态 | 已上线 |
| 请求方式 | `POST` |
| 请求地址 | `https://geobaseapi.aibase.com/v1/openapi/execute` |
| 业务标识 | `brand.topic` |
| 执行模式 | **SYNC · 实时请求**（直接返回，无需轮询） |
| 身份认证 | Header `AIBase-API-Key` |
| 请求格式 | `application/json` |
| 返回结构 | 数组结构 |

## 请求头

<ParamField header="AIBase-API-Key" type="string" required>
  开发者 API Key，例如 `AIBase_xxx`。用于身份认证、有效期与调用权限校验，请仅在服务端保存和使用。
</ParamField>

<ParamField header="Content-Type" type="string" required>
  固定为 `application/json`。
</ParamField>

<ParamField header="AIBase-Request-Id" type="string">
  开发者自定义请求 ID，用于请求追踪；不传时系统自动生成 UUID。
</ParamField>

## 请求体

<ParamField body="apiCode" type="string" required>
  固定为 `brand.topic`
</ParamField>

<ParamField body="data.brandId" type="string" required>
  所属品牌 ID，为空返回 `4001`
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl --location 'https://geobaseapi.aibase.com/v1/openapi/execute' \
    --header 'Content-Type: application/json' \
    --header 'AIBase-API-Key: AIBase_xxxxxxxxxxxxxxxx' \
    --header 'AIBase-Request-Id: req-20260924-001' \
    --data '{
      "apiCode": "brand.topic",
      "data": {
        "brandId": "brand-001"
      }
    }'
  ```

  ```python Python theme={null}
  import os
  import requests

  api_key = os.environ["AIBASE_API_KEY"]
  headers = {
      "AIBase-API-Key": api_key,
      "Content-Type": "application/json",
      "AIBase-Request-Id": "req-20260924-001",
  }

  res = requests.post(
      "https://geobaseapi.aibase.com/v1/openapi/execute",
      headers=headers,
      json={"apiCode": "brand.topic", "data": {"brandId": "brand-001"}},
      timeout=60,
  )
  res.raise_for_status()
  payload = res.json()

  if payload["code"] == 200:
      print(payload["data"])
  ```

  ```javascript Node.js theme={null}
  const res = await fetch("https://geobaseapi.aibase.com/v1/openapi/execute", {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "AIBase-API-Key": process.env.AIBASE_API_KEY,
      "AIBase-Request-Id": "req-20260924-001",
    },
    body: JSON.stringify({"apiCode": "brand.topic", "data": {"brandId": "brand-001"}}),
  });

  const payload = await res.json();
  if (payload.code === 200) {
    console.log(payload.data);
  }
  ```

  ```java Java theme={null}
  String body = """
  {
    "apiCode": "brand.topic",
    "data": {
      "brandId": "brand-001"
    }
  }
  """;

  HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://geobaseapi.aibase.com/v1/openapi/execute"))
      .header("Content-Type", "application/json")
      .header("AIBase-API-Key", "AIBase_xxxxxxxxxxxxxxxx")
      .header("AIBase-Request-Id", "req-20260924-001")
      .POST(BodyPublishers.ofString(body))
      .build();

  HttpResponse<String> response = HttpClient.newHttpClient()
      .send(request, BodyHandlers.ofString());
  System.out.println(response.body());
  ```
</RequestExample>

## 返回参数

业务结果位于 `data`，为数组结构，数组元素包含主题 `id` 与 `topicName`。

<ResponseField name="data" type="object[]">
  品牌主题列表，无主题时为空数组。
</ResponseField>

<ResponseField name="data[].id" type="string">
  主题唯一标识，可传入 `brand.prompt` 等接口筛选。
</ResponseField>

<ResponseField name="data[].topicName" type="string">
  主题名称。
</ResponseField>

<ResponseExample>
  ```json 200 (成功响应) theme={null}
  {
    "code": 200,
    "msg": "成功",
    "data": [
      { "id": "topic-001", "topicName": "品牌口碑" },
      { "id": "topic-002", "topicName": "产品对比" }
    ],
    "timeStamp": 1788830174812
  }
  ```
</ResponseExample>

## 接入注意事项

1. `apiCode` 必须固定为 `brand.topic`。
2. `brandId` 为必填参数，为空返回 `4001`（所需参数不足）。
3. 返回结构为数组（非分页对象），按创建时间倒序排列。
4. 无主题数据时返回空数组，不代表调用失败。
5. 主题 ID 可继续用于 `brand.prompt`、`prompt.analysis.detail` 等接口的筛选条件。

<AccordionGroup>
  <Accordion title="Java 返回对象">
    ```java theme={null}
    public class TopicItem {
        private String id;
        private String topicName;
    }
    ```

    完整响应类型可表示为 `ReturnResult<List<TopicItem>>`。
  </Accordion>

  <Accordion title="TypeScript 类型">
    ```typescript theme={null}
    export interface TopicItem {
      id: string;
      topicName: string;
    }
    ```

    可按以下 TypeScript 类型定义解析响应数据。
  </Accordion>
</AccordionGroup>

<Note>
  本页的 cURL 与 Java 示例来自官方接口文档；Python 与 Node.js 示例为等价转写，未经服务端联调，请以实际返回结果为准。
</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.