Get prompt.

GET

/backend/v1/prompts/{promptId}

Retrieves a prompt by its ID.

Authorizations

HTTPBearer

TypeHTTP (bearer)

Parameters

Path Parameters

promptId*

Typestring

Required

formatuuid

Query Parameters

fetchScanners

Return the guardrails and their configuration that were run on the prompt.

Typeboolean

defaultfalse

Responses

Successful Response

Content-Type

application/json

{

"memory": [

{

"externalMetadata": "string",

"extraInputs": "string",

"fromTemplate": false,

"id": "string",

"input": "string",

"memory": "string",

"parentId": "string",

"preserve": false,

"projectId": "string",

"provider": "string",

"receivedAt": "string",

"result": {

"files": [

{

"contentType": "string",

"data": "string",

"id": "string",

"isBase64": true,

"name": "string"

}

],

"outcome": "string",

"providerResult": "string",

"response": "string",

"scannerResults": [

{

"completedDate": "string",

"customConfig": false,

"data": {

"matches": [

[

]

],

"type": "regex"

},

"outcome": "string",

"scanDirection": "string",

"scannerId": "string",

"scannerVersionMeta": "string",

"startedDate": "string"

}

]

},

"type": "string",

"userId": "string"

}

],

"prompt": "string",

"promptScanners": "string"

}

GET

/backend/v1/prompts/{promptId}

Playground

Server

Authorization

HTTPBearer

Variables

Key

Value

promptId*

fetchScanners

Samples

Powered by VitePress OpenAPI