Create prompt | Opik Documentation

POST/v1/private/promptsCreate prompt

Create prompt

Request body

application/json

objectPrompt_Write

change_descriptionstring

descriptionstring

maxLength 255 · minLength 0 · pattern (?s)^\s*(\S.*\S|\S)\s*$

idstring · uuid

metadataobject

namestringrequired

minLength 1

project_idstring · uuid

Project ID. Takes precedence over project_name when both are provided.

project_namestring

For project scope, specify either project_id or project_name. If project_name is provided and the project does not exist, it will be created. Ignored when project_id is provided. If neither is provided, the prompt is created at workspace level.

pattern (?s)^\s*(\S.*\S|\S)\s*$

tagsarray of string

uniqueItems true

Show child attributes

uniqueItems true

templatestring

pattern (?s)^\s*(\S.*\S|\S)\s*$

template_structurestring

Template structure type: 'text' or 'chat'. Immutable after creation.

one of "text", "chat" · default "text"

typestring

one of "mustache", "jinja2", "python"

Example request

{
  "change_description": "string",
  "description": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "metadata": {},
  "name": "string",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "project_name": "string",
  "tags": [
    "string"
  ],
  "template": "string",
  "template_structure": "text",
  "type": "jinja2"
}

Responses

Headers

Location

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

{
  "code": 0,
  "details": "string",
  "message": "string"
}

Examples

curl -X POST 'http://localhost:5173/api/v1/private/prompts' \
  -H 'Content-Type: application/json' \
  -d '{"change_description":"string","description":"string","id":"00000000-0000-0000-0000-000000000000","metadata":{},"name":"string","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","tags":["string"],"template":"string","template_structure":"text","type":"jinja2"}'

const response = await fetch('http://localhost:5173/api/v1/private/prompts', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"change_description":"string","description":"string","id":"00000000-0000-0000-0000-000000000000","metadata":{},"name":"string","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","tags":["string"],"template":"string","template_structure":"text","type":"jinja2"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/prompts', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"change_description\":\"string\",\"description\":\"string\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{},\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"tags\":[\"string\"],\"template\":\"string\",\"template_structure\":\"text\",\"type\":\"jinja2\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/prompts",
    headers={"Content-Type": "application/json"},
    data='{"change_description":"string","description":"string","id":"00000000-0000-0000-0000-000000000000","metadata":{},"name":"string","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","tags":["string"],"template":"string","template_structure":"text","type":"jinja2"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"change_description":"string","description":"string","id":"00000000-0000-0000-0000-000000000000","metadata":{},"name":"string","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","tags":["string"],"template":"string","template_structure":"text","type":"jinja2"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/prompts", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/prompts");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"change_description\":\"string\",\"description\":\"string\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{},\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"tags\":[\"string\"],\"template\":\"string\",\"template_structure\":\"text\",\"type\":\"jinja2\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/prompts"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"change_description\":\"string\",\"description\":\"string\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{},\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"tags\":[\"string\"],\"template\":\"string\",\"template_structure\":\"text\",\"type\":\"jinja2\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/prompts")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"change_description\":\"string\",\"description\":\"string\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{},\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"tags\":[\"string\"],\"template\":\"string\",\"template_structure\":\"text\",\"type\":\"jinja2\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/prompts");
request.Content = new StringContent("{\"change_description\":\"string\",\"description\":\"string\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{},\"name\":\"string\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"tags\":[\"string\"],\"template\":\"string\",\"template_structure\":\"text\",\"type\":\"jinja2\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 201)

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}

{
  "code": 0,
  "details": "string",
  "message": "string"
}