GET
/
embed
/
api
/
workflows
/
{workflowName}
/
site
读取公开入口元信息
curl --request GET \
  --url https://wfapi.yuhe.space/embed/api/workflows/{workflowName}/site \
  --header 'x-workflow-embed-token: <api-key>'
{
  "errCode": 123,
  "errMessage": "<string>",
  "data": {
    "workflowId": "<string>",
    "workflowName": "<string>",
    "title": "<string>",
    "description": "<string>",
    "target": "<string>",
    "resolvedTarget": "<string>",
    "projectCard": {
      "iconBackgroundColor": "<string>",
      "iconUrl": "<string>"
    },
    "conversationEnabled": true,
    "params": [
      "<unknown>"
    ],
    "structure": {
      "workflowId": "<string>",
      "workflowName": "<string>",
      "target": "<string>",
      "resolvedTarget": "<string>",
      "structure": {}
    },
    "viewer": {
      "userId": "<string>",
      "displayName": "<string>",
      "email": "jsmith@example.com",
      "avatarUrl": "<string>"
    },
    "tokenUsage": {}
  }
}

Authorizations

​
x-workflow-embed-token
string
header
required

Embed token；也可通过 query/body 的 token 传入。

Path Parameters

​
workflowName
string
required

Query Parameters

​
token
string

Response

200 - application/json

公开入口元信息。

​
errCode
integer
required
​
errMessage
string
required
Allowed value: ""
​
data
object
required