Deep Search Profiles

Upsert

post

Upsert a Deep Search Profile entry.

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

Args: request (DSProfile): The Deep Search Profile data to insert or update. db (AsyncSession): The database session dependency.

Returns: JSONResponse: A JSON response containing the Deep Search 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

Deep Search Profile model.

codenamestringRequired

titlestringRequired

descriptionstringRequired

providersstringRequired

additional_querystringRequired

filtersstringRequired

updated_timestring · date-timeOptionalDefault: 2025-12-02T17:36:18.514374

expand_querybooleanRequired

query_system_promptintegerOptional

query_user_promptintegerOptional

idintegerRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/ds-profiles/upsert

HTTPcURLJavaScriptPython

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

{
  "codename": "text",
  "title": "text",
  "description": "text",
  "providers": "text",
  "additional_query": "text",
  "filters": "text",
  "updated_time": "2025-12-02T17:36:18.514374",
  "expand_query": true,
  "query_system_prompt": 1,
  "query_user_prompt": 1,
  "id": 1
}

No content

Read

get

Get a Deep Search Profile by ID.

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

Returns: JSONResponse: A JSON response containing the Deep Search 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

/ds-profiles/{id}

HTTPcURLJavaScriptPython

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

No content

Delete

delete

Delete a DSProfileModel 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

/ds-profiles/{id}

HTTPcURLJavaScriptPython

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

No content

Update

patch

Update an existing DSProfileModel 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 Deep Search Profile model.

codenamestringRequired

titlestringRequired

descriptionstringRequired

providersstringRequired

additional_querystringRequired

filtersstringRequired

updated_timestring · date-timeOptionalDefault: 2025-12-02T17:36:18.514374

expand_querybooleanRequired

query_system_promptintegerOptional

query_user_promptintegerOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

patch

/ds-profiles/{id}

HTTPcURLJavaScriptPython

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

{
  "codename": "text",
  "title": "text",
  "description": "text",
  "providers": "text",
  "additional_query": "text",
  "filters": "text",
  "updated_time": "2025-12-02T17:36:18.514374",
  "expand_query": true,
  "query_system_prompt": 1,
  "query_user_prompt": 1
}

No content

List

get

Get a paginated list of Deep Search 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 Deep Search 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

/ds-profiles

HTTPcURLJavaScriptPython

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

No content

Create

post

Create a new DSProfileModel row in the database.

Required scopes

This endpoint requires the following scopes:

• : Read Permissions

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

Create Deep Search Profile model.

codenamestringRequired

titlestringRequired

descriptionstringRequired

providersstringRequired

additional_querystringRequired

filtersstringRequired

updated_timestring · date-timeOptionalDefault: 2025-12-02T17:36:18.514374

expand_querybooleanRequired

query_system_promptintegerOptional

query_user_promptintegerOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/ds-profiles

HTTPcURLJavaScriptPython

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

{
  "codename": "text",
  "title": "text",
  "description": "text",
  "providers": "text",
  "additional_query": "text",
  "filters": "text",
  "updated_time": "2025-12-02T17:36:18.514374",
  "expand_query": true,
  "query_system_prompt": 1,
  "query_user_prompt": 1
}

No content