Create a new prompt

Create a new prompt and its initial version. A prompt can have multiple versions.

POST /v1/prompts

Try it

Create a new prompt

cURL

curl --request POST \
  --url https://api.example.com/v1/prompts \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": {
    "name": "<string>",
    "description": "<string>",
    "source_prompt_id": "<string>",
    "metadata": {}
  },
  "version": {
    "model_provider": "OPENAI",
    "model_name": "<string>",
    "template": {
      "type": "<string>",
      "messages": [
        {
          "role": "user",
          "content": "<string>"
        }
      ]
    },
    "template_type": "STR",
    "template_format": "MUSTACHE",
    "invocation_parameters": {
      "type": "<string>",
      "openai": {
        "temperature": 123,
        "max_tokens": 123,
        "max_completion_tokens": 123,
        "frequency_penalty": 123,
        "presence_penalty": 123,
        "top_p": 123,
        "seed": 123,
        "reasoning_effort": "minimal"
      }
    },
    "description": "<string>",
    "tools": {
      "type": "<string>",
      "tools": [
        {
          "type": "<string>",
          "function": {
            "name": "<string>",
            "description": "<string>",
            "parameters": {},
            "strict": true
          }
        }
      ],
      "tool_choice": {
        "type": "<string>"
      },
      "disable_parallel_tool_calls": true
    },
    "response_format": {
      "type": "<string>",
      "json_schema": {
        "name": "<string>",
        "description": "<string>",
        "schema": {},
        "strict": true
      }
    }
  }
}
'

200

{
  "data": {
    "model_provider": "OPENAI",
    "model_name": "<string>",
    "template": {
      "type": "<string>",
      "messages": [
        {
          "role": "user",
          "content": "<string>"
        }
      ]
    },
    "template_type": "STR",
    "template_format": "MUSTACHE",
    "invocation_parameters": {
      "type": "<string>",
      "openai": {
        "temperature": 123,
        "max_tokens": 123,
        "max_completion_tokens": 123,
        "frequency_penalty": 123,
        "presence_penalty": 123,
        "top_p": 123,
        "seed": 123,
        "reasoning_effort": "minimal"
      }
    },
    "id": "<string>",
    "description": "<string>",
    "tools": {
      "type": "<string>",
      "tools": [
        {
          "type": "<string>",
          "function": {
            "name": "<string>",
            "description": "<string>",
            "parameters": {},
            "strict": true
          }
        }
      ],
      "tool_choice": {
        "type": "<string>"
      },
      "disable_parallel_tool_calls": true
    },
    "response_format": {
      "type": "<string>",
      "json_schema": {
        "name": "<string>",
        "description": "<string>",
        "schema": {},
        "strict": true
      }
    }
  }
}

Body

application/json

prompt · PromptData · object · required

Show child attributes

prompt. name · string · required

prompt. description · string | null

prompt. source_prompt_id · string | null

prompt. metadata · Metadata · object

version · PromptVersionData · object · required

Show child attributes

version. model_provider · enum<string> · required

Available options: OPENAI, AZURE_OPENAI, ANTHROPIC, GOOGLE, DEEPSEEK, XAI, OLLAMA, AWS

version. model_name · string · required

version. template · PromptChatTemplate · object · required

PromptChatTemplate

PromptStringTemplate

Show child attributes

version.template. type · string · required

Allowed value: "chat"

version.template. messages · PromptMessage · object[] · required

Show child attributes

version.template.messages. role · enum<string> · required

Available options: user, assistant, model, ai, tool, system, developer

version.template.messages. content · required

version. template_type · enum<string> · required

Available options: STR, CHAT

version. template_format · enum<string> · required

Available options: MUSTACHE, F_STRING, NONE

version. invocation_parameters · PromptOpenAIInvocationParameters · object · required

PromptOpenAIInvocationParameters

PromptAzureOpenAIInvocationParameters

PromptAnthropicInvocationParameters

PromptGoogleInvocationParameters

PromptDeepSeekInvocationParameters

PromptXAIInvocationParameters

PromptOllamaInvocationParameters

PromptAwsInvocationParameters

Show child attributes

version.invocation_parameters. type · string · required

Allowed value: "openai"

version.invocation_parameters. openai · PromptOpenAIInvocationParametersContent · object · required

Show child attributes

version.invocation_parameters.openai. temperature · number

version.invocation_parameters.openai. max_tokens · integer

version.invocation_parameters.openai. max_completion_tokens · integer

version.invocation_parameters.openai. frequency_penalty · number

version.invocation_parameters.openai. presence_penalty · number

version.invocation_parameters.openai. top_p · number

version.invocation_parameters.openai. seed · integer

version.invocation_parameters.openai. reasoning_effort · enum<string>

Available options: minimal, low, medium, high

version. description · string | null

version. tools · PromptTools · object

Show child attributes

version.tools. type · string · required

Allowed value: "tools"

version.tools. tools · PromptToolFunction · object[] · required

Minimum array length: 1

Show child attributes

version.tools.tools. type · string · required

Allowed value: "function"

version.tools.tools. function · PromptToolFunctionDefinition · object · required

Show child attributes

version.tools.tools.function. name · string · required

version.tools.tools.function. description · string

version.tools.tools.function. parameters · Parameters · object

version.tools.tools.function. strict · boolean

version.tools. tool_choice · PromptToolChoiceNone · object

PromptToolChoiceNone

PromptToolChoiceZeroOrMore

PromptToolChoiceOneOrMore

PromptToolChoiceSpecificFunctionTool

Show child attributes

version.tools.tool_choice. type · string · required

Allowed value: "none"

version.tools. disable_parallel_tool_calls · boolean

version. response_format · PromptResponseFormatJSONSchema · object

Show child attributes

version.response_format. type · string · required

Allowed value: "json_schema"

version.response_format. json_schema · PromptResponseFormatJSONSchemaDefinition · object · required

Show child attributes

version.response_format.json_schema. name · string · required

version.response_format.json_schema. description · string

version.response_format.json_schema. schema · Schema · object

version.response_format.json_schema. strict · boolean

Response

200

application/json

The newly created prompt version

data · PromptVersion · object · required

Show child attributes

data. model_provider · enum<string> · required

Available options: OPENAI, AZURE_OPENAI, ANTHROPIC, GOOGLE, DEEPSEEK, XAI, OLLAMA, AWS

data. model_name · string · required

data. template · PromptChatTemplate · object · required

PromptChatTemplate

PromptStringTemplate

Show child attributes

data.template. type · string · required

Allowed value: "chat"

data.template. messages · PromptMessage · object[] · required

Show child attributes

data.template.messages. role · enum<string> · required

Available options: user, assistant, model, ai, tool, system, developer

data.template.messages. content · required

data. template_type · enum<string> · required

Available options: STR, CHAT

data. template_format · enum<string> · required

Available options: MUSTACHE, F_STRING, NONE

data. invocation_parameters · PromptOpenAIInvocationParameters · object · required

PromptOpenAIInvocationParameters

PromptAzureOpenAIInvocationParameters

PromptAnthropicInvocationParameters

PromptGoogleInvocationParameters

PromptDeepSeekInvocationParameters

PromptXAIInvocationParameters

PromptOllamaInvocationParameters

PromptAwsInvocationParameters

Show child attributes

data.invocation_parameters. type · string · required

Allowed value: "openai"

data.invocation_parameters. openai · PromptOpenAIInvocationParametersContent · object · required

Show child attributes

data.invocation_parameters.openai. temperature · number

data.invocation_parameters.openai. max_tokens · integer

data.invocation_parameters.openai. max_completion_tokens · integer

data.invocation_parameters.openai. frequency_penalty · number

data.invocation_parameters.openai. presence_penalty · number

data.invocation_parameters.openai. top_p · number

data.invocation_parameters.openai. seed · integer

data.invocation_parameters.openai. reasoning_effort · enum<string>

Available options: minimal, low, medium, high

data. id · string · required

data. description · string | null

data. tools · PromptTools · object

Show child attributes

data.tools. type · string · required

Allowed value: "tools"

data.tools. tools · PromptToolFunction · object[] · required

Minimum array length: 1

Show child attributes

data.tools.tools. type · string · required

Allowed value: "function"

data.tools.tools. function · PromptToolFunctionDefinition · object · required

Show child attributes

data.tools.tools.function. name · string · required

data.tools.tools.function. description · string

data.tools.tools.function. parameters · Parameters · object

data.tools.tools.function. strict · boolean

data.tools. tool_choice · PromptToolChoiceNone · object

PromptToolChoiceNone

PromptToolChoiceZeroOrMore

PromptToolChoiceOneOrMore

PromptToolChoiceSpecificFunctionTool

Show child attributes

data.tools.tool_choice. type · string · required

Allowed value: "none"

data.tools. disable_parallel_tool_calls · boolean

data. response_format · PromptResponseFormatJSONSchema · object

Show child attributes

data.response_format. type · string · required

Allowed value: "json_schema"

data.response_format. json_schema · PromptResponseFormatJSONSchemaDefinition · object · required

Show child attributes

data.response_format.json_schema. name · string · required

data.response_format.json_schema. description · string

data.response_format.json_schema. schema · Schema · object

data.response_format.json_schema. strict · boolean