Deep Research Profiles

Upsert

post

Upsert a Deep Research Profile entry.

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

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

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

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Read Permissions
Authorizations
OAuth2passwordRequired
Token URL:
Body

Deep Research Profile model.

codenamestringRequired
typestring · enumRequiredPossible values:
titlestringRequired
descriptionstringRequired
parametersany ofRequired
or
updated_timestring · date-timeOptionalDefault: 2025-12-02T17:36:18.468511
idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/dr-profiles/upsert

No content

Get

get

Read multiple DRProfileModel rows from the database.

  • Use page & itemsPerPage for paginated results

  • Use offset & limit for specific ranges

  • Returns paginated response when using page/itemsPerPage

  • Returns simple list response when using offset/limit

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Read Permissions
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
offsetany ofOptional

Offset for unpaginated queries

integerOptional
or
nullOptional
limitany ofOptional

Limit for unpaginated queries

integerOptional
or
nullOptional
pageany ofOptional

Page number

integerOptional
or
nullOptional
itemsPerPageany ofOptional

Number of items per page

integerOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
Responseany of
or
get
/dr-profiles

Create

post

Create a new DRProfileModel row in the database.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Read Permissions
Authorizations
OAuth2passwordRequired
Token URL:
Body

Create Deep Research Profile model.

codenamestringRequired
typestring · enumRequiredPossible values:
titlestringRequired
descriptionstringRequired
parametersany ofRequired
or
updated_timestring · date-timeOptionalDefault: 2025-12-02T17:36:18.468511
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/dr-profiles

No content

Get

get

Read a single DRProfileModel row from the database by its primary keys: ['id'].

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Read Permissions
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
get
/dr-profiles/{id}

Delete

delete

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

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Read Permissions
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
Responseany
delete
/dr-profiles/{id}

No content

Update

patch

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

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Read Permissions
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idintegerRequired
Body

Create Deep Research Profile model.

codenamestringRequired
typestring · enumRequiredPossible values:
titlestringRequired
descriptionstringRequired
parametersany ofRequired
or
updated_timestring · date-timeOptionalDefault: 2025-12-02T17:36:18.468511
Responses
chevron-right
200

Successful Response

application/json
Responseany
patch
/dr-profiles/{id}

No content

Last updated