Skip to content
em sa em sa

Set the deal name

POST
/api/intake/{conversation_id}/deal-name
 
curl --request POST \
  --url https://example.com/api/intake/example/deal-name \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "deal_name": "example" }'

Sets the deal name for the conversation and creates the Pinecone namespace.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
conversation_id
required
Conversation Id
string

Request Body required

Section titled “Request Body required ”
Media type application/json
DealNameRequest
object
deal_name
required
Deal Name
string
>= 1 characters <= 200 characters
Example generated
{
  "deal_name": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
DealNameResponse
object
conversation_id
required
Conversation Id
string
deal_name
required
Deal Name
string
status
required
Status
string
conversation_state
Any of:
ConversationStateSnapshot

Compact state object included in mutation responses so the frontend can update its wizard without a separate /status poll.

object
status
required
Status
string
file_count
File Count
integer
0
has_deal_name
Has Deal Name
boolean
deal_name
Any of:
string
progress_step
Progress Step
string
default: Unknown
next_action
Any of:
string
files_summary
Any of:
string
suggested_deal_name
Any of:
string
deal_name_confidence
Any of:
number
suggested_name_parts
Any of:
object
key
additional properties
Any of:
string
deal_name_extraction
Any of:
object
key
additional properties
any
convention_suggestion
Any of:
string
Example 
{
  "conversation_state": {
    "file_count": 0,
    "has_deal_name": false,
    "progress_step": "Unknown"
  }
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}