​

Response API

For solicitation responses, the following endpoints are available to authenticated clients as POST or WS Publish. Here is the sequence of events, in order of usage - there are others, but this is what you need to import and respond to a solicitation:

​

List Solicitations (available anytime)

​

Import the solicitation

1. Solicitation Create
2. Solicitation Parse
3. Solicitation Attachment Create (IF NEEDED)
4. Solicitation Attachment Parse (IF NEEDED)

​

At this point, some endpoints become available:

1. Solicitation Load
2. Solicitation Delete
3. Solicitation Page Load
4. Solicitation Download
5. Solicitation Attachment Download

​

Tagging the Solicitation

1. Solicitation Section Tag, AND/OR:
2. Solicitation Section Autotag

​

Solutioning

1. Solicitation Extract (Shred)
2. Solutioning Create

​

At this point, several endpoints become available:

1. Solutioning Load
2. Solutioning Update
3. Solutioning Answer
4. Solutioning Answer Item
5. Solutioning Delete

​

Generate an Outline

1. Response Outline Generate
2. Response Outline Load

​

Revise the Outline

1. Response Outline Structure - revise the structure of the outline
2. Response Section Create
3. Response Section Delete

​

Generate the Response

1. Response Section Generate, OR
2. Response Generate

​

Export the Response

1. Response Load
2. Response Export

---

​

List Solicitations

​

Solicitations List

​

endpoint:

/solicitation/list

​

summary:

List all solicitations for the current organization.

​

inputs:

• none

​

outputs:

• solicitations: an array of solicitation objects

---

​

Solicitation Import/Processing

​

Solicitation Create

​

endpoint:

/solicitation/create

​

summary:

Provide the filename and receive a presigned URL to upload the file. PDF and docx formats are supported. FullSolicitation is an interface that supports preloading related records such as the sections.

​

inputs:

• filename: string (solicitation PDF filename)

​

outputs:

• filename: string (solicitation PDF filename)
• url: string (presigned/preauthorizeddownload URL)
• id: string (solicitation ID)
• solicitation: FullSolicitation

---

​

Solicitation Parse

​

endpoint:

/solicitation/parse

​

summary:

Parse the solicitation PDF into markdown, sections, summary, taggings,

​

inputs:

• id: string (solicitation ID)

​

outputs:

• success: boolean

---

​

IF NEEDED: Solicitation Attachment Create

​

endpoint:

/solicitation/attachment/create

​

summary:

Provide the filename and receive a presigned URL to upload the file. PDF and docx formats are supported.

​

inputs:

• id: string (solicitation ID)
• filename: string (solicitation PDF filename)

​

outputs:

• filename: string (solicitation PDF filename)
• url: string (presigned/preauthorizeddownload URL)
• key: string (solicitation attachment key)

---

​

IF NEEDED: Solicitation Attachment Parse

​

endpoint:

/solicitation/attachment/parse

​

summary:

Parse the solicitation attachment PDF into markdown, sections, summary, taggings,

​

inputs:

• id: string (solicitation ID)
• key: string (solicitation attachment key)

​

outputs:

• success: boolean

---

​

Viewing Uploaded Solicitations

​

Solicitation Load

​

endpoint:

/solicitation/load

​

summary:

Load the solicitation for viewing.

​

inputs:

• id: string (solicitation ID)

​

outputs:

• solicitation: FullSolicitation

---

​

Solicitation Delete

​

endpoint:

/solicitation/delete

​

summary:

Delete the solicitation.

​

inputs:

• id: string (solicitation ID)

​

outputs:

• success: boolean

---

​

Solicitation Page Load

​

endpoint:

/solicitation/page/load

​

summary:

Load the solicitation page for viewing.

​

inputs:

• id: string (solicitation ID)
• pageId: string (solicitation page ID)

​

outputs:

• image: string (solicitation image URL)
• id: string (solicitation ID)

---

​

Solicitation Download

​

endpoint:

/solicitation/download

​

summary:

Download the solicitation file.

​

inputs:

• id: string (solicitation ID)

​

outputs:

• url: string (presigned/preauthorized download URL)
• success: boolean

---

​

Solicitation Attachment Download

​

endpoint:

/solicitation/attachment/download

​

summary:

Download the solicitation attachment file.

​

inputs:

• id: string (solicitation ID)
• key: string (solicitation attachment key)

​

outputs:

• url: string (presigned/preauthorized download URL)

---

​

Tagging The Solicitation

​

Solicitation Section Tag

​

endpoint:

/solicitation/section/tag

​

summary:

Tag a solicitation section.

​

inputs:

• id: string (solicitation ID)
• sectionId: string
• tag: string

​

outputs:

• success: boolean

---

​

Solicitation Section Autotag

​

endpoint:

/solicitation/section/autotag

​

summary:

Autotag all solicitation sections. If you want.

​

inputs:

• id: string (solicitation ID)

​

outputs:

• success: boolean

---

​

Solutioning

​

Solicitation Extract (Shred)

​

endpoint:

/solicitation/shred

​

summary:

Extract the solicitation sections which are precursor to response requirements and the outline.

​

inputs:

• id: string (solicitation ID)

​

outputs:

• success: boolean
• solicitation: FullSolicitation

---

​

Solutioning Create

​

endpoint:

/solutioning/create

​

summary:

Create solutioning record(s) - allows user to add to automated solutioning process.

​

inputs:

• id: string (solicitation ID)

​

outputs:

• success: boolean

---

​

Solutioning Helpful Endpoints

​

Solutioning Load

​

endpoint:

/solutioning/load

​

summary:

Load the solutioning for viewing. Array of Solutioning records.

​

inputs:

• id: string (solicitation ID)

​

outputs:

• items: ISolutioningItem[]

---

​

Solutioning Update

​

endpoint:

/solutioning/update

​

summary:

Update the solutioning record.

​

inputs:

• id: string (solicitation ID)
• itemId: string
• question: string
• answer: string

​

outputs:

• success: boolean

---

​

Solutioning Answer

​

endpoint:

/solutioning/answer

​

summary:

Answer the solutioning questions with AI and the customer’s library.

​

inputs:

• id: string (solicitation ID)

​

outputs:

• success: boolean

---

​

Solutioning Answer Item

​

endpoint:

/solutioning/answer-item

​

summary:

Answer the solutioning question with AI and the customer’s library.

​

inputs:

• id: string (solicitation ID)
• itemId: string

​

outputs:

• success: boolean

---

​

Solutioning Delete

​

endpoint:

/solutioning/delete

​

summary:

Delete the solutioning record.

​

inputs:

• id: string (solicitation ID)
• itemId: string

​

outputs:

• success: boolean

---

​

Response Outline

​

Generate Outline

​

endpoint:

/response/outline/generate

​

summary:

Make the outline for the draft proposal

​

inputs:

• id: string (solicitation ID)

​

outputs:

• success: boolean

---

​

Response Outline Load

​

endpoint:

/response/outline/load

​

summary:

Load the outline for viewing.

​

inputs:

• id: string (solicitation ID)

​

outputs:

• sections: FullResponseSection[]

---

​

Revise the Outline

​

Response Outline Structure

​

endpoint:

/response/outline/structure

​

summary:

Modify the structure of the outline for the draft proposal

​

inputs:

• id: string (solicitation ID)
• structure: string

​

outputs:

• success: boolean

---

​

Response Section Create

​

endpoint:

/response/section/create

​

summary:

Create a new section in the outline

​

inputs:

• id: string (solicitation ID)
• prevId?: string | null
• parentId?: string | null

​

outputs:

• success: boolean

---

​

Response Section Delete

​

endpoint:

/response/section/delete

​

summary:

Delete a section from the outline

​

inputs:

• id: string (solicitation ID)
• sectionId: string

​

outputs:

• success: boolean

---

​

Response

​

Response Generate

​

endpoint:

/response/generate

​

summary:

Generate the response for the draft proposal

​

inputs:

• id: string (solicitation ID)

​

outputs:

• success: boolean

​

Response Section Generate

​

endpoint:

/response/section/generate

​

summary:

Generate the section for the draft proposal

​

inputs:

• id: string (solicitation ID)
• sectionId: string
• instructions?: string

​

outputs:

• success: boolean

---

​

Exporting

​

Response Export

​

endpoint:

/response/export

​

summary:

Export the response for viewing.

​

inputs:

• id: string (solicitation ID)

​

outputs:

• url: string (presigned/preauthorizeddownload URL)

---

​

Response Load

​

endpoint:

/response/load

​

summary:

Load the response for viewing.

​

inputs:

• id: string (solicitation ID)

​

outputs:

• sections: FullResponseSection[]