Catalog
falseSuccessful Response
Validation Error
No content
""^[A-Za-z0-9]+(?:[._-]{1}[A-Za-z0-9]+)*$Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""""^[A-Za-z0-9]+(?:[._-]{1}[A-Za-z0-9]+)*$""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""""^[A-Za-z0-9]+(?:[._-]{1}[A-Za-z0-9]+)*$""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""""falseSuccessful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""110""Successful Response
Validation Error
No content
Lists all custom roles defined for a project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Page number
1Items per page
10Successful Response
Validation Error
Creates a new custom role within a project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
Retrieves details for a specific role, optionally including its permissions.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Set to true to include the role's permissions from the authorization system.
falseSuccessful Response
Validation Error
Updates a role's title or its permissions.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
Deletes a custom role from a project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Retrieves a role by its unique key, optionally including its permissions.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Set to true to include the role's permissions from the authorization system.
falseSuccessful Response
Validation Error
Lists all members in a project, including their roles.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
Assigns a user to a specific role within a project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
Removes a user and all their role assignments from a project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Updates an existing member's role in the project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
List pending invitations for a catalog project.
Requires VIEW permission on the project's invitation resource.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Page number
1Items per page
20Successful Response
Validation Error
No content
Create an invitation for an external user to join a catalog project.
Requires CREATE permission on the project's invitation resource.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Request to create an invitation for an external user
Successful Response
Validation Error
No content
Revoke a pending invitation.
Requires DELETE permission on the project's invitation resource.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Resend a pending invitation with a new token and extended expiry.
Generates a new invitation token, extends expiration (if applicable), and sends a new invitation email to the user.
Requires UPDATE permission on the project's invitation resource.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
List all API keys in the project
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Page number
1Items per page
10Successful Response
Validation Error
Create a new API key for the project
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
Revoke an API key (soft delete)
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
List labeling projects with filtering and pagination.
Returns a paginated list of projects where the current user is a member.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Search by project name
Filter by status (draft, active, completed, archived, suspended)
Filter by schema type
Sort fields with direction (e.g., 'name:asc', 'created_at:desc')
Page number
1Items per page
20Successful Response
Validation Error
No content
Create a new labeling project.
Creates a project with the specified schema type and task definition. The project starts in DRAFT status and the creator is automatically added as a project manager.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""1{}Successful Response
Validation Error
No content
Get labeling project details.
Returns comprehensive project information including statistics about batches, tasks, and team members.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Update labeling project settings.
Updates project properties such as name, description, and status. Task definition and review rounds can only be updated in DRAFT status.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Project lifecycle states
Successful Response
Validation Error
No content
Delete a labeling project.
Projects can only be deleted if they are in DRAFT or ARCHIVED status. This operation permanently removes the project and all associated data.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
List batches for a project with pagination.
Returns a paginated list of batches with embedded progress statistics.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Search by name
Filter by status
Sort by field and direction
Page number
1Items per page
20Successful Response
Validation Error
No content
Create a new batch with automatic task generation.
Creates a batch from the specified dataset and automatically generates tasks from data points. The batch starts in IN_PROGRESS status once tasks are generated successfully.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""true{}Successful Response
Validation Error
No content
Get batch details with embedded progress statistics.
Returns comprehensive batch information including task progress, creation details, and current status.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Update batch name and meta_info.
Only name and meta_info can be updated. Other batch properties like target task count and dataset cannot be modified after creation.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Request model for updating batch properties
Batch processing states for labeling projects
Successful Response
Validation Error
No content
Get tasks in a batch with role-based access control.
Managers: Can see all tasks in the batch with full filtering
Labelers/Reviewers: Can only see tasks assigned to them in this batch
Returns paginated list of tasks with complete information including data points, annotations, and assignee details.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Filter by task status
Filter by assignee user IDs or 'unassigned'
Filter by reviewer user IDs or 'unassigned'
Filter by quality task status
Search by task content
Page number
1Items per page
20Sort by field and direction
Successful Response
Validation Error
No content
Bulk assign or unassign tasks (Manager role required).
task with user_id: assign task to user
task with user_id=null: unassign task
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
Claim tasks from any batch in the project (Labeler role). Supports presigned token authentication for external users.
""Request for claiming tasks
Number of tasks to claim (max 50)
Specific task IDs to claim
Successful Response
Validation Error
No content
Get tasks assigned to the current user in this project with pagination and filtering (Labeler role). Supports presigned token authentication for external users.
""Filter by task status
Search by task content
Page number
1Items per page
20Sort by field and direction
Successful Response
Validation Error
No content
Get current user's task statistics in this project.
""Successful Response
Validation Error
No content
Get all quality tasks in project for training selection (Manager only).
Returns paginated list of completed quality tasks that can be selected for training configuration.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Page number
1Items per page
20Filter by batch ID
Search by task content
Sort by field and direction
Successful Response
Validation Error
No content
Get task details by task ID (Labeler role - own tasks only). Supports presigned token authentication for external users.
""Successful Response
Validation Error
No content
Start working on a task (PENDING -> IN_PROGRESS) (Labeler role). Supports presigned token authentication for external users.
""Successful Response
Validation Error
No content
Submit annotation for a task (IN_PROGRESS -> SUBMITTED) (Labeler role). Supports presigned token authentication for external users.
""falseSuccessful Response
Validation Error
No content
Skip multiple tasks and return them to the unassigned pool (Labeler role). Supports presigned token authentication for external users.
Allows users to skip their assigned PENDING or IN_PROGRESS tasks. The tasks will be reset to original state and returned to the pool.
""Request for skipping tasks
Successful Response
Validation Error
No content
Timeout an IN_PROGRESS task and reset it to PENDING. Supports presigned token authentication for external users.
Called by frontend when timeout countdown expires. The task will be returned to the pool for other users to claim.
""Successful Response
Validation Error
No content
Get complete review history for a task.
Returns all review records ordered by review round, including reviewer info, actions, and feedback.
""Successful Response
Validation Error
No content
Predict custom field value using LLM.
Generates suggested custom value(s) for a list field based on the task's data. Requires labeler, reviewer, or manager role.
""Request to predict custom field value using LLM
Successful Response
Validation Error
No content
Mark or unmark a task as a quality task (Manager only).
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Request to mark or unmark a task as quality task
Successful Response
Validation Error
No content
Start reviewing a task (PENDING -> IN_PROGRESS) (Reviewer role). Supports presigned token authentication for external users.
""Successful Response
Validation Error
No content
Submit review decision for a specific review. Supports presigned token authentication for external users.
Actions:
accept: Approve annotation, advance to next review round or complete
reject: Send back to labeler for fixes (keeps assigned_to)
fix: Reviewer corrects annotation directly and advances
For fix action, annotation field is required.
""Request model for submitting a review decision
Review decision types
falseSuccessful Response
Validation Error
No content
Claim reviews from the project for the current user. Supports presigned token authentication for external users.
Supports queue continuation - returns existing claimed reviews plus newly claimed ones up to the requested amount.
""Request for claiming reviews
Number of reviews to claim (max 50)
Specific task IDs to claim reviews for
Successful Response
Validation Error
No content
Skip multiple claimed reviews and return them to the review pool. Supports presigned token authentication for external users.
The reviews will be reset to unclaimed state for other reviewers.
""Request for skipping reviews
Successful Response
Validation Error
No content
Timeout an IN_PROGRESS review and reset it to PENDING. Supports presigned token authentication for external users.
Called by frontend when timeout countdown expires. The review will be returned to the pool for other reviewers to claim.
""Successful Response
Validation Error
No content
Get reviews assigned to the current user in this project with pagination and filtering (Reviewer role).
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Filter by review status
Filter by review action
Search by review ID
Page number
1Items per page
20Sort by field and direction
Successful Response
Validation Error
No content
Get current user's review statistics in this project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
List all members in a project.
Requires 'member:view' permission in the project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Search by member name/email
Filter by member roles
Sort fields with direction (e.g., 'created_at:desc', 'name:asc')
Include soft-deleted members
falsePage number
1Items per page
20Successful Response
Validation Error
No content
Add a member to a project.
Requires 'member:add' permission in the project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Request to add a member to a project
Team member roles in projects
Successful Response
Validation Error
No content
Update a member in a project.
Requires 'member:update_role' permission in the project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Request to update a member
Team member roles in projects
Successful Response
Validation Error
No content
Remove a member from a project (soft delete).
Requires 'member:remove' permission in the project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Get current user's membership details in the project.
Returns the authenticated user's membership record if they are an active member.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
List pending invitations for a project.
Requires 'member:view' permission in the project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Page number
1Items per page
20Successful Response
Validation Error
No content
Create an invitation for an external user.
Requires 'member:create' permission in the project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Request to create an invitation for an external user
Email address to invite
Role to assign
Successful Response
Validation Error
No content
Revoke (delete) a pending invitation.
Requires 'member:remove' permission in the project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Resend a pending invitation with a new token and extended expiry.
Generates a new invitation token, extends expiration (if applicable), and sends a new invitation email to the user.
Requires 'member:create' permission in the project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Start a new training attempt and get quality tasks.
""Successful Response
Validation Error
No content
Check if user has completed training for this project.
""Successful Response
Validation Error
No content
Submit a single training task response.
""Request to submit a single training task response
Successful Response
Validation Error
No content
List training attempts for a project (manager view).
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Filter by user IDs
Filter by status
Filter by archived status
Sort by field and direction
Page number
1Items per page
20Successful Response
Validation Error
No content
Get full training attempt details including responses.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Reset a user's training attempts (manager action).
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Request to reset a user's training attempts
Successful Response
Validation Error
No content
Retry evaluation for an attempt that is in ERROR status.
Only the attempt owner or project manager can retry.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Get training configuration with full task data (Manager only).
Returns training config including expanded quality task data for the selected tasks.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
List training jobs with filtering and pagination.
Returns paginated list of training jobs. Users can filter by project, creator, or status. Requires view permission on projects.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Filter by project ID
Filter by creator user ID
Filter by status (comma-separated)
Page number
1Items per page
20Sort by field:direction
Successful Response
Validation Error
Register a new training job and trigger the training pipeline.
Creates a training job record and triggers Temporal workflow to:
Export annotated tasks to JSONL
Submit to external training service
Poll for completion
Create model card
Requires manager permissions on all specified projects.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Request DTO for registering a new training job
Successful Response
Validation Error
Get details of a specific training job.
Returns full training job information including status, hyperparameters, and metadata. Requires view permission on at least one associated project.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
List trained model cards with filtering and pagination.
Returns paginated list of model cards (trained models). Can filter by project, training job, or status. Requires view permission on projects.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Filter by project ID
Filter by training job ID
Filter by status
Page number
1Items per page
20Successful Response
Validation Error
Update model card status (active, deprecated, archived).
Allows managers to manage model lifecycle. Only managers of associated projects can update model card status.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Request DTO for updating model card status
Model card lifecycle states
Successful Response
Validation Error
No content
Accept an invitation using the token from email.
This is a PUBLIC endpoint - no authentication required. Creates/updates user, workspace membership, and project membership.
Successful Response
Validation Error
No content
List annotation datasets for a project
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Search by name
Project ID (required)
Filter by status
Filter by schema type
Filter by creator
Page number
1Items per page
20Successful Response
Validation Error
No content
Create a new annotation dataset and trigger processing
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""{}Successful Response
Validation Error
No content
Get annotation dataset details with progress information
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Update annotation dataset (name only)
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Delete annotation dataset (soft delete)
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Trigger processing for a failed or cancelled annotation dataset
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Cancel an ongoing annotation dataset processing and clean up partial data
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Trigger processing for a failed data source
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Generate preview dataset
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Request model for annotation dataset preview
asset_documentPossible values: {}Successful Response
Validation Error
No content
List data points for a dataset
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Filter by asset ID
Page number
1Items per page
20Successful Response
Validation Error
No content
Get single data point details
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Export annotated tasks to HuggingFace training data format.
Synchronously exports annotation tasks from specified projects to S3 in JSONL format. Timeout: 2 minutes for large datasets.
Args: request: Export request with project_ids and optional output_path user_data: Authenticated user from middleware
Returns: ExportTrainingDataResponse with S3 URL and export statistics
Raises: 400: Invalid project IDs or no tasks found 403: User doesn't have access to projects 500: Export failed 504: Export timeout (>2 minutes)
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Request model for exporting training data.
Successful Response
Validation Error
Verify if a user exists in Catalog and has catalog access. Returns minimal public profile if user is eligible.
Requirements:
User must exist
User must be ACTIVE member of at least one workspace
User must be owner, admin, OR have catalog in app_permissions
Only accessible by aggregator service (server key required). SK authentication is enforced at router level.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
List labeling projects for a specific member (aggregator only).
This endpoint allows the aggregator to query projects where a specific user is a member, optionally filtering by their role in those projects.
SK authentication is enforced at router level.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Filter by member user ID
Filter by member role(s) (manager, labeler, reviewer, external_manager)
["manager"]Search by project name
Filter by status (draft, active, completed, archived, suspended)
Filter by schema type
Sort fields with direction (e.g., 'name:asc', 'created_at:desc')
Page number
1Items per page
20Successful Response
Validation Error
No content
Get labeling project details by ID for internal aggregator validation.
SK authentication is enforced at router level.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Register the aggregator system user as EXTERNAL_MANAGER for a project.
This endpoint adds [email protected] to the project with EXTERNAL_MANAGER role, enabling the aggregator to manage external workers for this project.
No request body needed - automatically uses AGGREGATOR_EMAIL constant. SK authentication is enforced at router level.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Get tasks by external user identifier (sub_id) in a project.
Service account endpoint for retrieving tasks associated with an external user. Filters tasks where task.sub_id matches the provided sub_id.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""External user identifier
Filter by task status
Search by task content
Page number
1Items per page
20Sort by field and direction
Successful Response
Validation Error
No content
Get reviews by external user identifier (sub_id) in a project.
Service account endpoint for retrieving reviews associated with an external user. Filters reviews where review.sub_id matches the provided sub_id.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""External user identifier
Filter by review status
Filter by review action
Search by review ID
Page number
1Items per page
20Sort by field and direction
Successful Response
Validation Error
No content
Get training status by external user identifier (sub_id) in a project.
Service account endpoint for checking training completion status.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""External user identifier
Successful Response
Validation Error
No content
Generate presigned token for external user access with custom permissions.
INTERNAL ONLY: Requires server key authentication.
The token grants scoped access based on the provided permissions. Token is valid for 4 hours and cannot be revoked (stateless design).
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""User ID for authentication (defaults to current authenticated user)
Optional token TTL in hours (defaults to 24 hours if not provided)
Successful Response
Validation Error
Stream debug logs for a dataset via SSE (historical + real-time).
Sends historical logs from the database first, then streams real-time logs from Redis pub/sub as they are generated.
Args: dataset_id: UUID of the annotation dataset request: FastAPI request object (for disconnect detection) user_data: Authenticated user information
Returns: StreamingResponse with text/event-stream content
Raises: HTTPException: 404 if dataset not found, 403 if no permission, 500 on errors
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Accept a catalog project invitation using the token from email.
PUBLIC endpoint - no authentication required. Provisions user, workspace membership, catalog permissions, and project membership.
Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Get all effective permissions for the current user in a project. Returns aggregated permissions from direct grants and role assignments. Used by frontend to show/hide UI actions based on permissions.
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""""110Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""110Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""TABLE""DRAFTPossible values: BASICSuccessful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""""TABLESuccessful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""110Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""false[]Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Get list of files for all tables accessible to the user's workspace and owned by the user
Each table will include up to 'limit' files, but the total_files field will indicate the total count.
Args: q: Optional search query to filter by project name or table name limit: Maximum number of files per table (default: 5)
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""110Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""""PRIVATESuccessful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""""PRIVATESuccessful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Successful Response
Validation Error
No content
Get files for a specific table
Args: table_id: The ID of the table to get files for limit: Maximum number of files to return (default: 5)
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""5Successful Response
Validation Error
Get list of Hugging Face models with pagination and filtering.
Supports both legacy pagination (page-based) and cursor-based pagination.
Features:
Pagination: 20 items per page (configurable)
Multiple filter options and HF native parameters
Automatic cursor extraction and next page URL wrapping
Link header parsing
The response includes a wrapped next_page URL that can be used for pagination:
Original HF URL: https://huggingface.co/api/models?limit=20&cursor=xyz
Wrapped URL: /v1/catalog/models?limit=20&cursor=xyz
Response schema: { "data": [array of models from Hugging Face API], "total": integer (total available models), "page": integer (current page number), "next_page": string (wrapped next page URL for pagination, or empty if last page), "items_per_page": integer (20 or custom limit) }
JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.
""Page number (1-indexed) for legacy pagination
Limit items per page (default 20, max 100)
Cursor for cursor-based pagination (from next_page_url)
Search query for repos and usernames
Filter by author/organization
Filter by tags (HF native parameter)
Filter by task (legacy, maps to filter)
Filter by library (legacy, maps to filter)
Filter by language (legacy, maps to filter)
Filter by license (legacy, maps to filter)
Filter by model ID pattern (legacy, maps to filter)
Filter by task type (convenience param, e.g., 'text-generation')
Filter by framework (convenience param, e.g., 'tensorflow')
Filter by size range (can specify multiple)
Sort by property (e.g., 'downloads', 'trendingScore', 'modified')
Sort direction (-1 for descending)
Fetch complete model data including all tags, files
Fetch repo config
Successful Response
Validation Error
No content
Last updated
Was this helpful?