Get Prompt
curl --request GET \
--url https://{controlPlaneURL}/api/ml/v1/prompts/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "<string>",
"ml_repo_id": "<string>",
"type": "chat_prompt",
"name": "<string>",
"fqn": "<string>",
"created_by_subject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"latest_version": {
"id": "<string>",
"fqn": "<string>",
"created_by_subject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"manifest": {
"name": "<string>",
"description": "<string>",
"metadata": {},
"version_alias": "<string>",
"ml_repo": "<string>",
"version": 2,
"type": "chat_prompt",
"messages": [
{
"role": "system",
"content": "<string>",
"name": "<string>"
}
],
"variables": {},
"model_configuration": {
"provider": "<string>",
"model": "<string>",
"parameters": {
"max_tokens": 123,
"temperature": 123,
"top_k": 123,
"top_p": 123,
"stop": [
"<string>"
]
},
"extra_parameters": {}
},
"tools": [
{
"type": "function",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {},
"strict": false
}
}
]
},
"usage_code_snippet": "<string>",
"ml_repo_id": "<string>",
"prompt_id": "<string>"
},
"run_steps": [
123
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Subject ID
Subject type
user, team, serviceaccount Subject slug
Subject display name
chat_prompt Subject ID
Subject type
user, team, serviceaccount Subject slug
Subject display name
Chat Prompt manifest.
Name of the entity
256Key value metadata. Should be valid JSON. For e.g. {"business-unit": "sales", "quality": "good", "rating": 4.5}
Name of the ML Repo
List of messages in the chat conversation, must be non-empty
512Version alias is alternate, ideally human readable, version string to reference an artifact version. It should start with v followed by alphanumeric and it can include . and - in between (e.g. v1.0.0, v1-prod, v3-dev, etc)
128Version of the entity
x >= 1chat_prompt Variables referenced in messages and that can be replaced when running generation
Add a model from Gateway along with parameters to be used for chat completion
Name of the provider, must be one of the integration providers configured for the Gateway
Name of the model to be used for generations. This model should be available in the provider
Parameters to pass to the model when generating
Arbitrary extra parameters to pass to the model when generating
curl --request GET \
--url https://{controlPlaneURL}/api/ml/v1/prompts/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "<string>",
"ml_repo_id": "<string>",
"type": "chat_prompt",
"name": "<string>",
"fqn": "<string>",
"created_by_subject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"latest_version": {
"id": "<string>",
"fqn": "<string>",
"created_by_subject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"manifest": {
"name": "<string>",
"description": "<string>",
"metadata": {},
"version_alias": "<string>",
"ml_repo": "<string>",
"version": 2,
"type": "chat_prompt",
"messages": [
{
"role": "system",
"content": "<string>",
"name": "<string>"
}
],
"variables": {},
"model_configuration": {
"provider": "<string>",
"model": "<string>",
"parameters": {
"max_tokens": 123,
"temperature": 123,
"top_k": 123,
"top_p": 123,
"stop": [
"<string>"
]
},
"extra_parameters": {}
},
"tools": [
{
"type": "function",
"function": {
"name": "<string>",
"description": "<string>",
"parameters": {},
"strict": false
}
}
]
},
"usage_code_snippet": "<string>",
"ml_repo_id": "<string>",
"prompt_id": "<string>"
},
"run_steps": [
123
]
}
}