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}
根据项目的唯一项目 ID 检索项目的详细信息。此端点允许您获取有关项目的特定信息。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://dev-cn.your-api-server.comapi/v1/projects/ ?width=100%25&height=auto' \
--header 'authorization;'
响应示例响应示例
200 - 成功示例
{
  "status": "success",
  "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"
  }
}

请求参数

Path 参数
projectId
string 
必需
唯一的项目标识符。
Query 参数
width
string 
可选
嵌入代码的宽度。默认为 100%。
示例值:
100%25
height
string 
可选
嵌入代码的高度。默认为 100%。
示例值:
auto
Header 参数
authorization
string 
必需
Bearer Your_API_KEY

返回响应

🟢200成功
application/json
Body
status
string 
必需
data
object 
必需
id
integer 
必需
project_name
string 
必需
sitemap_path
string 
必需
is_chat_active
boolean 
必需
user_id
integer 
必需
team_id
integer 
必需
created_at
string 
必需
updated_at
string 
必需
deleted_at
string 
必需
type
string 
必需
is_shared
boolean 
必需
shareable_slug
string 
必需
shareable_link
string 
必需
embed_code
string 
必需
live_chat_code
string 
必需
🟠400请求有误
🟠401没有权限
🟠404记录不存在
🔴500服务器错误
修改于 2024-02-22 02:54:52
上一页
创建一个新项目
下一页
更新某个项目
Built with