Skip to main content
POST
/
conversations
Create a conversation
curl --request POST \
  --url https://api.veryfront.com/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "<string>",
  "title": "<string>",
  "metadata": {}
}
'
{
  "id": "<string>",
  "type": "<string>",
  "status": "<string>",
  "message_count": 123,
  "created_by": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "project_id": "<string>",
  "title": "<string>",
  "summary": "<string>",
  "current_node": "<string>",
  "last_message_at": "<string>",
  "metadata": null,
  "agent_id": "<string>",
  "runtime_target_kind": "<string>",
  "runtime_target_environment_id": "<string>",
  "runtime_target_branch_id": "<string>",
  "archived_at": "<string>"
}

Authorizations

Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Body

application/json
project_id
string<uuid>
type
string
title
string
Maximum string length: 500
metadata
object

Response

Created conversation

id
string
required
type
string
required
status
string
required
message_count
number
required
created_by
string | null
required
created_at
string
required
updated_at
string
required
project_id
string | null
title
string | null
summary
string | null
current_node
string | null
last_message_at
string | null
metadata
unknown
agent_id
string | null
runtime_target_kind
string | null
runtime_target_environment_id
string | null
runtime_target_branch_id
string | null
archived_at
string | null