Skip to main content
POST
/
project
/
{projectId}
/
security-champion
/
conversation
Create Security Champion conversation
curl --request POST \
  --url https://us.cybedefend.com/project/{projectId}/security-champion/conversation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "11111111-2222-3333-4444-555555555555",
  "branch": "main",
  "vulnerabilityId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "initialMessage": "List the critical vulnerabilities related to authentication."
}
'
{
  "success": true,
  "conversationId": "conv-abc123",
  "status": "created",
  "reason": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
projectId
string<uuid>
required

Project unique identifier

Body

application/json
​
projectId
string
required

Project identifier (UUID)

Example:

"11111111-2222-3333-4444-555555555555"

​
branch
string

Git branch name for branch-specific conversations. Used together with projectId to identify the project context in Potpie. Defaults to "main" if not provided.

Example:

"main"

​
vulnerabilityId
string

Optional vulnerability identifier (UUID). If provided, the conversation will start focused on this vulnerability context.

Example:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

​
initialMessage
string

Optional initial user message to send

Example:

"List the critical vulnerabilities related to authentication."

Response

Conversation created successfully

​
success
boolean
Example:

true

​
conversationId
string
Example:

"conv-abc123"

​
status
string
Example:

"created"

​
reason
string | null
Example:

null