API 1 - Collab Agent

• Authentication
  • postEmail / password sign-in
  • postCreate account
  • postInvalidate session
• Users
  • putLock / unlock user
  • putUpdate overall user status
  • getGet user by ID
• Classes & Sections
  • getGet per-class user status
  • getGet section IDs for user
  • putCreate / update section
  • getList classes for user
• Jira Integration
  • postSave Jira integration (admin)
  • getGet Jira config
  • delRemove Jira config
• AI Features
  • getTeam activity timeline
  • postInsert Live Share event
  • postUpload Live Share git diff / summary
  • postGenerate AI task delegation suggestions
• User Profile
  • getFetch profile
  • postCreate / update profile

API docs by Redocly

Collab Agent Backend API (1.0.0)

Download OpenAPI specification:Download

Official REST API used by the Collab Agent VS Code extension. It covers authentication, users, Jira integration, AI features, Live Share telemetry, and profile management.

Authentication

Email / password sign-in

Sign-in using email credentials.

Authorizations:

bearerAuth

query Parameters

provider required

string Value: "email"

Request Body schema: application/json

email required	string <email>
password required	string <password>

Responses

Production

https://project-collabagent01.onrender.com/auth/login

Local

http://127.0.0.1:5000/auth/login

Request samples

• Payload

Content type

application/json

{

• "email": "user@example.com",
• "password": "pa$$word"

}

Response samples

• 200
• 401

Content type

application/json

{

• "token": "string"

}

Create account

Authorizations:

bearerAuth

Request Body schema: application/json

email required	string <email>
password required	string <password>
first_name required	string
last_name required	string

Responses

Production

https://project-collabagent01.onrender.com/auth/signup

Local

http://127.0.0.1:5000/auth/signup

Request samples

• Payload

Content type

application/json

{

• "email": "user@example.com",
• "password": "pa$$word",
• "first_name": "string",
• "last_name": "string"

}

Response samples

• 201
• 400

Content type

application/json

{

• "token": "string"

}

Invalidate session

Authorizations:

bearerAuth

Request Body schema: application/json

user_id required

string

Responses

Production

https://project-collabagent01.onrender.com/auth/signout

Local

http://127.0.0.1:5000/auth/signout

Request samples

• Payload

Content type

application/json

{

• "user_id": "string"

}

Response samples

• 400

Content type

application/json

{

• "error": "string"

}

Users

Lock / unlock user

Authorizations:

bearerAuth

path Parameters

userId required

string

Request Body schema: application/json

user_id required	string
is_locked required	boolean

Responses

Production

https://project-collabagent01.onrender.com/users/{userId}/lock

Local

http://127.0.0.1:5000/users/{userId}/lock

Request samples

• Payload

Content type

application/json

{

• "user_id": "string",
• "is_locked": true

}

Response samples

• 400

Content type

application/json

{

• "error": "string"

}

Update overall user status

Authorizations:

bearerAuth

path Parameters

userId required

string

Request Body schema: application/json

status required	string (UserStatus) Enum: "ACTIVE" "SUSPENDED" "LOCKED"
userClassId	string or null

Responses

Production

https://project-collabagent01.onrender.com/users/{userId}/status

Local

http://127.0.0.1:5000/users/{userId}/status

Request samples

• Payload

Content type

application/json

{

• "status": "ACTIVE",
• "userClassId": "string"

}

Get user by ID

Authorizations:

bearerAuth

path Parameters

userId required

string

Responses

Production

https://project-collabagent01.onrender.com/users/{userId}

Local

http://127.0.0.1:5000/users/{userId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": "string",
• "email": "user@example.com",
• "first_name": "string",
• "last_name": "string",
• "created_at": "2019-08-24T14:15:22Z",
• "userStatus": "ACTIVE",
• "role": "string",
• "settings": {

  • "bug_percentage": 0,
  • "show_notifications": true,
  • "give_suggestions": true,
  • "enable_quiz": true,
  • "active_threshold": 0,
  • "suspend_threshold": 0,
  • "pass_rate": 0,
  • "suspend_rate": 0

  }

}

Classes & Sections

Get per-class user status

Authorizations:

bearerAuth

path Parameters

userId required

string

query Parameters

class_id

string

Responses

Production

https://project-collabagent01.onrender.com/users/{userId}/class-status

Local

http://127.0.0.1:5000/users/{userId}/class-status

Response samples

• 200
• 404

Content type

application/json

{

• "data": "ACTIVE"

}

Get section IDs for user

Authorizations:

bearerAuth

path Parameters

userId required

string

query Parameters

class_id

string

Responses

Production

https://project-collabagent01.onrender.com/users/{userId}/sections

Local

http://127.0.0.1:5000/users/{userId}/sections

Response samples

• 200

Content type

application/json

{

• "user_section_id": "string"

}

Create / update section

Authorizations:

bearerAuth

path Parameters

userId required

string

Request Body schema: application/json

status required	string (UserSectionStatus) Enum: "ACTIVE" "NEED_REVIEW" "COMPLETE"
userSectionId	string or null

Responses

Production

https://project-collabagent01.onrender.com/users/{userId}/sections

Local

http://127.0.0.1:5000/users/{userId}/sections

Request samples

• Payload

Content type

application/json

{

• "status": "ACTIVE",
• "userSectionId": "string"

}

List classes for user

Authorizations:

bearerAuth

path Parameters

userId required

string

Responses

Production

https://project-collabagent01.onrender.com/users/{userId}/classes

Local

http://127.0.0.1:5000/users/{userId}/classes

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "classTitle": "string",
  • "classCode": "string",
  • "instructorId": "string",
  • "createdAt": "2019-08-24T14:15:22Z"

  }

]

Jira Integration

Save Jira integration (admin)

Authorizations:

bearerAuth

Request Body schema: application/json

team_id required	string
jira_url required	string <uri>
jira_project_key required	string
access_token required	string
refresh_token	string or null
admin_user_id required	string
created_at	string <date-time>
updated_at	string <date-time>

Responses

Production

https://project-collabagent01.onrender.com/api/jira/config

Local

http://127.0.0.1:5000/api/jira/config

Request samples

• Payload

Content type

application/json

{

• "team_id": "string",
• "jira_url": "http://example.com",
• "jira_project_key": "string",
• "access_token": "string",
• "refresh_token": "string",
• "admin_user_id": "string",
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z"

}

Response samples

• 400

Content type

application/json

{

• "error": "string"

}

Get Jira config

Authorizations:

bearerAuth

path Parameters

teamId required

string

Responses

Production

https://project-collabagent01.onrender.com/api/jira/config/{teamId}

Local

http://127.0.0.1:5000/api/jira/config/{teamId}

Response samples

• 200
• 404

Content type

application/json

{

• "team_id": "string",
• "jira_url": "http://example.com",
• "jira_project_key": "string",
• "access_token": "string",
• "refresh_token": "string",
• "admin_user_id": "string",
• "created_at": "2019-08-24T14:15:22Z",
• "updated_at": "2019-08-24T14:15:22Z"

}

Remove Jira config

Authorizations:

bearerAuth

path Parameters

teamId required

string

Responses

Production

https://project-collabagent01.onrender.com/api/jira/config/{teamId}

Local

http://127.0.0.1:5000/api/jira/config/{teamId}

AI Features

Team activity timeline

Authorizations:

bearerAuth

query Parameters

team_id required	string
limit	integer >= 1 Default: 25

Responses

Production

https://project-collabagent01.onrender.com/api/ai/feed

Local

http://127.0.0.1:5000/api/ai/feed

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "team_id": "string",
  • "user_id": "string",
  • "summary": "string",
  • "activity_type": "string",
  • "file_path": "string",
  • "source_snapshot_id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "display_name": "string",
  • "user_email": "user@example.com"

  }

]

Insert Live Share event

Authorizations:

bearerAuth

Request Body schema: application/json

event_type required	string Enum: "started" "joined" "ended"
session_id	string
team_id required	string
user_id required	string
display_name required	string
duration_minutes	integer or null
snapshot_id	string or null

Responses

Production

https://project-collabagent01.onrender.com/api/ai/live_share_event

Local

http://127.0.0.1:5000/api/ai/live_share_event

Request samples

• Payload

Content type

application/json

{

• "event_type": "started",
• "session_id": "string",
• "team_id": "string",
• "user_id": "string",
• "display_name": "string",
• "duration_minutes": 0,
• "snapshot_id": "string"

}

Upload Live Share git diff / summary

Authorizations:

bearerAuth

Request Body schema: application/json

team_id required	string
user_id required	string
display_name required	string
session_id required	string
changes required	string

Responses

Production

https://project-collabagent01.onrender.com/api/ai/live_share_summary

Local

http://127.0.0.1:5000/api/ai/live_share_summary

Request samples

• Payload

Content type

application/json

{

• "team_id": "string",
• "user_id": "string",
• "display_name": "string",
• "session_id": "string",
• "changes": "string"

}

Response samples

• 200

Content type

application/json

{

• "snapshot_id": "string"

}

Generate AI task delegation suggestions

Authorizations:

bearerAuth

Request Body schema: application/json

team_id required	string
user_id required	string
required	Array of objects

Responses

Production

https://project-collabagent01.onrender.com/api/ai/task_recommendations

Local

http://127.0.0.1:5000/api/ai/task_recommendations

Request samples

• Payload

Content type

application/json

{

• "team_id": "string",
• "user_id": "string",
• "unassigned_tasks": [

  • {

    • "key": "string",
    • "summary": "string",
    • "description": "string"

    }

  ]

}

Response samples

• 200

Content type

application/json

{

• "recommendations_count": 0

}

User Profile

Fetch profile

Authorizations:

bearerAuth

query Parameters

user_id required

string

Responses

Production

https://project-collabagent01.onrender.com/api/profile

Local

http://127.0.0.1:5000/api/profile

Response samples

• 200
• 404

Content type

application/json

{

• "user_id": "string",
• "name": "string",
• "interests": [

  • "string"

  ],
• "strengths": [

  • "string"

  ],
• "weaknesses": [

  • "string"

  ],
• "custom_skills": [

  • "string"

  ]

}

Create / update profile

Authorizations:

bearerAuth

Request Body schema: application/json

user_id required	string
name	string
interests	Array of strings
strengths	Array of strings
weaknesses	Array of strings
custom_skills	Array of strings

Responses

Production

https://project-collabagent01.onrender.com/api/profile

Local

http://127.0.0.1:5000/api/profile

Request samples

• Payload

Content type

application/json

{

• "user_id": "string",
• "name": "string",
• "interests": [

  • "string"

  ],
• "strengths": [

  • "string"

  ],
• "weaknesses": [

  • "string"

  ],
• "custom_skills": [

  • "string"

  ]

}