API reference · v1
Suggest identifier names for concepts
Suggest English identifier names for up to 30 concepts described in natural language (Chinese, English or another supported language). Each candidate is returned as a list of lowercase words, plus an optional list of abbreviations of the same length, so the caller can apply camelCase, snake_case, PascalCase, kebab-case or SCREAMING_SNAKE_CASE itself. An optional reference list of names the project already uses keeps new names consistent. Only the concept text, kind and reference names are sent to the model provider; nothing is stored or logged. Concepts the model does not answer validly are listed in failedIds. Each admitted request consumes 3 usage units, including upstream failures. Requires a credential with tools.run; every accepted call consumes 3 monthly units and 3 units of the per-minute rate limit, including business 4xx/5xx. Sensitive: request bodies are processed in memory only and are never stored, logged or hashed into usage records.
/v1/run/naming/suggestAccess requirements
Health, metadata, changelog and waitlist routes are public. Catalog reads (GET /v1/tools, /v1/tools/{id}, /v1/colors/*) and POST /v1/tools/query require a tools.read credential; POST /v1/run/* requires tools.run. There is no anonymous access to these routes: send an API key (Bearer OR X-API-Key) from your server, or use the HttpOnly main-site session plus workspace selection and same-origin Origin. Never combine credentials. Every admitted call is metered. Ingress and workspace/actor minute/month limits are separate; waitlist has its own policy.
Implemented interfaces and development screens do not imply public production availability, paid access or a completed payment integration. Confirm access with Birdor before connecting an application. No paid Pro service, activation or cross-device sync is currently delivered. We are validating one repeatable task before building a paid offer.
Parameters
| Field | Description |
|---|---|
AuthorizationstringOptional | Bearer API key with tools.run; alternatively X-API-Key. One of the credentials is required. |
X-API-KeystringOptional | Alternative to Authorization; never send both. |
X-Birdor-Workspace-IDstringOptional | Required with the site session; optional and matching with an API key. |
X-Birdor-Project-IDstringOptional | Optional owned project; a project-bound key cannot select another project. |
Request body
Send JSON with Content-Type: application/json.
| Field | Description |
|---|---|
itemsarrayRequired | Concepts to name, 1–30. ids must be unique. |
styleconcise | descriptiveOptional | concise: 1–3 words; descriptive: up to 5 words that leave no ambiguity. |
localeen | zh | zh-TW | ja | de | fr | ruOptional | Language of the input text; names are always English. |
referencearrayOptional | Names the caller already uses in the same project; the model reuses their terms for consistency. |
Request example
curl --request POST "$BIRDOR_API_BASE_URL/v1/run/naming/suggest" \
--header "Accept: application/json" \
--header "Authorization: Bearer $BIRDOR_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"items": [
{
"id": 0,
"text": "用户上次登录时间",
"kind": "variable"
}
],
"style": "concise",
"locale": "zh",
"reference": []
}'Examples are copied only; this page does not send API requests.
Responses
Illustrative response. Values vary by environment and time.
200Success
{
"ok": true,
"data": {
"results": [
{
"id": 0,
"candidates": [
{
"words": [
"last",
"login",
"time"
],
"abbr": [
"last",
"login",
"ts"
]
},
{
"words": [
"user",
"last",
"login",
"at"
],
"abbr": null
}
]
}
],
"failedIds": []
},
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}400Invalid JSON, schema validation failure (field paths/codes only, never input values) or ambiguous credentials
{
"ok": false,
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}401Missing, expired, rotated, revoked or invalid credential; there is no anonymous access
{
"ok": false,
"code": "UNAUTHENTICATED",
"message": "API access denied",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}403Key lacks tools.run, or workspace/project/member policy or site Origin denied
{
"ok": false,
"code": "FORBIDDEN",
"message": "API access denied",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}405Only POST is supported; rejected before admission
{
"ok": false,
"code": "METHOD_NOT_ALLOWED",
"message": "Method not allowed",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}408Body read exceeds five seconds; before admission
{
"ok": false,
"code": "REQUEST_TIMEOUT",
"message": "Request body timeout or aborted",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}413Body exceeds 16384 bytes; before admission
{
"ok": false,
"code": "PAYLOAD_TOO_LARGE",
"message": "Request body too large",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}415Content-Type must be application/json; before admission
{
"ok": false,
"code": "UNSUPPORTED_MEDIA_TYPE",
"message": "JSON content type required",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}429Ingress, workspace/actor minute or monthly quota exceeded; inspect code and Retry-After
{
"ok": false,
"code": "QUOTA_EXCEEDED",
"message": "API request limit exceeded",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}500Unexpected operation failure; details are never echoed
{
"ok": false,
"code": "OPERATION_FAILED",
"message": "Operation failed",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}503Authentication/metering dependency unavailable; AI_NOT_CONFIGURED: The AI naming service is not enabled on this deployment.; AI_UPSTREAM_UNAVAILABLE: The model provider timed out, refused or returned an invalid or oversized response.
{
"ok": false,
"code": "API_GATEWAY_UNAVAILABLE",
"message": "API access denied",
"request_id": "req_example",
"timestamp": "2026-10-11T00:00:00.000Z"
}Example response fields
Fields shown in this example; optional fields can be omitted. Array rows describe the first example element.
- okboolean
- Application success flag.
- dataobject
- Endpoint-specific result.
- data.resultsarray
- Endpoint-specific example value.
- data.results[].idnumber
- Resource identifier.
- data.results[].candidatesarray
- Endpoint-specific example value.
- data.failedIdsarray
- Endpoint-specific example value.
- request_idstring
- Origin-response identifier matching X-Request-ID; a shared HTTP cache may replay the original trace.
- timestampstring
- Response creation timestamp.