Prompt Canvas

POST /api/v1/prompts/canvas

Error

A valid request URL is required to generate request examples

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Body

application/json

messages · (AIMessage · object | HumanMessage · object | ChatMessage · object | SystemMessage · object | FunctionMessage · object | ToolMessage · object | AIMessageChunk · object | HumanMessageChunk · object | ChatMessageChunk · object | SystemMessageChunk · object | FunctionMessageChunk · object | ToolMessageChunk · object)[] · required

Message from an AI.

An AIMessage is returned from a chat model as a response to a prompt.

This message represents the output of the model and consists of both the raw output as returned by the model and standardized fields (e.g., tool calls, usage metadata) added by the LangChain framework.

AIMessage

HumanMessage

ChatMessage

SystemMessage

FunctionMessage

ToolMessage

AIMessageChunk

HumanMessageChunk

ChatMessageChunk

SystemMessageChunk

FunctionMessageChunk

ToolMessageChunk

Show child attributes

template_format · enum<string> · required

Available options: f-string, mustache

secrets · Secrets · object · required

Show child attributes

highlighted · Highlight · object

Show child attributes

artifact · Artifact · object

Show child attributes

artifact_length · enum<string> | null

Available options: shortest, short, long, longest

reading_level · enum<string> | null

Available options: child, teenager, college, phd

custom_action · string | null

Response

200

application/json

Successful Response