Projects API
Manage RankVectors projects
Create Project
Create a new project:
POST /api/projects
Request Body:
{
"name": "My Website",
"domain": "https://example.com",
"preferredSdk": "javascript"
}
Response:
{
"data": {
"id": "proj_123",
"name": "My Website",
"domain": "https://example.com",
"createdAt": "2024-01-01T00:00:00Z"
}
}
List Projects
List all your projects:
GET /api/projects
Response:
{
"data": [
{
"id": "proj_123",
"name": "My Website",
"domain": "https://example.com"
}
]
}
Get Project
Get a specific project:
GET /api/projects/{projectId}
Response:
{
"data": {
"id": "proj_123",
"name": "My Website",
"domain": "https://example.com",
"includePaths": ["/blog", "/docs"],
"createdAt": "2024-01-01T00:00:00Z"
}
}
Update Project
Update project settings:
PATCH /api/projects/{projectId}
Request Body:
{
"name": "Updated Name",
"includePaths": ["/blog", "/docs", "/products"]
}
Delete Project
Delete a project:
DELETE /api/projects/{projectId}
Response:
{
"data": {
"success": true
}
}