Skip to main content
POST
/
api
/
v1
/
prompts
/
canvas
Error
A valid request URL is required to generate request examples
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.langchain.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
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.

​
template_format
enum<string>
required
Available options:
f-string,
mustache
​
secrets
Secrets · object
required
​
highlighted
Highlight · object
​
artifact
Artifact · object
​
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

Successful Response