Define a project keyword
Sociovite's published API does not expose a separate keyword-creation endpoint. A keyword is supplied as the keyword string when you call POST /api/project.
Contract rules
Swagger defines only these constraints:
| Rule | Value |
|---|---|
| Type | string |
| Required | Yes |
| Minimum length | 2 characters |
| Maximum length | 255 characters |
Minimal example:
{
"keyword": "acme"
}
The value above is one field in the complete create-project request, not a standalone payload.
Group, keyword, and exclude
These fields have different roles in the project request:
| Field | Meaning in the contract | Constraint |
|---|---|---|
group | Project/group name | 2–100 characters |
keyword | Monitoring keyword string | 2–255 characters |
exclude | Optional exclusion string | Up to 1,000 characters |
Example:
{
"group": "Acme July Monitoring",
"keyword": "acme",
"exclude": "acme university"
}
Query syntax is not defined
The Swagger contract does not specify whether the backend supports:
- Boolean operators such as
ANDorOR; - quoted phrases;
- multiple keywords in one string;
- case-insensitive matching;
- escaping or special characters.
Treat keyword as an opaque string unless the backend team publishes a query grammar. Do not construct complex expressions based only on examples from older documentation.
Validate the result
After project creation:
- Confirm the response echoes the expected
data.keyword. - Start scraping with
POST /api/ai-service/scrap-project-keywords. - Query
GET /api/mentionswith the appropriate keyword ID. - Adjust the keyword only through a documented backend workflow; the supplied Swagger does not define a general project-update or keyword-update endpoint.
Continue with Collect and read mentions.