Create Conversation

Create a new conversation with AI agents. Conversations maintain context across multiple messages and allow for interactive discussions about your codebase.

POST /api/v2/conversations/

Create Conversation

cURL

curl --request POST \
  --url http://localhost:8001/api/v2/conversations/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "user_id": "YOUR_USER_ID",
  "title": "Untitled",
  "status": "active",
  "project_ids": [
    "proj_abc123def456"
  ],
  "agent_ids": [
    "codebase_qna_agent"
  ]
}
'

import requests

url = "http://localhost:8001/api/v2/conversations/"

payload = {
    "user_id": "YOUR_USER_ID",
    "title": "Untitled",
    "status": "active",
    "project_ids": ["proj_abc123def456"],
    "agent_ids": ["codebase_qna_agent"]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    user_id: 'YOUR_USER_ID',
    title: 'Untitled',
    status: 'active',
    project_ids: ['proj_abc123def456'],
    agent_ids: ['codebase_qna_agent']
  })
};

fetch('http://localhost:8001/api/v2/conversations/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8001",
  CURLOPT_URL => "http://localhost:8001/api/v2/conversations/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user_id' => 'YOUR_USER_ID',
    'title' => 'Untitled',
    'status' => 'active',
    'project_ids' => [
        'proj_abc123def456'
    ],
    'agent_ids' => [
        'codebase_qna_agent'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8001/api/v2/conversations/"

	payload := strings.NewReader("{\n  \"user_id\": \"YOUR_USER_ID\",\n  \"title\": \"Untitled\",\n  \"status\": \"active\",\n  \"project_ids\": [\n    \"proj_abc123def456\"\n  ],\n  \"agent_ids\": [\n    \"codebase_qna_agent\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:8001/api/v2/conversations/")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"YOUR_USER_ID\",\n  \"title\": \"Untitled\",\n  \"status\": \"active\",\n  \"project_ids\": [\n    \"proj_abc123def456\"\n  ],\n  \"agent_ids\": [\n    \"codebase_qna_agent\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8001/api/v2/conversations/")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"YOUR_USER_ID\",\n  \"title\": \"Untitled\",\n  \"status\": \"active\",\n  \"project_ids\": [\n    \"proj_abc123def456\"\n  ],\n  \"agent_ids\": [\n    \"codebase_qna_agent\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "message": "Conversation created successfully.",
  "conversation_id": "conv_xyz789abc123"
}

{
  "detail": "Either repo_name or repo_path must be provided"
}

{
  "detail": "Invalid API key"
}

{
  "detail": "Subscription required to create a conversation"
}

Use Cases

• Start a new debugging session
• Begin a code review conversation
• Ask questions about specific parts of your codebase
• Generate test plans for a feature
• Request code changes or improvements

Authentication

This endpoint requires API key authentication via the x-api-key header.

x-api-key: YOUR_API_KEY

Request & Response

Location	Field	Type	Required	Default	Description
Query	hidden	boolean	optional	true	Controls visibility in the web UI. Set to false to show the conversation in your dashboard.
Body	project_ids	array[string]	required	-	List of project UUIDs to include in the conversation context
Body	agent_ids	array[string]	required	-	List of agent identifiers to enable (e.g., ["codebase_qna_agent"])
Response	message	string	-	-	Confirmation message indicating successful creation
Response	conversation_id	string	-	-	Unique identifier for the conversation. Use this ID to send messages.

Complete Workflow

TypeScript

// Create a conversation
const response = await fetch(
  'http://localhost:8001/api/v2/conversations',
  {
    method: 'POST',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      project_ids: ['550e8400-e29b-41d4-a716-446655440000'],
      agent_ids: ['codebase_qna_agent']
    })
  }
);

const data = await response.json();
console.log('Conversation ID:', data.conversation_id);

// Use conversation_id to send messages
// See the Post Message endpoint

import requests

response = requests.post(
    'http://localhost:8001/api/v2/conversations',
    headers={
        'x-api-key': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'project_ids': ['550e8400-e29b-41d4-a716-446655440000'],
        'agent_ids': ['codebase_qna_agent']
    }
)

data = response.json()
print(f"Conversation ID: {data['conversation_id']}")

curl -X POST \
  'http://localhost:8001/api/v2/conversations' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "project_ids": ["550e8400-e29b-41d4-a716-446655440000"],
    "agent_ids": ["codebase_qna_agent"]
  }'

Error Responses

401 Unauthorized

The endpoint requires a valid API key for authentication.

{
  "detail": "API key is required"
}

Causes:

• Missing x-api-key header
• Invalid or expired API key
• API key doesn’t match any user account

Solution: Include a valid API key in the request header:

x-api-key: YOUR_API_KEY

402 Payment Required

The endpoint returns this error when you have exceeded your plan’s usage limits.

{
  "detail": "Subscription required to create a conversation."
}

Causes:

• You have reached the maximum number of conversations for your current plan
• Your subscription has expired
• Usage limits have been exceeded

Solution:

• Upgrade your subscription plan to increase limits
• Delete unused conversations to free up capacity
• Contact support to review your usage limits

500 Internal Server Error

The endpoint returns this error when unexpected exceptions occur during conversation creation.

{
  "detail": "An unexpected error occurred while creating the conversation."
}

Causes:

• Database connection failures
• Invalid project or agent IDs
• Service unavailability

Solution: Retry the request after a brief delay. If the issue persists, contact support.

Troubleshooting

Empty response or missing conversation_id

Problem: Response doesn’t contain expected conversation_id.

Solution:

• Check the HTTP status code (should be 200 for success)
• Verify the response body is valid JSON
• Ensure all required fields are included in the request
• Check server logs if you have access

Invalid project_ids or agent_ids

Problem: Conversation created but doesn’t work properly.

Solution:

• Verify project IDs are valid UUIDs from successful parse operations
• Use the List Projects endpoint to confirm project IDs
• Use the List Available Agents endpoint to get valid agent IDs
• Ensure at least one project and one agent are specified

Authorizations

x-api-key · string · header · required

API key authentication. Get your key from potpie settings page

Query Parameters

hidden · boolean · default: false

Whether to hide this conversation from the web UI

Body

application/json

user_id · string · required

User identifier. The server uses the authenticated user ID from the API key.

title · string · required

Name for the conversation. Pass "Untitled" to auto-generate a name from the project.

status · enum<string> · required

Initial conversation status. Use "active" for a standard new conversation.

Available options: active, archived, deleted

project_ids · string[] · required

List of project IDs to include in the conversation

agent_ids · string[] · required

List of agent IDs to use in the conversation

Response

200

application/json

Conversation created successfully

message · string

conversation_id · string