Save Prompt Status

PUT 
/api/chat/save-prompt

This endpoint allows saving the status of a query response in a specified conversation within a workspace. The request must include a valid API key and user ID.

Request

Header Parameters

x-api-key stringrequired

API key to authorize the request.

userId stringrequired

ID of the user making the request.

application/json

Body

required

workspaceId stringrequired

ID of the workspace.

conversationId stringrequired

ID of the conversation.

queryResponseId stringrequired

ID of the query response to be saved.

status stringrequired

The status indicating the save action.

Responses

200

Successfully updated the save status.

application/json

Schema

Schema

id string

The ID of the query response.

status string

The updated status indicating the save action.

Example (from schema)

{
  "id": "string",
  "status": "string"
}

400

Invalid body or fetch operation failed.

application/json

Schema

Schema

error string

Error message indicating the issue with the request body or fetch operation.

Example (from schema)

{
  "error": "string"
}

403

Invalid API key.

application/json

Schema

Schema

error

object

message string

Detailed error message indicating that the API key is invalid.

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

404

Conversation or workspace not found.

application/json

Schema

Schema

error

object

message string

Error message indicating that the conversation or workspace was not found.

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

500

Internal server error.

application/json

Schema

Schema

message string

Error message indicating an internal server error.

Example (from schema)

{
  "message": "string"
}

Loading...