/
/OpenLens API
DocsSign in
Sign in
  • APIs
  • Generators
  • Stacks
  • Projects
  • Docs
  • History
  • Schema
Checked 17h ago · Updated 2w ago
Account4
Citations2
Deliverables2
Metrics4
Onboarding1
Resources23
  • getList your projects
  • postCreate a new project
  • putUpdate a project
  • deleteArchive a project (soft delete)
  • getGet the project's active platforms and the caller's entitlement
  • putSet the project's active platforms
  • getGet the project's scan schedule
  • patchUpdate the project's scan schedule
  • getList allowed prompt-attribute values for the project
  • postAdd a custom prompt-attribute value
  • deleteArchive a custom prompt-attribute by value
  • patchRename or archive an existing custom prompt-attribute
  • getList brands in a project (your own + competitors)
  • postAdd a brand (competitor or own)
  • deleteDelete a brand
  • patchUpdate a brand's aliases
  • getList topics in a project
  • postCreate a topic; prompts are generated in the background
  • deleteDelete a topic and its prompts
  • getList prompts, optionally filtered by topic or fetched by id
  • putUpdate prompt text, attributes, or active flag
  • postCreate a prompt under a topic
  • deleteSoft-delete a prompt
Runs5
    Resources

    List brands in a project (your own + competitors)

    get/brands

    Query parameters

    projectIdstring uuid required

    Project id. Required on all data endpoints.

    Response

    Successful response

    idstring uuid required
    userIdstring uuid
    projectIdstring uuid nullable
    namestring required
    descriptionstring nullable
    urlstring nullable
    isOwnboolean required
    aliasesstring[]
    createdAtstring date-time

    Changes