# Conversation

## Get conversation.

> Use this endpoint to get conversation.

```json
{"openapi":"3.0.1","info":{"title":"WebApi | v1","version":"1.0.0"},"tags":[{"name":"Conversation"}],"servers":[{"url":"https://api.safegpt.nl/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"JWT bearer token. Example: 'Bearer {token}'.","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/v1/Conversation/Get":{"get":{"tags":["Conversation"],"summary":"Get conversation.","description":"Use this endpoint to get conversation.","responses":{"200":{"description":"OK"},"401":{"description":"Authentication is required."},"403":{"description":"The user is not authorized to access this endpoint."}}}}}}
```

## Retrieves conversations for the current user filtered by conversation type.

> Returns lightweight conversation entries for the authenticated user, limited to the requested .

```json
{"openapi":"3.0.1","info":{"title":"WebApi | v1","version":"1.0.0"},"tags":[{"name":"Conversation"}],"servers":[{"url":"https://api.safegpt.nl/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"JWT bearer token. Example: 'Bearer {token}'.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ConversationType2":{"type":"integer"}}},"paths":{"/v1/Conversation/GetByType/{conversationType}":{"get":{"tags":["Conversation"],"summary":"Retrieves conversations for the current user filtered by conversation type.","description":"Returns lightweight conversation entries for the authenticated user, limited to the requested .","parameters":[{"name":"conversationType","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ConversationType2"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Authentication is required."},"403":{"description":"The user is not authorized to access this endpoint."}}}}}}
```

## Retrieves conversations for the current user filtered by conversation type.

> Returns lightweight conversation entries for the authenticated user, limited to the requested .

```json
{"openapi":"3.0.1","info":{"title":"WebApi | v1","version":"1.0.0"},"tags":[{"name":"Conversation"}],"servers":[{"url":"https://api.safegpt.nl/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"JWT bearer token. Example: 'Bearer {token}'.","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/v1/Conversation/Get/{conversationId}":{"get":{"tags":["Conversation"],"summary":"Retrieves conversations for the current user filtered by conversation type.","description":"Returns lightweight conversation entries for the authenticated user, limited to the requested .","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Authentication is required."},"403":{"description":"The user is not authorized to access this endpoint."}}}}}}
```

## Create conversation.

> Use this endpoint to create conversation.

```json
{"openapi":"3.0.1","info":{"title":"WebApi | v1","version":"1.0.0"},"tags":[{"name":"Conversation"}],"servers":[{"url":"https://api.safegpt.nl/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"JWT bearer token. Example: 'Bearer {token}'.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CreateConversationViewModel":{"required":["prompt"],"type":"object","properties":{"codeInterpreter":{"type":"boolean","description":"Gets or sets whether code interpreter mode should be enabled."},"webSearch":{"type":"boolean","description":"Gets or sets whether web search is enabled for the conversation."},"vectorStoreId":{"type":"string","description":"Gets or sets an optional vector store identifier for retrieval.","format":"uuid","nullable":true},"toolIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Gets or sets optional tool identifiers to activate.","nullable":true},"mediaIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Gets or sets optional media identifiers attached to the first message.","nullable":true},"reasoning":{"$ref":"#/components/schemas/NullableOfReasoningEffort"},"conversationType":{"$ref":"#/components/schemas/ConversationType"},"prompt":{"type":"string"}},"description":"Represents the payload for creating a new conversation and its initial user prompt."},"NullableOfReasoningEffort":{"type":"integer","description":"Gets or sets the requested reasoning effort level.","nullable":true},"ConversationType":{"type":"integer","description":"Gets or sets the conversation type to create."}}},"paths":{"/v1/Conversation/Create":{"post":{"tags":["Conversation"],"summary":"Create conversation.","description":"Use this endpoint to create conversation.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConversationViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateConversationViewModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateConversationViewModel"}}},"required":true},"responses":{"200":{"description":"OK"},"401":{"description":"Authentication is required."},"403":{"description":"The user is not authorized to access this endpoint."}}}}}}
```

## Update conversation.

> Use this endpoint to update conversation.

```json
{"openapi":"3.0.1","info":{"title":"WebApi | v1","version":"1.0.0"},"tags":[{"name":"Conversation"}],"servers":[{"url":"https://api.safegpt.nl/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"JWT bearer token. Example: 'Bearer {token}'.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UpdateConversationViewModel":{"type":"object","properties":{"conversationName":{"type":"string","description":"Gets or sets the updated conversation name.","nullable":true},"pinned":{"type":"boolean","description":"Gets or sets whether the conversation should be pinned.","nullable":true}},"description":"Represents the payload for updating conversation metadata."}}},"paths":{"/v1/Conversation/Update/{conversationId}":{"patch":{"tags":["Conversation"],"summary":"Update conversation.","description":"Use this endpoint to update conversation.","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConversationViewModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateConversationViewModel"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/UpdateConversationViewModel"}}},"required":true},"responses":{"200":{"description":"OK"},"401":{"description":"Authentication is required."},"403":{"description":"The user is not authorized to access this endpoint."}}}}}}
```

## Deletes a selected set of conversations owned by the current user.

> Only conversations that belong to the authenticated user are deleted. Unknown or unauthorized conversation identifiers are ignored.

```json
{"openapi":"3.0.1","info":{"title":"WebApi | v1","version":"1.0.0"},"tags":[{"name":"Conversation"}],"servers":[{"url":"https://api.safegpt.nl/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"JWT bearer token. Example: 'Bearer {token}'.","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/v1/Conversation/Delete/{conversationId}":{"delete":{"tags":["Conversation"],"summary":"Deletes a selected set of conversations owned by the current user.","description":"Only conversations that belong to the authenticated user are deleted. Unknown or unauthorized conversation identifiers are ignored.","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Authentication is required."},"403":{"description":"The user is not authorized to access this endpoint."}}}}}}
```

## Deletes a selected set of conversations owned by the current user.

> Only conversations that belong to the authenticated user are deleted. Unknown or unauthorized conversation identifiers are ignored.

```json
{"openapi":"3.0.1","info":{"title":"WebApi | v1","version":"1.0.0"},"tags":[{"name":"Conversation"}],"servers":[{"url":"https://api.safegpt.nl/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"JWT bearer token. Example: 'Bearer {token}'.","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/v1/Conversation/DeleteRange":{"delete":{"tags":["Conversation"],"summary":"Deletes a selected set of conversations owned by the current user.","description":"Only conversations that belong to the authenticated user are deleted. Unknown or unauthorized conversation identifiers are ignored.","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},"text/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},"application/*+json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}},"required":true},"responses":{"200":{"description":"OK"},"401":{"description":"Authentication is required."},"403":{"description":"The user is not authorized to access this endpoint."}}}}}}
```

## Deletes all non-pinned conversations of a given type for the current user.

> Pinned conversations are preserved and excluded from deletion. This endpoint is intended for bulk cleanup by conversation type.

```json
{"openapi":"3.0.1","info":{"title":"WebApi | v1","version":"1.0.0"},"tags":[{"name":"Conversation"}],"servers":[{"url":"https://api.safegpt.nl/"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"JWT bearer token. Example: 'Bearer {token}'.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ConversationType2":{"type":"integer"}}},"paths":{"/v1/Conversation/DeleteAll/{type}":{"delete":{"tags":["Conversation"],"summary":"Deletes all non-pinned conversations of a given type for the current user.","description":"Pinned conversations are preserved and excluded from deletion. This endpoint is intended for bulk cleanup by conversation type.","parameters":[{"name":"type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ConversationType2"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Authentication is required."},"403":{"description":"The user is not authorized to access this endpoint."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.safegpt.nl/api-en/endpoints/conversation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.