CustomGPT
  1. 页数
CustomGPT
  • 快速入门
  • 错误处理
  • 术语
  • 项目
    • 列出所有项目
      GET
    • 创建一个新项目
      POST
    • 展示某个项目
      GET
    • 更新某个项目
      GET
    • 删除某个项目
      DELETE
    • 获取某个项目的统计数据
      GET
  • 页数
    • 列出属于某个项目的所有页面
      GET
    • 删除属于某个项目的某个页面
      DELETE
    • 重新索引属于某个项目的某个页面
      POST
    • 预览引文中的文件
      GET
  • 页面元数据
    • 获取特定页面的元数据
      GET
    • 更新特定页面的元数据
      PUT
  • 项目设置
    • 获取项目设置
      GET
    • 更新项目设置
      POST
  • 项目插件
    • 显示某个项目插件
      GET
    • 创建一个插件
      POST
    • 更新一个插件
      PUT
  • 对话
    • 列出项目的所有对话
      GET
    • 创建一个新对话
      POST
    • 更新一个对话
      PUT
    • 删除对话
      DELETE
    • 检索对话中已发送的消息
      GET
    • 向对话发送消息
      POST
  • 引文
    • 获取 Open Graph 数据以供引用
  • 来源
    • 列出某个项目的来源
    • 创建一个新的项目源
    • 更新项目源设置
    • 删除项目源
  • 用户
    • 显示用户的个人资料
    • 更新用户的个人资料
  1. 页数

列出属于某个项目的所有页面

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
api/v1/projects/{projectId}/pages
检索与项目关联的所有页面的列表。此端点允许您获取项目详细信息和属于特定项目的页面集合。每个页面对象包括页面 ID、URL、URL 哈希、项目 ID、爬网状态、索引状态、文件详细信息(如果适用)、创建和更新时间戳以及其他相关属性等信息。以下是列出属于项目API SDK
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://dev-cn.your-api-server.comapi/v1/projects//pages?page=1&duration=90&order=desc' \
--header 'authorization;'
响应示例响应示例
200 - 成功示例
{
  "status": "success",
  "data": {
    "project": {
      "id": 1,
      "project_name": "My Project",
      "sitemap_path": "https://www.example.com/sitemap.xml",
      "is_chat_active": true,
      "user_id": 1,
      "team_id": 1,
      "created_at": "2021-01-01 00:00:00",
      "updated_at": "2021-01-01 00:00:00",
      "deleted_at": "2021-01-01 00:00:00",
      "type": "SITEMAP",
      "is_shared": true,
      "shareable_slug": "1234567890abcdef1234567890abcdef",
      "shareable_link": "string",
      "embed_code": "string",
      "live_chat_code": "string"
    },
    "pages": {
      "current_page": 1,
      "data": [
        {
          "id": 1,
          "page_url": "https://example.com",
          "page_url_hash": "d41d8cd98f00b204e9800998ecf8427e",
          "project_id": 1,
          "s3_path": "project-1/page-1/file.pdf",
          "crawl_status": "queued",
          "index_status": "queued",
          "is_file": true,
          "is_file_kept": true,
          "filename": "file.pdf",
          "filesize": 100,
          "created_at": "2021-01-01 00:00:00",
          "updated_at": "2021-01-01 00:00:00",
          "deleted_at": "2021-01-01 00:00:00"
        }
      ],
      "first_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
      "from": 1,
      "last_page": 1,
      "last_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
      "next_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
      "path": "https://app.customgpt.ai/api/v1/users?page=1",
      "per_page": 10,
      "prev_page_url": "https://app.customgpt.ai/api/v1/users?page=1",
      "to": 1,
      "total": 1
    }
  }
}

请求参数

Path 参数
projectId
string 
必需
唯一的项目标识符。
Query 参数
page
string 
返回的页码
可选
示例值:
1
duration
string 
可选
要列出的项目的持续时间。默认为 90 天。
示例值:
90
order
string 
可选
项目列出的顺序。默认为描述。
示例值:
desc
Header 参数
authorization
string 
必需
Bearer Your_API_KEY

返回响应

🟢200成功
application/json
Body
status
string 
必需
data
object 
必需
project
object 
必需
pages
object 
必需
🟠400请求有误
🟠401没有权限
🟠404记录不存在
🔴500服务器错误
修改于 2024-02-22 03:40:18
上一页
获取某个项目的统计数据
下一页
删除属于某个项目的某个页面
Built with