Browse Profiles

Upsert

post

Upsert a Browse Profile entry.

Creates a new Browse Profile if the provided id does not exist, or updates the existing Browse Profile with the given id.

Args: request (UpsertBrowseProfile): The Browse Profile data to insert or update. db (AsyncSession): The database session dependency.

Returns: JSONResponse: A JSON response containing the Browse Profile data that was upserted.

Raises: HTTPException: If the operation encounters an unexpected error (not currently implemented, but can be added for error handling).

Notes: - Uses FastCRUD for abstracted DB operations. - Relies on the id field to determine insert vs update.

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

Browse Profile model.

orderintegerRequired

codenamestringRequired

titlestringRequired

descriptionstringRequired

providerstringRequired

hostsstring[]Required

system_promptintegerRequired

user_promptintegerRequired

idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/browse-profiles/upsert

HTTPcURLJavaScriptPython

POST /browse-profiles/upsert HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "order": 1,
  "codename": "text",
  "title": "text",
  "description": "text",
  "provider": "text",
  "hosts": [
    "text"
  ],
  "system_prompt": 1,
  "user_prompt": 1,
  "id": 1
}

No content

Read

get

Get a Browse Profile by ID.

Args: id (int): The ID of the Browse Profile. db (AsyncSession): The database session.

Returns: JSONResponse: A JSON response containing the Browse Profile.

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/browse-profiles/{id}

HTTPcURLJavaScriptPython

GET /browse-profiles/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Delete

delete

Delete a BrowseProfileModel row from the database by its primary keys: ['id'].

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/browse-profiles/{id}

HTTPcURLJavaScriptPython

DELETE /browse-profiles/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Update

patch

Update an existing BrowseProfileModel row in the database by its primary keys: ['id'].

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

idintegerRequired

Body

application/json

Create Browse Profile model.

orderintegerRequired

codenamestringRequired

titlestringRequired

descriptionstringRequired

providerstringRequired

hostsstring[]Required

system_promptintegerRequired

user_promptintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

patch

/browse-profiles/{id}

HTTPcURLJavaScriptPython

PATCH /browse-profiles/{id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "order": 1,
  "codename": "text",
  "title": "text",
  "description": "text",
  "provider": "text",
  "hosts": [
    "text"
  ],
  "system_prompt": 1,
  "user_prompt": 1
}

No content

List

get

Get a paginated list of Browse Profiles.

Args: request (SmartSearchListBrowseRequest): The request object containing pagination parameters. db (AsyncSession): The database session.

Returns: JSONResponse: A JSON response containing the paginated list of Browse Profiles.

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Query parameters

pageintegerOptionalDefault: 1

itemsPerPageinteger · min: 1 · max: 100OptionalDefault: 10

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/browse-profiles

HTTPcURLJavaScriptPython

GET /browse-profiles HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Create

post

Create a new BrowseProfileModel row in the database.

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

Create Browse Profile model.

orderintegerRequired

codenamestringRequired

titlestringRequired

descriptionstringRequired

providerstringRequired

hostsstring[]Required

system_promptintegerRequired

user_promptintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/browse-profiles

HTTPcURLJavaScriptPython

POST /browse-profiles HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "order": 1,
  "codename": "text",
  "title": "text",
  "description": "text",
  "provider": "text",
  "hosts": [
    "text"
  ],
  "system_prompt": 1,
  "user_prompt": 1
}

No content