Skip to main content
PATCH
/
api
/
projects
Update a project
curl --request PATCH \
  --url https://api.mentionlab.io/api/projects \
  --header 'Content-Type: application/json' \
  --header 'x-organisation-id: <x-organisation-id>' \
  --header 'x-project-id: <x-project-id>' \
  --data '
{
  "name": "My Project",
  "description": "My Project Description",
  "website": "https://www.mentionlab.io",
  "industry": "Cosmetics",
  "nameAliases": [
    "My Project",
    "My Project 2"
  ],
  "blackListAliases": [
    "My Project",
    "My Project 2"
  ],
  "recurrence": "daily",
  "recurrenceStatus": "active",
  "llmProviders": [
    "openai",
    "anthropic"
  ],
  "executionCount": 3
}
'

Headers

​
x-organisation-id
string
required

Organisation ID to specify the organisation context

​
x-project-id
string
required

Project ID to specify the project context

Body

application/json
​
name
string

The name of the project

Example:

"My Project"

​
description
string

The description of the project

Example:

"My Project Description"

​
website
string

The website of the project

Example:

"https://www.mentionlab.io"

​
industry
string

The industry of the project

Example:

"Cosmetics"

​
nameAliases
string[]

The aliases of the project name

Example:
["My Project", "My Project 2"]
​
blackListAliases
string[]

The blacklisted aliases of the project name

Example:
["My Project", "My Project 2"]
​
recurrence
enum<string>
default:manual

The recurrence of the project

Available options:
manual,
daily,
weekly,
biweekly,
monthly
Example:

"daily"

​
recurrenceStatus
enum<string>
default:active

The recurrence status of the project

Available options:
active,
paused
Example:

"active"

​
llmProviders
enum<string>[]

The LLM providers of the project

Available options:
openai,
openai5,
anthropic,
google-generative-ai,
perplexity,
xai,
ai-overview,
ai-mode,
ai-overview2
Example:
["openai", "anthropic"]
​
executionCount
number
default:3

The execution count of the project

Example:

3

Response

204 - undefined