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
返回您的项目列表。返回的项目按创建日期排序,最近的项目首先出现。它是一个分页 API,您可以使用 page 参数来获取项目的下一页。默认页面大小为 10。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://dev-cn.your-api-server.com/api/v1/projects?page=1&order=desc&orderBy=id&width=100%25&height=auto' \
--header 'authorization;'
响应示例响应示例
200 - 成功示例
{
  "status": "success",
  "data": {
    "current_page": 1,
    "data": [
      {
        "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"
      }
    ],
    "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
  }
}

请求参数

Query 参数
page
string 
返回的页码
可选
示例值:
1
order
string 
可选
项目列出的顺序。默认为描述。
示例值:
desc
orderBy
string 
可选
orderBy 按给定字段对结果进行排序
示例值:
id
width
string 
可选
嵌入代码的宽度。默认为 100%。
示例值:
100%25
height
string 
可选
嵌入代码的高度。默认为 100%。
示例值:
auto
Header 参数
authorization
string 
必需
Bearer Your_API_KEY

返回响应

🟢200成功
application/json
Body
status
string 
响应状态
必需
data
object 
必需
current_page
integer 
当前页码
必需
data
array [object {15}] 
必需
first_page_url
string 
第一页网址
必需
from
integer 
当前页的第一项编号
必需
last_page
integer 
最后页码
必需
last_page_url
string 
最后一页的网址
必需
next_page_url
string 
下一页网址
必需
path
string 
当前页面网址
必需
per_page
integer 
每页的项目数
必需
prev_page_url
string 
上一页的网址
必需
to
integer 
必需
当前页的最后一项编号
total
integer 
商品总数
必需
🟠401没有权限
🔴500服务器错误
修改于 2024-02-22 02:54:45
上一页
术语
下一页
创建一个新项目
Built with