Skip to main content
POST
/
v1
/
prompts
Create Prompt
curl --request POST \
  --url https://api.example.com/v1/prompts/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "prompt": "<string>",
  "description": "Extracts what a company does and whether it is generalist or specialist.",
  "response_schema": {
    "draft_07": {}
  }
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "prompt": "<string>",
    "response_schema": {
      "draft_07": {}
    },
    "version": 123,
    "is_current": true,
    "created_at": 123,
    "description": "<string>"
  },
  "response_type": "PromptResponse",
  "links": []
}

Authorizations

​
X-API-Key
string
header
required

API Key for external integrations (format: greetincs_...)

Body

application/json

Request schema for creating a new prompt.

Note: version is an internal field managed by the system.

  • version: Auto-incremented on updates, starts at 1 for new prompts
​
name
string
required
Required string length: 1 - 255
Example:

"Company Summary Extractor"

​
prompt
string
required
Minimum string length: 1
Example:

"Given the page content, answer the questions according to the schema."

​
description
string | null
Maximum string length: 1000
Example:

"Extracts what a company does and whether it is generalist or specialist."

​
response_schema
JSONSchema · object

JSON Schema Draft-07 model for structured prompt responses. Supports both primitive schemas (e.g., {"type": "string"}) and object schemas. If omitted, defaults to {"type": "string"}.

Response

Successful Response

API response model for structured prompts.

​
data
PromptData · object
required

Data model for versioned structured prompts.

The id field serializes as unversioned (prompt_xxx) for direct use in API paths. Version info is in the separate version field.

​
response_type
string
default:PromptResponse
​
links
Link · object[]

HATEOAS links related to this response (e.g., self, next, prev)

Example:
[
  {
    "href": "/resource/{resource_id}",
    "method": "GET",
    "rel": "self",
    "title": "Resource Details"
  },
  {
    "href": "/resource/{resource_id}/related",
    "method": "GET",
    "rel": "related",
    "title": "Related Resources"
  }
]