SeeMe.ai API Reference
Projects

Projects

GET /api/v1/projects

Get Projects

getProjects returns all projects the user has access to

Response

Type: []Project

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
organization_idstringDenormalized for query perf
team_idstringOptional: belongs to team
owner_idstringUser who created it
slugstringUnique within org
settingsdatatypes.JSONDefault configs, preferences
has_logobool
logostring
visibilitystring“private”, “team”, “org”, “public”
member_countint64Computed (not stored in DB)
user_rolestringCurrent user’s project role (computed) (optional)
organizationOrganizationRelationships (optional)
teamTeam(optional)
members[]ProjectMember(optional)

Example 

curl -X GET \
  -H "Authorization: Bearer <token>" \
  https://api.seeme.ai/api/v1/projects

POST /api/v1/projects

Create Project

postProject creates a new project

Request Body

Type: CreateProjectRequest

FieldTypeDescription
namestring
descriptionstring
team_idstring
organization_idstring
visibilitystring

Response

Type: Project

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
organization_idstringDenormalized for query perf
team_idstringOptional: belongs to team
owner_idstringUser who created it
slugstringUnique within org
settingsdatatypes.JSONDefault configs, preferences
has_logobool
logostring
visibilitystring“private”, “team”, “org”, “public”
member_countint64Computed (not stored in DB)
user_rolestringCurrent user’s project role (computed) (optional)
organizationOrganizationRelationships (optional)
teamTeam(optional)
members[]ProjectMember(optional)

Example 

curl -X POST \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}' \
  https://api.seeme.ai/api/v1/projects

GET /api/v1/projects/{id}

Get Project

getProject returns a specific project

Parameters

NameInTypeRequired
idpathstringtrue

Response

Type: Project

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
organization_idstringDenormalized for query perf
team_idstringOptional: belongs to team
owner_idstringUser who created it
slugstringUnique within org
settingsdatatypes.JSONDefault configs, preferences
has_logobool
logostring
visibilitystring“private”, “team”, “org”, “public”
member_countint64Computed (not stored in DB)
user_rolestringCurrent user’s project role (computed) (optional)
organizationOrganizationRelationships (optional)
teamTeam(optional)
members[]ProjectMember(optional)

Example 

curl -X GET \
  -H "Authorization: Bearer <token>" \
  https://api.seeme.ai/api/v1/projects/{id}

PUT /api/v1/projects/{id}

Update Project

putProject updates a project

Parameters

NameInTypeRequired
idpathstringtrue

Request Body

Type: Project

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
organization_idstringDenormalized for query perf
team_idstringOptional: belongs to team
owner_idstringUser who created it
slugstringUnique within org
settingsdatatypes.JSONDefault configs, preferences
has_logobool
logostring
visibilitystring“private”, “team”, “org”, “public”
member_countint64Computed (not stored in DB)
user_rolestringCurrent user’s project role (computed) (optional)
organizationOrganizationRelationships (optional)
teamTeam(optional)
members[]ProjectMember(optional)

Response

Type: Project

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
organization_idstringDenormalized for query perf
team_idstringOptional: belongs to team
owner_idstringUser who created it
slugstringUnique within org
settingsdatatypes.JSONDefault configs, preferences
has_logobool
logostring
visibilitystring“private”, “team”, “org”, “public”
member_countint64Computed (not stored in DB)
user_rolestringCurrent user’s project role (computed) (optional)
organizationOrganizationRelationships (optional)
teamTeam(optional)
members[]ProjectMember(optional)

Example 

curl -X PUT \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{}' \
  https://api.seeme.ai/api/v1/projects/{id}

DELETE /api/v1/projects/{id}

Delete Project

deleteProject deletes a project

Parameters

NameInTypeRequired
idpathstringtrue

Example 

curl -X DELETE \
  -H "Authorization: Bearer <token>" \
  https://api.seeme.ai/api/v1/projects/{id}

GET /api/v1/projects/{id}/logo

Get Project Logo

getProjectLogo serves the logo for a project Logos are publicly accessible (no auth required) to allow browser tags to load them

Parameters

NameInTypeRequired
idpathstringtrue

Example 

curl -X GET \
  -H "Authorization: Bearer <token>" \
  https://api.seeme.ai/api/v1/projects/{id}/logo

POST /api/v1/projects/{id}/logo

Create Project Logo

uploadProjectLogo uploads a logo for a project

Parameters

NameInTypeRequired
idpathstringtrue

Response

Type: Project

FieldTypeDescription
iduuid.UUID
created_attime.Time
updated_attime.Time
namestring
descriptionstring
organization_idstringDenormalized for query perf
team_idstringOptional: belongs to team
owner_idstringUser who created it
slugstringUnique within org
settingsdatatypes.JSONDefault configs, preferences
has_logobool
logostring
visibilitystring“private”, “team”, “org”, “public”
member_countint64Computed (not stored in DB)
user_rolestringCurrent user’s project role (computed) (optional)
organizationOrganizationRelationships (optional)
teamTeam(optional)
members[]ProjectMember(optional)

Example 

curl -X POST \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  https://api.seeme.ai/api/v1/projects/{id}/logo

DELETE /api/v1/projects/{id}/logo

Delete Project Logo

deleteProjectLogo deletes the logo for a project

Parameters

NameInTypeRequired
idpathstringtrue

Example 

curl -X DELETE \
  -H "Authorization: Bearer <token>" \
  https://api.seeme.ai/api/v1/projects/{id}/logo