Skip to main content
GET
/
api
/
projects
/
{id}
Get a project
curl --request GET \
  --url https://api.mentionlab.io/api/projects/{id} \
  --header 'x-organisation-id: <x-organisation-id>' \
  --header 'x-project-id: <x-project-id>'
{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "name": "My Project",
  "recurrence": "daily",
  "recurrenceStatus": "active",
  "llmProviders": [
    "openai",
    "anthropic"
  ],
  "executionCount": 3,
  "organisation": "01234567-89ab-cdef-0123-456789abcdef",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "slug": "my-project",
  "description": "My Project Description",
  "industry": "Technology",
  "website": "https://www.mentionlab.io",
  "nameAliases": [
    "My Project",
    "My Project 2"
  ],
  "blackListAliases": [
    "My Project",
    "My Project 2"
  ]
}

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

Path Parameters

​
id
string
required

Response

200 - application/json
​
id
string
required

Unique identifier for the project

Example:

"01234567-89ab-cdef-0123-456789abcdef"

​
name
string
required

Name of the project

Example:

"My Project"

​
recurrence
enum<string>
required

Recurrence of the project

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

"daily"

​
recurrenceStatus
enum<string>
required

Recurrence status of the project

Available options:
active,
paused
Example:

"active"

​
llmProviders
enum<string>[]
required

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
required

Execution count of the project

Example:

3

​
organisation
object
required

Organisation that owns this project

Example:

"01234567-89ab-cdef-0123-456789abcdef"

​
updatedAt
string<date-time>
required

Created at

Example:

"2021-01-01T00:00:00.000Z"

​
slug
string

Slug of the project

Example:

"my-project"

​
description
string

Description of the project

Example:

"My Project Description"

​
industry
string

Industry of the project

Example:

"Technology"

​
website
string

Website of the project

Example:

"https://www.mentionlab.io"

​
nameAliases
string[]

Name aliases of the project

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

Blacklist aliases of the project

Example:
["My Project", "My Project 2"]