Skip to main content
POST
/
v1
/
keywords
/
{keywordId}
/
prompts
Create a prompt
curl --request POST \
  --url https://api.example.com/v1/keywords/{keywordId}/prompts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>"
}
'
{
  "id": "<string>",
  "lastAnalyzedAt": "<string>",
  "prompt": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key starting with sk_. Generate one in Settings > API Keys.

Path Parameters

​
keywordId
string
required

Keyword ID.

Body

application/json
​
prompt
string
required

Prompt text.

Minimum string length: 1

Response

201 - application/json

Default Response

​
analysisStatus
enum<string> | null
required

Status of the GEO analysis.

Available options:
queued,
pending,
success,
failed
​
id
string
required

Unique identifier of the prompt.

​
lastAnalyzedAt
string | null
required

Last analysis date (ISO 8601).

​
prompt
string
required

Prompt text.