Create Prompt

POST

Two types of prompts can be created - a root prompt or a child prompt (aka Prompt Version in app).

A root prompt can be created by providing the name param, and it will always be tagged as prod.

A child prompt can be created by providing the parent_id param. Note that the name param in this case will be ignored as all descendents from a root prompt would share the root’s name. is_prod can also be provided to configure whether a child should be tagged as prod.

Request

This endpoint expects an object.

prompt_templatestringRequired

namestringOptional

parent_idstringOptional

descriptionstringOptional

model_paramsmap from strings to optional integers or doubles or strings or booleansOptional

is_prodbooleanOptional

Response

This endpoint returns an object.

org_idstringOptional

The organization this resource belongs to.

user_idstringOptional

The user this record belongs to.

idstringOptional

namestringOptional

descriptionstringOptional

is_archivedbooleanOptional

prompt_templatestringOptional

model_paramsmap from strings to optional integers or doubles or stringsOptional

root_idstringOptional

parent_idstringOptional

merge_parent_idstringOptional

created_atdatetimeOptional

Errors

POST

1 curl -X POST https://api.getscorecard.ai/v1/prompt \
2      -H "X-API-Key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "prompt_template": "<system>\nYou are a helpful assistant. Use the provided context to answer the user\'s query.\n\nContext: {context}\n</system>\n\n<user>\n{user_query}\n</user>",
6   "name": "Prompt Name",
7   "description": "Description of the prompt",
8   "model_params": {
9     "param1": "value1",
10     "param2": 0.1,
11     "param3": 100,
12     "param4": true
13   }
14 }'

200Create a root prompt

1 {
2   "org_id": "org_id",
3   "user_id": "user_id",
4   "id": "id",
5   "name": "name",
6   "description": "description",
7   "is_archived": true,
8   "prompt_template": "prompt_template",
9   "model_params": {
10     "key": 1
11   },
12   "root_id": "root_id",
13   "parent_id": "parent_id",
14   "merge_parent_id": "merge_parent_id",
15   "created_at": "2024-01-15T09:30:00Z"
16 }

Built with

1	curl -X POST https://api.getscorecard.ai/v1/prompt \
2	-H "X-API-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"prompt_template": "<system>\nYou are a helpful assistant. Use the provided context to answer the user\'s query.\n\nContext: {context}\n</system>\n\n<user>\n{user_query}\n</user>",
6	"name": "Prompt Name",
7	"description": "Description of the prompt",
8	"model_params": {
9	"param1": "value1",
10	"param2": 0.1,
11	"param3": 100,
12	"param4": true
13	}
14	}'

1	{
2	"org_id": "org_id",
3	"user_id": "user_id",
4	"id": "id",
5	"name": "name",
6	"description": "description",
7	"is_archived": true,
8	"prompt_template": "prompt_template",
9	"model_params": {
10	"key": 1
11	},
12	"root_id": "root_id",
13	"parent_id": "parent_id",
14	"merge_parent_id": "merge_parent_id",
15	"created_at": "2024-01-15T09:30:00Z"
16	}