API Overview

Please create an API Key before using the API.

Authentication

All Palm X interfaces are authenticated with an API Key over HTTPS Bearer Auth.

Item	Value
Security scheme type	https
HTTP authorization scheme	bearer
Credential	API Key (ak_ prefix)

Apply for an API Key in the developer console:

🔑 https://palm.tencent.com/developer/api-keys

Send the key in every request header:

Authorization: Bearer ak_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

⚠️ The API Key is a server-side credential. Never embed it in client-side code, public repositories, or mobile app packages. If leaked, delete and regenerate it in the console immediately.

Common Conventions

Item	Value
Endpoint host	https://open.intl.palm.tencent.com
URL pattern	POST /palm/openai/<interface>
Content-Type	application/json; charset=utf-8
Field naming	PascalCase (e.g. UserId, RgbImage)
Image payload	Base64-encoded string in RgbImage.Data

All interfaces return a unified response envelope:

{
  "code": 0,
  "message": "ok",
  "requestId": "4d5912a82af144f8a982c2da031c1035",
  "data": {}
}

Field	Type	Description
code	Integer	Business error code. 0 = success; non-zero = failure, see Error Codes
message	String	Error description ("ok" on success)
requestId	String	Unique request ID — always provide it when reporting issues
data	Object	Business payload (see each interface page)

Functional Classification

Palmprint Management Interfaces (RGB)

Interface	Function	Rate Limit (req/sec/AppId)
RegisterRgbPalm	Register RGB palmprint	20
CompareRgbPalm	Compare RGB palmprint (1:1)	20
SearchRgbPalm	Search RGB palmprint (1:N)	20
DeletePalm	Delete palmprint	20

Rate Limits

• Default rate limit: 20 requests/sec per interface (counted independently per credential).
• When the rate limit is exceeded, the API returns HTTP 429 or business error code 2060002 (too many requests). Lower your QPS; contact the official team to request a higher limit.
• Capacity-related business error codes (e.g. 2080014, 2080020) indicate the palmprint gallery is full — contact the official team to request an expansion, or delete unused palmprints first. See Error Codes.

Trial & Payment: Palm X is free to use for 90 days after application creation. After 90 days, call-count and palmprint-capacity limits apply; purchasing a License removes these limits. Specific pricing rules will be announced officially at a later date.