Get one AI prompt definition
GET
/v1/ai/prompts/{id}Returns one language-neutral prompt definition. Use its ID to select localized prompt text from the translations endpoint.
Tags: ai
Authentication
Send the API key as a Bearer token in the Authorization header.
Parameters
| Parameter | In | Type | Required | Description | Constraints |
|---|---|---|---|---|---|
id | path | string | Yes | allowed: club-summary, visitor-briefing, club-comparison, club-recommendation, natural-language-search |
Example request
curl --request GET \
--url 'https://api.eae.golf/v1/ai/prompts/club-summary' \
--header 'Authorization: Bearer YOUR_API_KEY'
Responses
200 · Default Response
application/json
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
version | integer | Yes | ||
prompt | object | Yes | ||
prompt.id | string | Yes | allowed: club-summary, visitor-briefing, club-comparison, club-recommendation, natural-language-search | |
prompt.version | string | Yes | pattern: ^\d+.\d+.\d+$ | |
prompt.variables | array<string> | Yes | ||
prompt.outputSchema | object<string, any> | Yes |
Example
{
"version": 1,
"prompt": {
"id": "club-summary",
"version": "1.0.0",
"variables": [
"string"
],
"outputSchema": {}
}
}
401 · Default Response
application/json
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
statusCode | integer | Yes | ||
error | string | Yes | ||
code | string | No | ||
message | string | Yes | ||
requestId | string | Yes |
Example
{
"statusCode": 0,
"error": "string",
"code": "trial_expired",
"message": "string",
"requestId": "req-7f3a2c"
}
404 · Default Response
application/json
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
statusCode | integer | Yes | ||
error | string | Yes | ||
code | string | No | ||
message | string | Yes | ||
requestId | string | Yes |
Example
{
"statusCode": 0,
"error": "string",
"code": "trial_expired",
"message": "string",
"requestId": "req-7f3a2c"
}
429 · Default Response
application/json
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
statusCode | integer | Yes | ||
error | string | Yes | ||
code | string | No | ||
message | string | Yes | ||
requestId | string | Yes |
Example
{
"statusCode": 0,
"error": "string",
"code": "trial_expired",
"message": "string",
"requestId": "req-7f3a2c"
}