Developer · API reference

Business entities

Create, read, update and delete segments, offerings, locations and ideal customers.

The entities below make up a company’s Knowledge Base: the segments, offerings, locations and ideal-customer profiles LunaLift turns into schema and uses to steer prompt generation.

Each entity type shares the same shape: a `POST` to upsert (create or update), a `GET` to read one by ID, and a `DELETE` to remove it. Set the optional `update_prompts=true` query flag when you want an edit to refresh the prompts derived from that entity.

POST /company/segment/{company_id}

Upsert Segment

Upsert a segment with value proposition relationship management

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`company_id`	string	Yes	—

Query parameters

Name	Type	Required	Default	Description
`update_prompts`	boolean	No	false	—

Request body· Segment

Field	Type	Required	Description
`id`	string	No	—
`companyId`	string	Yes	—
`evaluate`	boolean	No	—
`createdAt`	string	No	—
`updatedAt`	string	No	—
`deletedAt`	string \| null	No	—
`name`	string	Yes	—
`brand`	string	No	—
`description`	string \| null	No	—
`valuePropositions`	ValueProposition[]	No	—

Example request

curl -X POST "https://api.lunalift.ai/company/segment/COMPANY_ID" \
  -H "Authorization: Bearer ll_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "companyId": "string",
  "name": "string"
}'

Response · 200 OK

Returns a JSON object on success.

GET /company/segment/{segment_id}

Get Segment

Get a specific segment by ID

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`segment_id`	string	Yes	—

Example request

curl -X GET "https://api.lunalift.ai/company/segment/SEGMENT_ID" \
  -H "Authorization: Bearer ll_your_api_key"

Response · 200 OK

Returns a JSON object on success.

DELETE /company/segment/{segment_id}

Delete Segment

Delete a segment with prompt management options

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`segment_id`	string	Yes	—

Query parameters

Name	Type	Required	Default	Description
`deactivate_prompts`	boolean	No	true	—
`delete_prompts`	boolean	No	false	—
`remove_references`	boolean	No	true	—

Example request

curl -X DELETE "https://api.lunalift.ai/company/segment/SEGMENT_ID" \
  -H "Authorization: Bearer ll_your_api_key"

Response · 200 OK

Returns a JSON object on success.

POST /company/offering/{company_id}

Upsert Offering

Upsert an offering

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`company_id`	string	Yes	—

Request body· Offering

Field	Type	Required	Description
`id`	string	No	—
`companyId`	string	Yes	—
`evaluate`	boolean	No	—
`createdAt`	string	No	—
`updatedAt`	string	No	—
`deletedAt`	string \| null	No	—
`offeringType`	OfferingType \| null	No	—
`detailedCategory`	string	Yes	—
`brand`	string	No	—
`description`	string \| null	No	—

Example request

curl -X POST "https://api.lunalift.ai/company/offering/COMPANY_ID" \
  -H "Authorization: Bearer ll_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "companyId": "string",
  "detailedCategory": "string"
}'

Response · 200 OK

Returns a JSON object on success.

GET /company/offering/{offering_id}

Get Offering

Get a specific offering by ID

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`offering_id`	string	Yes	—

Example request

curl -X GET "https://api.lunalift.ai/company/offering/OFFERING_ID" \
  -H "Authorization: Bearer ll_your_api_key"

Response · 200 OK

Returns a JSON object on success.

DELETE /company/offering/{offering_id}

Delete Offering

Delete an offering with prompt management options

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`offering_id`	string	Yes	—

Query parameters

Name	Type	Required	Default	Description
`deactivate_prompts`	boolean	No	true	—
`delete_prompts`	boolean	No	false	—
`remove_references`	boolean	No	true	—

Example request

curl -X DELETE "https://api.lunalift.ai/company/offering/OFFERING_ID" \
  -H "Authorization: Bearer ll_your_api_key"

Response · 200 OK

Returns a JSON object on success.

POST /company/location/{company_id}

Upsert Location

Upsert a location

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`company_id`	string	Yes	—

Request body· Location

Field	Type	Required	Description
`id`	string	No	—
`companyId`	string	Yes	—
`evaluate`	boolean	No	—
`createdAt`	string	No	—
`updatedAt`	string	No	—
`deletedAt`	string \| null	No	—
`country`	LocationCountry	No	Supported countries
`customLocation`	string \| null	No	—
`languages`	Language[]	No	—

Example request

curl -X POST "https://api.lunalift.ai/company/location/COMPANY_ID" \
  -H "Authorization: Bearer ll_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "companyId": "string"
}'

Response · 200 OK

Returns a JSON object on success.

GET /company/location/{location_id}

Get Location

Get a specific location by ID

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`location_id`	string	Yes	—

Example request

curl -X GET "https://api.lunalift.ai/company/location/LOCATION_ID" \
  -H "Authorization: Bearer ll_your_api_key"

Response · 200 OK

Returns a JSON object on success.

DELETE /company/location/{location_id}

Delete Location

Delete a location with prompt management options

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`location_id`	string	Yes	—

Query parameters

Name	Type	Required	Default	Description
`deactivate_prompts`	boolean	No	true	—
`delete_prompts`	boolean	No	false	—
`remove_references`	boolean	No	true	—

Example request

curl -X DELETE "https://api.lunalift.ai/company/location/LOCATION_ID" \
  -H "Authorization: Bearer ll_your_api_key"

Response · 200 OK

Returns a JSON object on success.

POST /company/idealcustomer/{company_id}

Upsert Ideal Customer

Upsert an ideal customer

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`company_id`	string	Yes	—

Request body· IdealCustomer

Field	Type	Required	Description
`id`	string	No	—
`companyId`	string	Yes	—
`evaluate`	boolean	No	—
`createdAt`	string	No	—
`updatedAt`	string	No	—
`deletedAt`	string \| null	No	—
`profileName`	string	Yes	—
`description`	string \| null	No	—

Example request

curl -X POST "https://api.lunalift.ai/company/idealcustomer/COMPANY_ID" \
  -H "Authorization: Bearer ll_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "companyId": "string",
  "profileName": "string"
}'

Response · 200 OK

Returns a JSON object on success.

GET /company/idealcustomer/{idealcustomer_id}

Get Ideal Customer

Get a specific ideal customer by ID

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`idealcustomer_id`	string	Yes	—

Example request

curl -X GET "https://api.lunalift.ai/company/idealcustomer/IDEALCUSTOMER_ID" \
  -H "Authorization: Bearer ll_your_api_key"

Response · 200 OK

Returns a JSON object on success.

DELETE /company/idealcustomer/{idealcustomer_id}

Delete Ideal Customer

Delete an ideal customer with prompt management options

🔒 Requires Authorization: Bearer ll_… (or X-API-Key).

Path parameters

Name	Type	Required	Description
`idealcustomer_id`	string	Yes	—

Query parameters

Name	Type	Required	Default	Description
`deactivate_prompts`	boolean	No	true	—
`delete_prompts`	boolean	No	false	—
`remove_references`	boolean	No	true	—

Example request

curl -X DELETE "https://api.lunalift.ai/company/idealcustomer/IDEALCUSTOMER_ID" \
  -H "Authorization: Bearer ll_your_api_key"

Response · 200 OK

Returns a JSON object on success.