BidAuthorBidAuthor
Get Started
API reference

Proposals

141 endpoints under /v1/rfp.

assignees3
assignments6
attachments10
background3
design1
export4
guidance5
instructions4
intake12
items12
live1
package6
proposals4
pursuit notes4
response32
submission5
tasks11
work18

assignees

List Assignees

get/v1/rfp/proposals/{proposal_id}/assignees

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Add Assignee

post/v1/rfp/proposals/{proposal_id}/assignees

Put a member on the pursuit. Idempotent: adding an existing assignee returns 200 with the existing row.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • user_idstring (uuid)required

Failures return the error envelope; branch on error_code.

Request
Response

Remove Assignee

delete/v1/rfp/proposals/{proposal_id}/assignees/{user_id}

Path parameters

  • proposal_idstring (uuid)required
  • user_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

assignments

List My Assignments

get/v1/rfp/assignments/mine

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

List Assignments

get/v1/rfp/proposals/{proposal_id}/assignments

Path parameters

  • proposal_idstring (uuid)required

Query parameters

  • minebooleanoptional

    Only the caller's open assignments.

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Assign Section

post/v1/rfp/sections/{section_id}/assignment

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • user_idstring (uuid)required
  • due_atstring (date-time)optional
  • notestringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Release Section

delete/v1/rfp/sections/{section_id}/assignment

Path parameters

  • section_idstring (uuid)required

Query parameters

  • user_idstring (uuid)optional

    Whom to release. Absent → the caller.

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Assign Task

post/v1/rfp/tasks/{task_id}/assignment

Path parameters

  • task_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • user_idstring (uuid)required
  • due_atstring (date-time)optional
  • notestringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Release Task

delete/v1/rfp/tasks/{task_id}/assignment

Path parameters

  • task_idstring (uuid)required

Query parameters

  • user_idstring (uuid)optional

    Whom to release. Absent → the caller.

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

attachments

List Proposal Documents

get/v1/rfp/proposals/{proposal_id}/documents

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Link Proposal Document

post/v1/rfp/proposals/{proposal_id}/documents

Tie a document to the whole proposal. Every section writer reads it from then on.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • document_idstring (uuid)required

Failures return the error envelope; branch on error_code.

Request
Response

Unlink Proposal Document

delete/v1/rfp/proposals/{proposal_id}/documents/{document_id}

Path parameters

  • proposal_idstring (uuid)required
  • document_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

List All Proposal Documents

get/v1/rfp/proposals/{proposal_id}/documents/all

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

List Section Documents

get/v1/rfp/sections/{section_id}/documents

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Link Section Document

post/v1/rfp/sections/{section_id}/documents

Tie a document to a section. Once indexed, the section catches up through settle.

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • document_idstring (uuid)required

Failures return the error envelope; branch on error_code.

Request
Response

Unlink Section Document

delete/v1/rfp/sections/{section_id}/documents/{document_id}

Path parameters

  • section_idstring (uuid)required
  • document_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

List Task Documents

get/v1/rfp/tasks/{task_id}/documents

Path parameters

  • task_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Link Task Document

post/v1/rfp/tasks/{task_id}/documents

Tie a document to a task. Once indexed, the task is marked changed so the work engine re-runs it.

Path parameters

  • task_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • document_idstring (uuid)required

Failures return the error envelope; branch on error_code.

Request
Response

Unlink Task Document

delete/v1/rfp/tasks/{task_id}/documents/{document_id}

Path parameters

  • task_idstring (uuid)required
  • document_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

background

Get Background

get/v1/rfp/proposals/{proposal_id}/background

Return the background narrative, its source items, glossary and stale flag. The narrative body is Markdown with [n] citations.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Rewrite Background

post/v1/rfp/proposals/{proposal_id}/background/rewrite

Queue the background stage. queued is false when there is nothing to write or a writer already holds it.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • forcebooleanoptional

Failures return the error envelope; branch on error_code.

Request
Response

Get Background Segment

get/v1/rfp/proposals/{proposal_id}/background/segments/{item_id}

Path parameters

  • proposal_idstring (uuid)required
  • item_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

design

Post Design

post/v1/rfp/volume-versions/{volume_version_id}/design

Path parameters

  • volume_version_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • instructionstringrequired

    What the designer should do.

  • focusstringoptional

    The block or section it centres on.

Failures return the error envelope; branch on error_code.

Request
Response

export

Download Export

get/v1/rfp/exports/{export_id}/download

A short-lived link to the file exactly as it was exported.

Path parameters

  • export_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Checks

get/v1/rfp/proposal-versions/{proposal_version_id}/checks

The version against the buyer's submission rules and scoring, as it stands now.

Path parameters

  • proposal_version_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Create Export

post/v1/rfp/proposal-versions/{proposal_version_id}/exports

Export the version, or one of its volumes, and keep the file. A final is refused with export_blocked_by_checks while a hard check fails.

Path parameters

  • proposal_version_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • formatenumoptional
    pdfdocx
  • kindenumoptional

    A draft is always allowed. A final is refused while a hard check fails, moves the proposal's stage to final and refreshes its library copy.

    draftfinal
  • volume_idstring (uuid)optional

Failures return the error envelope; branch on error_code.

Request
Response

List Proposal Exports

get/v1/rfp/proposals/{proposal_id}/exports

Every export the proposal has kept, newest first.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

guidance

List Guidance

get/v1/rfp/proposals/{proposal_id}/guidance

Path parameters

  • proposal_idstring (uuid)required

Query parameters

  • statusstringoptional

    Comma-separated statuses to keep.

  • section_idstring (uuid)optional

    Only the questions feeding this section.

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Answer Guidance

patch/v1/rfp/proposals/{proposal_id}/guidance/{question_id}

Path parameters

  • proposal_idstring (uuid)required
  • question_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • statusstringrequired
  • answer_choicestringoptional
  • answer_bodystringoptional
  • version_idstring (uuid)optional

Failures return the error envelope; branch on error_code.

Request
Response

Rephrase Guidance Question

put/v1/rfp/proposals/{proposal_id}/guidance/{question_id}/question

Path parameters

  • proposal_idstring (uuid)required
  • question_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • questionstringrequired

Failures return the error envelope; branch on error_code.

Request
Response

Set Guidance Sections

put/v1/rfp/proposals/{proposal_id}/guidance/{question_id}/sections

Path parameters

  • proposal_idstring (uuid)required
  • question_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • section_idsstring (uuid)[]optional

Failures return the error envelope; branch on error_code.

Request
Response

Next Guidance

post/v1/rfp/proposals/{proposal_id}/guidance/next

Start the next batch of questions unless enough are waiting or one is being written. Idempotent.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • version_idstring (uuid)optional

Failures return the error envelope; branch on error_code.

Request
Response

instructions

Create Instruction

post/v1/rfp/proposals/{proposal_id}/instructions

Add one note or context entry to the pursuit. Appended at the end of the stack: order is meaningful, later entries read as refinements of earlier ones.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • titlestringrequired
  • bodystringrequired
  • kindstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Patch Instruction

patch/v1/rfp/proposals/{proposal_id}/instructions/{instruction_id}

Edit one entry. Absent fields are left unchanged.

Path parameters

  • proposal_idstring (uuid)required
  • instruction_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • titlestringoptional
  • bodystringoptional
  • kindstringoptional
  • positionintegeroptional

Failures return the error envelope; branch on error_code.

Request
Response

Delete Instruction

delete/v1/rfp/proposals/{proposal_id}/instructions/{instruction_id}

Remove one entry. Past generations are unaffected: instructions are read at run time, never snapshotted onto answers.

Path parameters

  • proposal_idstring (uuid)required
  • instruction_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Add Item Context

post/v1/rfp/proposals/{proposal_id}/items/{item_id}/context

Attach one context fact to one item. Read when the item's task runs; not retroactive. Results already written change only on re-run.

Path parameters

  • proposal_idstring (uuid)required
  • item_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • bodystringrequired
  • titlestringoptional

Failures return the error envelope; branch on error_code.

Request
Response

intake

File Content

get/v1/rfp/package/files/{file_id}/content

Return the file's bytes, inline for the viewer (decks as PDF) or as a download.

Path parameters

  • file_idstring (uuid)required

Query parameters

  • dispositionenumoptional
    inlineattachment

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

File Sheet

get/v1/rfp/package/files/{file_id}/sheet

The file's sheets for the read-only grid: the first rows of each, with their styling.

Path parameters

  • file_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

File Text

get/v1/rfp/package/files/{file_id}/text

Path parameters

  • file_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Create From Files

post/v1/rfp/proposals

Create a proposal from files, a folder or a zip. kind and side are the caller's choice, each once for all files or once per file; without them each is guessed from the filename and corrected when the text is read. Re-uploading the same package returns the proposal it already made.

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Form fields

  • filefile[]required
  • kindstring[]optional
  • sidestring[]optional

    Whose file: buyer or ours; once for all files or once per file.

  • namestringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Open Document

post/v1/rfp/proposals/{proposal_id}/document

Start writing: the proposal's document, made on first call. Idempotent: a proposal that already has a document returns it, so every "start writing" door opens the same one.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Read Facts Again

post/v1/rfp/proposals/{proposal_id}/facts

Re-read the solicitation's title, issuer, reference, type and deadlines. Without force only empty fields are filled, and a deadline this reader wrote earlier is corrected; one a person set is left as it is.

Path parameters

  • proposal_idstring (uuid)required

Query parameters

  • forcebooleanoptional

    Overwrite values already set, not only fill the empty ones

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Add Package Files

post/v1/rfp/proposals/{proposal_id}/package/files

Add files or pasted text to a package. Each is read on its own once its text is in, with the package's existing contents as context. This is the single entry point for adding files.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Form fields

  • filefile[]optional
  • textstringoptional

    Pasted content (an email, a note) instead of, or beside, files.

  • namestringoptional

    The pasted content's name.

  • kindstring[]optional

Failures return the error envelope; branch on error_code.

Request
Response

Extract Again

post/v1/rfp/proposals/{proposal_id}/package/files/{file_id}/extract

Try a failed extraction again, metered like adding a file.

Path parameters

  • proposal_idstring (uuid)required
  • file_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Read Again

post/v1/rfp/proposals/{proposal_id}/package/read

Re-read every buyer file from scratch. Reader-written items are retired first (user-added items stay), so the package's items are exactly one fresh read.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Fetch Reference

post/v1/rfp/proposals/{proposal_id}/package/references/{reference_id}/fetch

Download a document the package references but does not include. The result is read like any buyer file. A web page lands as its text; a PDF, Word file or sheet lands as itself.

Path parameters

  • proposal_idstring (uuid)required
  • reference_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Shred Package

post/v1/rfp/proposals/{proposal_id}/package/shred

Shred the package's unshredded files, all or the chosen ones. Lifts the read hold and queues the reader. Files already reading are not queued again; a repeat call while they run returns them.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • file_idsstring (uuid)[]optional

Failures return the error envelope; branch on error_code.

Request
Response

Create Blank

post/v1/rfp/proposals/blank

Create a proposal with no files, its document ready to write in. One transaction: the proposal, its standing guidance and its document (volume, first draft, primary version) land together or not at all. Files may be added later.

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • namestringrequired
  • solicitation_typestringoptional
  • issuerstringoptional
  • reference_numberstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

items

Get Item

get/v1/rfp/items/{item_id}

Path parameters

  • item_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Update Item

patch/v1/rfp/items/{item_id}

Path parameters

  • item_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • textstringoptional
  • categoriesenum[]optional
  • detailsobjectoptional

    At most one block per category; a block only for a category the item has.

  • strengthenumoptional

    The buyer's modal verb: shall/must, should, may, or plain information.

    mustshouldmayinfo

Failures return the error envelope; branch on error_code.

Request
Response

Link Items

post/v1/rfp/items/{item_id}/links

Path parameters

  • item_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • to_item_idstring (uuid)required
  • kindenumrequired

    How one item relates to another.

    same_aspart_ofdepends_on
  • confidencenumberoptional
  • reasonstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Restore Item

post/v1/rfp/items/{item_id}/restore

Path parameters

  • item_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Retire Item

post/v1/rfp/items/{item_id}/retire

Path parameters

  • item_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Add Source

post/v1/rfp/items/{item_id}/sources

Path parameters

  • item_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • file_idstring (uuid)required
  • quotestringrequired
  • pageintegeroptional
  • buyer_labelstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

List Items

get/v1/rfp/proposals/{proposal_id}/items

Path parameters

  • proposal_idstring (uuid)required

Query parameters

  • filestring (uuid)optional
  • headingstring (uuid)optional
  • categoryenumoptional

    What the buyer is telling us. An item carries one or more. Checkable today -> attestation; about after we win -> obligation; the legal or money side of the deal -> contract_term; nobody owes anything -> background.

    questionobligationattestationdeliverablecontract_terminstruction
  • topicstringoptional

    A topic slug; its children are included.

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Create Item

post/v1/rfp/proposals/{proposal_id}/items

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • textstringrequired
  • categoriesenum[]required
  • detailsobjectoptional

    At most one block per category; a block only for a category the item has.

  • strengthenumoptional

    The buyer's modal verb: shall/must, should, may, or plain information.

    mustshouldmayinfo

Failures return the error envelope; branch on error_code.

Request
Response

List Topics

get/v1/rfp/topics

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Create Topic

post/v1/rfp/topics

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • slugstringrequired
  • namestringrequired

Failures return the error envelope; branch on error_code.

Request
Response

live

Stream Proposal

get/v1/rfp/proposals/{proposal_id}/stream

Path parameters

  • proposal_idstring (uuid)required

Query parameters

  • sincestringoptional

    Resume cursor: the last event id seen. '$' (default) for new frames only, '0-0' for the retained history.

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

package

Update File

patch/v1/rfp/package/files/{file_id}

Path parameters

  • file_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • sideenumoptional

    Whose file it is: the buyer's package, or our own material.

    buyerours
  • kindenumoptional

    What a buyer file is. Our own files carry reference.

    solicitationaddendumclarificationqa_roundscopeexhibit
  • shapeenumoptional

    How a file is read: shredded prose, a grid of rows, or a form's fields.

    prosegridform
  • namestringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Remove File

delete/v1/rfp/package/files/{file_id}

Path parameters

  • file_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Update Reference

patch/v1/rfp/package/references/{reference_id}

Path parameters

  • reference_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • statusenumoptional

    A document the package names but does not include.

    missingfetcheddismissed
  • urlstringoptional
  • file_idstring (uuid)optional

Failures return the error envelope; branch on error_code.

Request
Response

Get Package

get/v1/rfp/proposals/{proposal_id}/package

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Add Heading

post/v1/rfp/proposals/{proposal_id}/package/headings

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • titlestringrequired
  • file_idstring (uuid)optional
  • parent_idstring (uuid)optional
  • labelstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Add Reference

post/v1/rfp/proposals/{proposal_id}/package/references

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • titlestringrequired
  • urlstringoptional
  • named_in_file_idstring (uuid)optional

Failures return the error envelope; branch on error_code.

Request
Response

proposals

List Proposals

get/v1/rfp/proposals

List proposals visible to the caller, newest first, with package and task status.

Query parameters

  • workspace_idstring (uuid)optional

    Filter by workspace ID

  • include_sharedbooleanoptional

    Include org-wide shared proposals

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Get Proposal

get/v1/rfp/proposals/{proposal_id}

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Update Proposal

patch/v1/rfp/proposals/{proposal_id}

Edit a proposal's identity, lifecycle fields and review_all_arthur. A key present sets, null clears, absent leaves the field alone.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Delete Proposal

delete/v1/rfp/proposals/{proposal_id}

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

pursuit notes

List Notes

get/v1/rfp/proposals/{proposal_id}/notes

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Create Note

post/v1/rfp/proposals/{proposal_id}/notes

Append a note after the current last position.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • kindstringrequired
  • textstringrequired
  • version_idstring (uuid)optional

Failures return the error envelope; branch on error_code.

Request
Response

Patch Note

patch/v1/rfp/proposals/{proposal_id}/notes/{note_id}

Path parameters

  • proposal_idstring (uuid)required
  • note_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • kindstringoptional
  • textstringoptional
  • positionintegeroptional

Failures return the error envelope; branch on error_code.

Request
Response

Delete Note

delete/v1/rfp/proposals/{proposal_id}/notes/{note_id}

Path parameters

  • proposal_idstring (uuid)required
  • note_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

response

List Outline Templates

get/v1/rfp/outline-templates

The organization's outline templates, for the new-document picker.

Query parameters

  • qstringoptional

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Update Piece

patch/v1/rfp/pieces/{piece_id}

Path parameters

  • piece_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • contentobjectoptional
  • from_task_idstring (uuid)optional
  • positionintegeroptional

Failures return the error envelope; branch on error_code.

Request
Response

Delete Piece

delete/v1/rfp/pieces/{piece_id}

Path parameters

  • piece_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Update Proposal Version

patch/v1/rfp/proposal-versions/{proposal_version_id}

Path parameters

  • proposal_version_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • namestringoptional
  • is_primarybooleanoptional

Failures return the error envelope; branch on error_code.

Request
Response

Delete Proposal Version

delete/v1/rfp/proposal-versions/{proposal_version_id}

Path parameters

  • proposal_version_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Set Pick

put/v1/rfp/proposal-versions/{proposal_version_id}/picks

Path parameters

  • proposal_version_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • volume_idstring (uuid)required
  • volume_version_idstring (uuid)required

Failures return the error envelope; branch on error_code.

Request
Response

Drop Pick

delete/v1/rfp/proposal-versions/{proposal_version_id}/picks/{volume_id}

Path parameters

  • proposal_version_idstring (uuid)required
  • volume_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

List Proposal Versions

get/v1/rfp/proposals/{proposal_id}/versions

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Create Proposal Version

post/v1/rfp/proposals/{proposal_id}/versions

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • namestringrequired
  • is_primarybooleanoptional
  • copy_from_idstring (uuid)optional
  • picksobject[]optional

Failures return the error envelope; branch on error_code.

Request
Response

List Volumes

get/v1/rfp/proposals/{proposal_id}/volumes

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Create Volume

post/v1/rfp/proposals/{proposal_id}/volumes

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • kindenumrequired
    technicalmanagementpast_performancepriceformscompliance_matrix
  • titlestringrequired
  • shapeenumoptional

    What a volume ships as. One rendered document, the buyer's own spreadsheet filled, the buyer's own form filled, or a bundle where each section is its own file.

    documentworkbookformbundle
  • workbook_idstring (uuid)optional

Failures return the error envelope; branch on error_code.

Request
Response

Get Section

get/v1/rfp/sections/{section_id}

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Update Section

patch/v1/rfp/sections/{section_id}

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • parent_idstring (uuid)optional
  • positionintegeroptional
  • titlestringoptional
  • roleenumoptional
    transmittalexec_summaryunderstandingapproachmanagementstaffing

Failures return the error envelope; branch on error_code.

Request
Response

Delete Section

delete/v1/rfp/sections/{section_id}

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Aim At

post/v1/rfp/sections/{section_id}/criteria

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • item_idstring (uuid)required

Failures return the error envelope; branch on error_code.

Request
Response

Stop Aiming

delete/v1/rfp/sections/{section_id}/criteria/{item_id}

Path parameters

  • section_idstring (uuid)required
  • item_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Get Section Draft

get/v1/rfp/sections/{section_id}/draft

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Replace Flow

put/v1/rfp/sections/{section_id}/flow

Save a section's whole body, its pieces in reading order, as one edit.

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • piecesobject[]required

Failures return the error envelope; branch on error_code.

Request
Response

Add Piece

post/v1/rfp/sections/{section_id}/pieces

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • kindenumrequired
    textimagechartdiagramtablepeople
  • contentobjectoptional
  • from_task_idstring (uuid)optional
  • positionintegeroptional

    Insert here; the end when omitted.

Failures return the error envelope; branch on error_code.

Request
Response

Get Proposed Revision

get/v1/rfp/sections/{section_id}/proposed-revision

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Accept Proposed Revision

post/v1/rfp/sections/{section_id}/proposed-revision/accept

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Dismiss Proposed Revision

post/v1/rfp/sections/{section_id}/proposed-revision/dismiss

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Place Task

post/v1/rfp/sections/{section_id}/tasks

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • task_idstring (uuid)required
  • roleenumoptional

    What a section does with a task: answers it, or mentions it.

    answersmentions
  • adapted_textstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Unplace Task

delete/v1/rfp/sections/{section_id}/tasks/{task_id}

Path parameters

  • section_idstring (uuid)required
  • task_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Update Volume Version

patch/v1/rfp/volume-versions/{volume_version_id}

Path parameters

  • volume_version_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • labelstringoptional
  • frameobjectoptional

Failures return the error envelope; branch on error_code.

Request
Response

Delete Volume Version

delete/v1/rfp/volume-versions/{volume_version_id}

Path parameters

  • volume_version_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Outline

get/v1/rfp/volume-versions/{volume_version_id}/outline

Path parameters

  • volume_version_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Create Section

post/v1/rfp/volume-versions/{volume_version_id}/sections

Path parameters

  • volume_version_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • parent_idstring (uuid)optional
  • positionintegeroptional
  • titlestringoptional
  • roleenumoptional
    transmittalexec_summaryunderstandingapproachmanagementstaffing

Failures return the error envelope; branch on error_code.

Request
Response

Bulk Sections

post/v1/rfp/volume-versions/{volume_version_id}/sections/bulk

Delete, merge, assign or release the outline's selection in one request.

Path parameters

  • volume_version_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • section_idsstring (uuid)[]required
  • openumrequired
    deletemergeassignrelease
  • assignee_idstring (uuid)optional

Failures return the error envelope; branch on error_code.

Request
Response

Update Volume

patch/v1/rfp/volumes/{volume_id}

Path parameters

  • volume_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • titlestringoptional
  • page_limitintegeroptional
  • frameobjectoptional
  • positionintegeroptional

Failures return the error envelope; branch on error_code.

Request
Response

Delete Volume

delete/v1/rfp/volumes/{volume_id}

Path parameters

  • volume_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Create Volume Version

post/v1/rfp/volumes/{volume_id}/versions

Path parameters

  • volume_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • labelstringrequired
  • copy_from_idstring (uuid)optional

Failures return the error envelope; branch on error_code.

Request
Response

submission

Read Submission

get/v1/rfp/proposals/{proposal_id}/submission

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Derive

post/v1/rfp/proposals/{proposal_id}/submission/derive

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Add Item

post/v1/rfp/proposals/{proposal_id}/submission/items

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • labelstringrequired
  • typeenumrequired

    What completes a submission item. The first four are the volume shapes that fill it (VolumeShape); an answer item is completed by a typed value kept on the item itself and has no volume.

    documentworkbookformbundleanswer
  • channelenumoptional

    How a submission item reaches the buyer; the same words as the ingestion contract's SubmissionEntry.channel.

    portal_uploadportal_fieldemailmailin_person
  • presenceenumoptional

    Whether the buyer expects the item from this bidder.

    requiredoptionalhidden

Failures return the error envelope; branch on error_code.

Request
Response

Update Item

patch/v1/rfp/proposals/{proposal_id}/submission/items/{item_id}

Path parameters

  • proposal_idstring (uuid)required
  • item_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • labelstringoptional
  • typeenumoptional

    What completes a submission item. The first four are the volume shapes that fill it (VolumeShape); an answer item is completed by a typed value kept on the item itself and has no volume.

    documentworkbookformbundleanswer
  • channelenumoptional

    How a submission item reaches the buyer; the same words as the ingestion contract's SubmissionEntry.channel.

    portal_uploadportal_fieldemailmailin_person
  • presenceenumoptional

    'hidden' marks it not applicable to this bid.

    requiredoptionalhidden

Failures return the error envelope; branch on error_code.

Request
Response

Reorder

put/v1/rfp/proposals/{proposal_id}/submission/order

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • item_idsstring (uuid)[]required

    Every item of the proposal, in the new order.

Failures return the error envelope; branch on error_code.

Request
Response

tasks

Proposal State

get/v1/rfp/proposals/{proposal_id}/state

Path parameters

  • proposal_idstring (uuid)required

Query parameters

  • filestring (uuid)optional

    Tasks settling items from this package file.

  • sheetstringoptional

    …from this sheet of a grid file.

  • sectionstring (uuid)optional

    Tasks this section answers or mentions.

  • volumestring (uuid)optional

    Tasks that land in this volume: its sections, its sheet's cells or its form.

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

List Tasks

get/v1/rfp/proposals/{proposal_id}/tasks

Path parameters

  • proposal_idstring (uuid)required

Query parameters

  • filestring (uuid)optional

    Tasks settling items from this package file.

  • sheetstringoptional

    …from this sheet of a grid file.

  • sectionstring (uuid)optional

    Tasks this section answers or mentions.

  • volumestring (uuid)optional

    Tasks that land in this volume: its sections, its sheet's cells or its form.

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Create Task

post/v1/rfp/proposals/{proposal_id}/tasks

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • titlestringrequired
  • askstringoptional
  • ownerenumoptional
    arthurperson
  • originenumoptional

    Where a task came from: the buyer's package, or our own side.

    packagearthurwriterteam

Failures return the error envelope; branch on error_code.

Request
Response

List Org Tasks

get/v1/rfp/tasks

List tasks across every proposal in the organization. The "needs you" page is ?state=needs_you&assignee=me.

Query parameters

  • stateenumoptional

    The one status vocabulary — tasks, sections, cells and fields alike. Derived from a task's facts by domains.proposals.tasks.status; never written by hand. "Arthur working" and "waiting on X" are live indicators, not states.

    to_doneeds_youreviewdonenot_needed
  • assigneestringoptional

    me for the caller, or a user id.

  • limitintegeroptional

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Get Task

get/v1/rfp/tasks/{task_id}

Path parameters

  • task_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Update Task

patch/v1/rfp/tasks/{task_id}

Path parameters

  • task_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • titlestringoptional
  • askstringoptional
  • ownerenumoptional
    arthurperson
  • resultobjectoptional

    What a task has produced so far. One task can hold several blocks (an answer and its compliance).

Failures return the error envelope; branch on error_code.

Request
Response

Delete Task

delete/v1/rfp/tasks/{task_id}

Path parameters

  • task_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Add Cell

post/v1/rfp/tasks/{task_id}/cells

Path parameters

  • task_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • workbook_idstring (uuid)required
  • sheet_idstring (uuid)required
  • rowintegerrequired
  • colintegerrequired

Failures return the error envelope; branch on error_code.

Request
Response

Remove Cell

delete/v1/rfp/tasks/{task_id}/cells/{workbook_id}/{sheet_id}/{row}/{col}

Path parameters

  • task_idstring (uuid)required
  • workbook_idstring (uuid)required
  • sheet_idstring (uuid)required
  • rowintegerrequired
  • colintegerrequired

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Link Item

post/v1/rfp/tasks/{task_id}/items

Path parameters

  • task_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • item_idstring (uuid)required
  • coverageenumoptional

    How much of an item a task settles.

    fullpartial
  • outcomeobjectoptional

Failures return the error envelope; branch on error_code.

Request
Response

Unlink Item

delete/v1/rfp/tasks/{task_id}/items/{item_id}

Path parameters

  • task_idstring (uuid)required
  • item_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

work

List Proposal Assets

get/v1/rfp/proposals/{proposal_id}/assets

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Upload Proposal Asset

post/v1/rfp/proposals/{proposal_id}/assets

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Form fields

  • filefilerequired

Failures return the error envelope; branch on error_code.

Request
Response

Read Drafting

get/v1/rfp/proposals/{proposal_id}/drafting

Whether the person gave the go to draft, what runs before it, and the automatic spend limit.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Update Drafting

patch/v1/rfp/proposals/{proposal_id}/drafting

Give or take back the go, choose what runs before it, set the automatic spend limit.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • gobooleanoptional
  • auto_stepsenum[]optional
  • auto_credit_limitintegeroptional
  • clear_auto_credit_limitbooleanoptional

Failures return the error envelope; branch on error_code.

Request
Response

Kickoff

post/v1/rfp/proposals/{proposal_id}/kickoff

The person's go to draft: tasks are planned and worked, and the conductor outlines the package and writes each section once its tasks are answered.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • steeringstringoptional
  • guideline_idsstring (uuid)[]optional

Failures return the error envelope; branch on error_code.

Request
Response

Kickoff Quote

post/v1/rfp/proposals/{proposal_id}/kickoff/quote

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • steeringstringoptional
  • guideline_idsstring (uuid)[]optional

Failures return the error envelope; branch on error_code.

Request
Response

Accept Outline

post/v1/rfp/proposals/{proposal_id}/outline/accept

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • outlineobjectrequired
  • task_keysobjectrequired
  • criterion_keysobjectoptional
  • doc_keysobjectoptional

Failures return the error envelope; branch on error_code.

Request
Response

Get Outline Offer

get/v1/rfp/proposals/{proposal_id}/outline/offer

The outline proposed and not yet accepted or discarded, or null: it survives a reload.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Discard Outline Offer

delete/v1/rfp/proposals/{proposal_id}/outline/offer

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Propose Outline

post/v1/rfp/proposals/{proposal_id}/outline/proposal

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • steeringstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Plan

post/v1/rfp/proposals/{proposal_id}/tasks/plan

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Place Tasks

post/v1/rfp/proposals/{proposal_id}/volume-versions/{volume_version_id}/place-tasks

Path parameters

  • proposal_idstring (uuid)required
  • volume_version_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Work

post/v1/rfp/proposals/{proposal_id}/work

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • task_idsstring (uuid)[]optional
  • steeringstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Work Quote

post/v1/rfp/proposals/{proposal_id}/work/quote

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • task_idsstring (uuid)[]optional
  • steeringstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Write Sections

post/v1/rfp/proposals/{proposal_id}/write

A person hands sections to the writers: the same background run as Arthur's write_sections. Returns the run at once; each row reads Queued, then Researching and Writing, and lands as its writer finishes.

Path parameters

  • proposal_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • section_idsstring (uuid)[]required
  • steeringstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Compose

post/v1/rfp/sections/{section_id}/compose

Path parameters

  • section_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Request body

  • steeringstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Volume Paper

get/v1/rfp/volume-versions/{volume_version_id}/paper

The paper document of one volume version (response.paper).

Path parameters

  • volume_version_idstring (uuid)required

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response

Volume Frame

get/v1/rfp/volumes/{volume_id}/frame

Path parameters

  • volume_idstring (uuid)required

Query parameters

  • volume_version_idstring (uuid)optional

Headers

  • X-Organization-IDstringoptional
  • X-Workspace-IDstringoptional

Failures return the error envelope; branch on error_code.

Request
Response