Get Prompt By Name

GET

Retrieve a prompt by name, defaulting to the production prompt, unless a tag to select the prompt by is specified

namestringRequired

Name of the prompt.

tagstringOptional

Tag to select by. Defaults to selecting the production version

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

project_idintegerOptional

The ID of the project the prompt belongs to.

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	"project_id": 1
17	}

1	curl -G https://api.getscorecard.ai/v1/prompt \
2	-H "X-API-Key: <apiKey>" \
3	-d name=name