Galileo Technologies projects API
The projects API from Galileo Technologies — 27 operation(s) for projects.
The projects API from Galileo Technologies — 27 operation(s) for projects.
openapi: 3.1.0
info:
title: Galileo API Server annotation projects API
version: 1.1085.0
servers:
- url: https://api.galileo.ai
description: Galileo API Server - galileo-v2
tags:
- name: projects
paths:
/projects/{project_id}/bookmark:
put:
tags:
- projects
summary: Bookmark Project
operationId: bookmark_project_projects__project_id__bookmark_put
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- projects
summary: Unbookmark Project
operationId: unbookmark_project_projects__project_id__bookmark_delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/projects/paginated:
post:
tags:
- projects
summary: Get Projects Paginated
description: 'Gets projects for a user with pagination.
If provided, filters on project_name and project_type.'
operationId: get_projects_paginated_projects_paginated_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: actions
in: query
required: false
schema:
type: array
items:
$ref: '#/components/schemas/ProjectAction'
description: Actions to include in the 'permissions' field.
title: Actions
description: Actions to include in the 'permissions' field.
- name: starting_token
in: query
required: false
schema:
type: integer
default: 0
title: Starting Token
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/api__schemas__project__ProjectCollectionParams'
default:
filters: []
sort:
name: created_at
ascending: false
sort_type: column
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/api__schemas__project__GetProjectsPaginatedResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/projects/count:
post:
tags:
- projects
summary: Get Projects Count
description: Gets total count of projects for a user with applied filters.
operationId: get_projects_count_projects_count_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/api__schemas__project__ProjectCollectionParams'
default:
filters: []
sort:
name: created_at
ascending: false
sort_type: column
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: integer
title: Response Get Projects Count Projects Count Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
/projects/all:
get:
tags:
- projects
summary: Get All Projects
description: 'Gets all public projects and all private projects that the user has access to.
For Enterprise SaaS Clusters, this will return all projects in the cluster.
DEPRECATED in favor of `get_projects_paginated`.'
operationId: get_all_projects_projects_all_get
deprecated: true
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: type
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/ProjectType'
- type: 'null'
title: Type
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ProjectDBThin'
title: Response Get All Projects Projects All Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/projects:
get:
tags:
- projects
summary: Get Projects
description: 'Gets projects for a user.
If provided, filters on project_name and project_type.
DEPRECATED in favor of `get_projects_paginated`.'
operationId: get_projects_projects_get
deprecated: true
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_name
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Project Name
- name: type
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/ProjectType'
- type: 'null'
title: Type
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ProjectDB'
title: Response Get Projects Projects Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- projects
summary: Create Project
description: Create a new project.
operationId: create_project_projects_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectCreate'
examples:
- name: my_first_project
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectCreateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/collaborator_roles:
get:
tags:
- projects
summary: Get Collaborator Roles
operationId: get_collaborator_roles_collaborator_roles_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CollaboratorRoleInfo'
type: array
title: Response Get Collaborator Roles Collaborator Roles Get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
/projects/{project_id}:
get:
tags:
- projects
summary: Get Project
operationId: get_project_projects__project_id__get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectDB'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- projects
summary: Update Project
operationId: update_project_projects__project_id__put
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectUpdate'
examples:
- name: my_updated_project
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectUpdateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- projects
summary: Delete Project
description: 'Deletes a project and all associated runs and objects.
Any user with project access can delete a project.
Note that `get_project_by_id` calls `user_can_access_project`.'
operationId: delete_project_projects__project_id__delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectDeleteResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/projects/{project_id}/users:
post:
tags:
- projects
summary: Create User Project Collaborators
description: Share a project with users.
operationId: create_user_project_collaborators_projects__project_id__users_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UserCollaboratorCreate'
title: Body
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UserCollaborator'
title: Response Create User Project Collaborators Projects Project Id Users Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- projects
summary: List User Project Collaborators
description: List the users with which the project has been shared.
operationId: list_user_project_collaborators_projects__project_id__users_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: starting_token
in: query
required: false
schema:
type: integer
default: 0
title: Starting Token
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListUserCollaboratorsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/projects/{project_id}/groups:
post:
tags:
- projects
summary: Create Group Project Collaborators
description: Share a project with groups.
operationId: create_group_project_collaborators_projects__project_id__groups_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GroupCollaboratorCreate'
title: Body
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GroupCollaborator'
title: Response Create Group Project Collaborators Projects Project Id Groups Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- projects
summary: List Group Project Collaborators
description: List the groups with which the project has been shared.
operationId: list_group_project_collaborators_projects__project_id__groups_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: starting_token
in: query
required: false
schema:
type: integer
default: 0
title: Starting Token
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListGroupCollaboratorsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/projects/{project_id}/users/{user_id}:
patch:
tags:
- projects
summary: Update User Project Collaborator
description: Update the sharing permissions of a user on a project.
operationId: update_user_project_collaborator_projects__project_id__users__user_id__patch
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: user_id
in: path
required: true
schema:
type: string
format: uuid4
title: User Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CollaboratorUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UserCollaborator'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- projects
summary: Delete User Project Collaborator
description: Remove a user's access to a project.
operationId: delete_user_project_collaborator_projects__project_id__users__user_id__delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: user_id
in: path
required: true
schema:
type: string
format: uuid4
title: User Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/projects/{project_id}/groups/{group_id}:
patch:
tags:
- projects
summary: Update Group Project Collaborator
description: Update the sharing permissions of a group on a project.
operationId: update_group_project_collaborator_projects__project_id__groups__group_id__patch
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: group_id
in: path
required: true
schema:
type: string
format: uuid4
title: Group Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CollaboratorUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GroupCollaborator'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- projects
summary: Delete Group Project Collaborator
description: Remove a group's access to a project.
operationId: delete_group_project_collaborator_projects__project_id__groups__group_id__delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: group_id
in: path
required: true
schema:
type: string
format: uuid4
title: Group Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v2/collaborator_roles:
get:
tags:
- projects
summary: Get Collaborator Roles
operationId: get_collaborator_roles_v2_collaborator_roles_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CollaboratorRoleInfo'
type: array
title: Response Get Collaborator Roles V2 Collaborator Roles Get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
/v2/projects:
post:
tags:
- projects
summary: Create Project
description: Create a new project.
operationId: create_project_v2_projects_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectCreate'
examples:
- name: my_first_project
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectCreateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
/v2/projects/{project_id}:
get:
tags:
- projects
summary: Get Project
operationId: get_project_v2_projects__project_id__get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectDB'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
put:
tags:
- projects
summary: Update Project
operationId: update_project_v2_projects__project_id__put
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectUpdate'
examples:
- name: my_updated_project
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectUpdateResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- projects
summary: Delete Project
description: 'Deletes a project and all associated runs and objects.
Any user with project access can delete a project.
Note that `get_project_by_id` calls `user_can_access_project`.'
operationId: delete_project_v2_projects__project_id__delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectDeleteResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v2/projects/{project_id}/users:
post:
tags:
- projects
summary: Create User Project Collaborators
description: Share a project with users.
operationId: create_user_project_collaborators_v2_projects__project_id__users_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UserCollaboratorCreate'
title: Body
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UserCollaborator'
title: Response Create User Project Collaborators V2 Projects Project Id Users Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- projects
summary: List User Project Collaborators
description: List the users with which the project has been shared.
operationId: list_user_project_collaborators_v2_projects__project_id__users_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: starting_token
in: query
required: false
schema:
type: integer
default: 0
title: Starting Token
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListUserCollaboratorsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v2/projects/{project_id}/groups:
post:
tags:
- projects
summary: Create Group Project Collaborators
description: Share a project with groups.
operationId: create_group_project_collaborators_v2_projects__project_id__groups_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GroupCollaboratorCreate'
title: Body
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GroupCollaborator'
title: Response Create Group Project Collaborators V2 Projects Project Id Groups Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- projects
summary: List Group Project Collaborators
description: List the groups with which the project has been shared.
operationId: list_group_project_collaborators_v2_projects__project_id__groups_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: starting_token
in: query
required: false
schema:
type: integer
default: 0
title: Starting Token
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListGroupCollaboratorsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v2/projects/{project_id}/users/{user_id}:
patch:
tags:
- projects
summary: Update User Project Collaborator
description: Update the sharing permissions of a user on a project.
operationId: update_user_project_collaborator_v2_projects__project_id__users__user_id__patch
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: user_id
in: path
required: true
schema:
type: string
format: uuid4
title: User Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CollaboratorUpdate'
responses:
'200':
description: Successful Respon
# --- truncated at 32 KB (101 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/galileo-technologies/refs/heads/main/openapi/galileo-technologies-projects-api-openapi.yml