Skip to main content
POST
Restore the earlier company

Authorizations

X-API-Key
string
header
required

Query Parameters

dry_run
boolean
default:false

Answer the business context as it would be restored, and restore nothing.

Response

Successful Response

The org's business context, plus its latest generation job for resume.

company_description
string | null
required
company_type
enum<string> | null
required

How the company makes money. Descriptive context shown to the AI Assistant and MCP clients; no writer reads it yet.

Available options:
b2b_saas,
b2c_saas,
agency_services,
ecommerce_dtc,
marketplace,
manufacturing,
financial_services,
healthcare,
education,
nonprofit,
government,
media_publishing,
real_estate,
hospitality,
logistics,
other
company_type_choices
AiContextChoiceSchema · object[]
required

Every company_type value, in the order a picker lists them.

company_type_label
string | null
required

company_type as a page shows it.

created_at
string<date-time>
required
field_changes
Field Changes · object
required

Who last wrote each section and choice, by its field name, as each section's Last changed by line shows it. A section nobody has written since this was kept is absent. Only a workspace admin can change the business context.

first_run_available
boolean
required

Whether POST /ai-context/runs/ with no domain would start a first run now: the signed-in user created the workspace with a company email address, no field has text, and no run has been made. Ask for that run only when this is true; otherwise it is refused (422, domain_required). Always false for an API key.

id
string<uuid>
required
ideal_buyer_personas
string | null
required
ideal_customer_profile
string | null
required
interest_signals
string | null
required
last_generated_at
string<date-time> | null
required
latest_generation_job
AiContextGenerationJobReadSchema · object | null
required

The org's most recent generation job, if any. Lets a reloaded page resume polling a job that is still running.

max_context_chars
integer
required

How many characters of included reference document summaries one prompt reads, oldest document first. Documents past that line report in_prompt_budget: false.

max_documents
integer
required

How many reference documents this workspace may keep.

max_qa_answer_chars
integer
required

The longest a Q&A answer may be.

max_qa_context_chars
integer
required

How many characters of the Q&A one reply's prompt reads, the newest answers first. Answers past that line report in_prompt: false on GET /ai-context/qa/.

max_qa_entries
integer
required

How many questions this workspace's Q&A may hold.

max_qa_question_chars
integer
required

The longest a Q&A question may be.

sells_to
enum<string> | null
required

Who buys from the company. Descriptive context shown to the AI Assistant and MCP clients; no writer reads it yet.

Available options:
businesses,
consumers,
both
sells_to_choices
AiContextChoiceSchema · object[]
required

Every sells_to value, in the order a picker lists them.

sells_to_label
string | null
required

sells_to as a page shows it.

social_proof
string | null
required
source_domain
string | null
required

The domain last used to generate these fields; null until a generation succeeds.

source_url
string | null
required

The page the last generation's company description came from, one of the pages it read; null when it named none. Read-only.

updated_at
string<date-time>
required
voice
string | null
required

How the company words things: spelling, formality, what it calls its product and its buyers, jargon it avoids. The outbound agent matches it in every message.

messages_held_for_never_say
integer
default:0

On a save that added phrases to Never say: how many messages written before and still waiting to go out say one of them, now held in Tasks for a person (each needs Approve anyway). 0 on every other answer.

never_say
string[]

Never say: phrases and claims no AI message may use, in the order an admin wrote them. Every message the agent drafts is checked against them: written once more without the phrase, then held in Tasks for a person if it is still there.

pilot_offer
string | null

What the company gives a new customer free to start, such as a free trial, plan or pilot, in a line. Every generation reads it off the company's own site and leaves it null where the site offers nothing free. The Introduce your company sequence template offers it, and asks for a short call while it is null.

previous_company
AiContextPreviousCompanySchema · object | null

The company a run for another website replaced, kept for 30 days so a workspace admin can put it back with POST /ai-context/previous-company/restore/; null when none was replaced or the 30 days have passed.

run_review
AiContextRunReviewSchema · object | null

The latest website run's review while it is still open: what the run replaced, so a page reloaded mid review shows it again and Keep everything as it was still works. Null once it is put back, applied (a save with settles_run), or when the run replaced nothing.