CustomGPT

展示某个项目

开发环境

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

必需

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

创建一个新项目

更新某个项目