Skip to main content
POST
/
onboard
Analyze a brand or confirm a new project
curl --request POST \
  --url https://openlens.com/api/onboard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>"
}
'
"<string>"

Documentation Index

Fetch the complete documentation index at: https://docs.openlens.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Clerk API key. Create one from your account settings under API Keys.

Body

application/json
​
action
enum<string>
required
Available options:
analyze
​
url
string<uri>
required

Response

Server-Sent Events stream. The final event has status: "complete" with the result payload (analyze: brand/competitor/topic suggestions; confirm: { projectId }).

The response is of type string.