Create a conversation | Runtype Documentation

Authentication

AuthorizationBearer

API key or Clerk session token

Request

This endpoint expects an object.

metadatamap from strings to anyOptionalDefaults to {}

modelIdstringOptional<=255 characters

ownerIdstring or nullOptional1-255 characters

Owner key for this conversation, stored in the indexed owner_id column and filterable via ?ownerId=. Overrides a nested metadata.ownerId. Null means no owner.

systemPromptstringOptional

titlestringOptional<=500 charactersDefaults to New Chat

Response

Conversation created

createdAtstring

idstring

messageslist of maps from strings to any

metadatamap from strings to any

modelIdstring or null

ownerIdstring or null

sourceenum

systemPromptstring or null

titlestring

updatedAtstring

schemaWarningslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X POST https://api.runtype.com/v1/conversations \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"metadata": {
>	"topic": "general"
>	},
>	"modelId": "gpt-4",
>	"systemPrompt": "You are a helpful assistant.",
>	"title": "New Chat"
>	}'

1	{
2	"createdAt": "string",
3	"id": "string",
4	"messages": [
5	{}
6	],
7	"metadata": {},
8	"modelId": "string",
9	"ownerId": "string",
10	"source": "app",
11	"systemPrompt": "string",
12	"title": "string",
13	"updatedAt": "string",
14	"schemaWarnings": [
15	{
16	"code": "string",
17	"field": "string",
18	"message": "string"
19	}
20	]
21	}