Skip to main content

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

ParameterInTypeRequiredDescriptionConstraints
idpathstringYesallowed: 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

FieldTypeRequiredDescriptionConstraints
versionintegerYes
promptobjectYes
prompt.idstringYesallowed: club-summary, visitor-briefing, club-comparison, club-recommendation, natural-language-search
prompt.versionstringYespattern: ^\d+.\d+.\d+$
prompt.variablesarray<string>Yes
prompt.outputSchemaobject<string, any>Yes

Example

{
"version": 1,
"prompt": {
"id": "club-summary",
"version": "1.0.0",
"variables": [
"string"
],
"outputSchema": {}
}
}

401 · Default Response

application/json

FieldTypeRequiredDescriptionConstraints
statusCodeintegerYes
errorstringYes
codestringNo
messagestringYes
requestIdstringYes

Example

{
"statusCode": 0,
"error": "string",
"code": "trial_expired",
"message": "string",
"requestId": "req-7f3a2c"
}

404 · Default Response

application/json

FieldTypeRequiredDescriptionConstraints
statusCodeintegerYes
errorstringYes
codestringNo
messagestringYes
requestIdstringYes

Example

{
"statusCode": 0,
"error": "string",
"code": "trial_expired",
"message": "string",
"requestId": "req-7f3a2c"
}

429 · Default Response

application/json

FieldTypeRequiredDescriptionConstraints
statusCodeintegerYes
errorstringYes
codestringNo
messagestringYes
requestIdstringYes

Example

{
"statusCode": 0,
"error": "string",
"code": "trial_expired",
"message": "string",
"requestId": "req-7f3a2c"
}