PUDU_API_APP_KEY

PUDU_API_APP_SECRET

The following credentials are missing. Please provide them via one of the following methods:

Method 1 (Recommended): Set environment variables

bash

export PUDU_API_APP_KEY="your-key"
export PUDU_API_APP_SECRET="your-secret"

Method 2: Tell me directly Please enter your ApiAppKey and ApiAppSecret.

If you don't have credentials yet Please visit Pudu Open Platform Quick Start and follow the tutorial to apply.

• Prioritize suggesting users to provide credentials via environment variables instead of pasting directly in the conversation
• If the user provides

  ApiAppSecret

  directly, do not echo the full value in replies, logs, error messages, or sample code
• Do not write the user-provided

  ApiAppKey

  /

  ApiAppSecret

  into repository files, script constants, or sample code
• When troubleshooting, only display the desensitized form, e.g.,

  abc***xyz

params

parameters

requestBody

• shopId

  /

  shop_id

  /

  shop-id

  → Convert to

  shopId

  or

  shop_id

  according to the current interface specification

• groupId

  /

  group_id

  /

  group-id

  → Convert to

  groupId

  or

  group_id

  according to the current interface specification

• payload.startPoint

  /

  payload.start_point

  /

  payload.start-point

  → Convert to real nested field names according to the schema

• Build a whitelist of field names using the current interface specification; do not decide the final field names based on common sense
• Ignore case,

  _

  and

  -

  when matching, but the final output must retain the original field name format in the specification
• Apply the same rules recursively to objects and array objects in the request body
• Only convert field names, do not change field values
• If the same input field can match multiple specification fields, or the field is not in the specification, confirm with the user first; do not send unknown fields directly to the interface

1. scripts/pudu-request.js

2. scripts/pudu-request.py

3. scripts/pudu-request.go

4. scripts/pudu-request.java

5. scripts/pudu-request.cs

pudu-request.js

const { request } = require("./scripts/pudu-request");

const result = await request({
  cluster:      process.env.PUDU_API_CLUSTER,   // Or explicitly pass "cn" / "sea" / "de" / "us"
  path:         "/pudu-entry<path read from specification file>",
  method:       "<GET or POST>",
  params:       { /* Parameters extracted from user prompt and specification file */ },
  apiAppKey:    process.env.PUDU_API_APP_KEY,
  apiAppSecret: process.env.PUDU_API_APP_SECRET,
});

if (result.ok) {
  console.log(result.json);
} else {
  console.error(result.errorMessage);
}

• request()

  will first read

  PUDU_API_APP_KEY

  ,

  PUDU_API_APP_SECRET

  ,

  PUDU_API_CLUSTER

  from environment variables
• If

  apiAppKey

  /

  apiAppSecret

  /

  cluster

  /

  hostname

  are explicitly passed, the explicit parameters will take precedence

• path

  must include the

  /pudu-entry

  prefix, e.g.,

  /pudu-entry/open-platform-service/v2/status/get_by_sn

  (if the interface is a statistical interface for

  /data-board

  , the path will be similar to

  /pudu-entry/data-board/v1/analysis/run

  , etc., subject to the specification file)

• params

  needs to be built based on both the user prompt and the OpenAPI specification file; do not guess fields only by natural language; must complete parameter name normalization before sending the request to ensure all field names are completely consistent with the specification
• When the interface requires

  sn

  , if the value passed by the user is in the format of

  14:80:CC:89:27:A6

  , it should be judged as a MAC address instead of SN, and the user should be actively reminded to provide the real robot SN

1. HTTP status code is

   200

2. message === "SUCCESS"

   in the returned result

{
  "data": {
    "count": 110,
    "list": [
      {
        "company_id": "13947",
        "company_name": "chixzdls_internal02二级代理商",
        "shop_id": "324100000",
        "shop_name": "【10月08日】出尘门店"
      },
      {
        "company_id": "13947",
        "company_name": "chixzdls_internal02二级代理商",
        "shop_id": "325300001",
        "shop_name": "闪电匣和很多葫芦"
      }
    ]
  },
  "message": "SUCCESS",
  "trace_id": "YourApiAppKey_405eb004-7f09-4d86-bff1-4657cdec2717"
}

• HTTP status code is not

  200

• HTTP status code is

  200

  , but

  message !== "SUCCESS"

❌ Call Failed (HTTP 401)

Interface: GET /open-platform-service/v2/status/get_by_sn

Error Cause: Unauthorized — ApiAppKey or signature verification failed, please check if the credentials are correct.

• v2 interfaces take precedence over older versions (e.g.,

  status/get_by_sn

  ), please use v2 for

  recharge

  as the status fields are more concise
• Interfaces marked with

  (Flash Cabinet)

  are only applicable to robot models with cabinets

• sn

  is the robot serial number,

  shopId

  is the store ID, which are the most commonly used identification fields
• MAC addresses are commonly in the format of

  14:80:CC:89:27:A6

  ; if the interface requires

  sn

  , do not directly use a MAC address instead
• Tasks such as delivery, transport, errand, lifting have corresponding

  *_action

  interfaces for pause/resume/cancel
• If the user intends to write an Open API request SDK, according to the programming language specified by the user, refer to

  references/request-sdk.md

  and output a standard implementation example in the corresponding language.