Generate a proposal's sections with AI

POST

/api/v1/proposals/{id}/generate-ai

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/proposals/example/generate-ai \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "scope_of_work": "", "scope": "example", "pricing_details": "", "pricing_tier": "example", "timeline": "", "start_date": "example", "additional_context": { "additionalProperty": "example" } }'

Writes the sections with AI from the scope of work, pricing details, timeline and context you pass; usage is metered.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

scope_of_work

string

"" <= 10000 characters

scope

string

<= 10000 characters

pricing_details

string

"" <= 5000 characters

pricing_tier

string

<= 5000 characters

timeline

string

"" <= 5000 characters

start_date

string

additional_context

object

key

additional properties

string

<= 5000 characters

Responses

200

OK

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}