> ## 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.

# GEOBase 开发者 API

> 将 GEOBase 已监测的品牌、竞品、AI 对话问题与引用来源数据接入业务系统、看板或自动化流程。

GEOBase 开发者 API 面向企业与开发者提供标准化的数据读取能力，覆盖品牌资产、竞品、AI 对话问题、引用来源与 AI 平台表现五类数据。所有开放接口使用统一实时入口，通过 `apiCode` 选择业务能力，再在 `data` 中提交该能力需要的参数。

<CardGroup cols={3}>
  <Card title="统一入口" icon="route">
    所有开放 API 共用一个 POST 地址，减少不同数据域之间的接入差异。
  </Card>

  <Card title="apiCode 路由" icon="braces">
    `apiCode` 指定实际调用的业务能力，接口页面定义对应参数。
  </Card>

  <Card title="全实时返回" icon="zap">
    全部接口均为 SYNC 实时请求，一次调用直接返回业务结果，无任务轮询。
  </Card>
</CardGroup>

<Info>
  **当前开放能力：** 开发者 API 已开放 13 个业务接口，全部为 SYNC · 实时请求 —— [品牌列表查询](/geobase-api/api-reference/brand-list)、[竞品列表查询](/geobase-api/api-reference/competitor-list)、[品牌主题列表查询](/geobase-api/api-reference/brand-topics)、[AI 对话问题列表查询](/geobase-api/api-reference/prompt-list)、[AI 对话问题监测明细](/geobase-api/api-reference/prompt-analysis-detail)、[AI 对话问题总览](/geobase-api/api-reference/prompt-analysis-overview)、[引用 URL 明细列表](/geobase-api/api-reference/citation-url-list)、[品牌总览汇总](/geobase-api/api-reference/brand-overview)、[平台趋势对比](/geobase-api/api-reference/platform-trend)、[平台对比](/geobase-api/api-reference/platform-comparison)、[平台业务主题分布](/geobase-api/api-reference/platform-topic-distribution)、[平台场景意图分布](/geobase-api/api-reference/platform-intent-distribution)、[平台 AI 问题排名表现](/geobase-api/api-reference/platform-prompt-ranking)。
</Info>

<Tip>
  **与 AIBase 开发者文档的关系：** 两者同属 AIBase 开放平台体系，共用 `AIBase-API-Key` 鉴权体系与 `AIBase-Request-Id` 追踪机制，但入口与执行模式不同 —— AIBase 开发者 API 入口为 `/v1/openapi/tasks`（含异步任务），GEOBase 开发者 API 入口为 `/v1/openapi/execute`（全部实时）。接入前请先确认目标 `apiCode` 属于哪一套。
</Tip>

<Card title="让 Agent 使用 GEOBase 监测数据" icon="bot" href="/geobase-api/agent-skill/index" horizontal>
  从 7 个可独立安装的 Agent Skill 中选择任务入口，并查看 80 条提问示例、10 个编排案例和可复制的总指令。
</Card>

## 五分钟完成首次调用

<Steps>
  <Step title="创建 API Key">
    前往 [GEOBase 开发者中心](https://geoservice.aibase.com/developer)生成并妥善保存 `AIBase-API-Key`，可同时配置有效期与 IP 白名单。
  </Step>

  <Step title="配置身份认证">
    在请求 Header 中设置 `AIBase-API-Key` 和 `Content-Type: application/json`。
  </Step>

  <Step title="发送第一条请求">
    向统一入口提交 `apiCode`（例如 `geo.brand`）及业务参数。
  </Step>

  <Step title="读取业务结果">
    先判断外层 `code` 是否为 `200`，再从响应体的 `data` 读取业务数据（分页接口读取 `data.records`）。
  </Step>
</Steps>

## 统一入口

```http theme={null}
POST https://geobaseapi.aibase.com/v1/openapi/execute
```

<Note>
  不同 `apiCode` 的 `data` 请求结构与返回结构不同：`data` 可能是分页对象、数组、对象或按名称分组的映射结构。组装请求前，请进入对应的业务 API 页面核对字段。
</Note>

## 选择下一步

<CardGroup cols={3}>
  <Card title="统一鉴权" icon="key-round" href="/geobase-api/quickstart/authentication">
    了解请求头设置、服务端校验顺序与权限校验规则。
  </Card>

  <Card title="实时请求模式" icon="zap" href="/geobase-api/quickstart/sync-mode">
    了解 SYNC 实时调用机制、超时建议与无轮询特性。
  </Card>

  <Card title="响应与错误码" icon="triangle-alert" href="/geobase-api/quickstart/response-errors">
    掌握统一响应结构与 2001 / 4001 / 4002 / 403 / 4021 / 500 处理分支。
  </Card>

  <Card title="品牌列表查询" icon="building-2" href="/geobase-api/api-reference/brand-list">
    从账号下的品牌资产列表开始，获取后续接口需要的 `brandId`。
  </Card>

  <Card title="cURL 调用示例" icon="terminal" href="/geobase-api/examples/curl">
    复制即用的一次完整调用示例。
  </Card>

  <Card title="常见问题" icon="messages-square" href="/geobase-api/platform/faq">
    地址相同、同步异步、data 结构差异等高频疑问。
  </Card>
</CardGroup>


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