GET/topics/{topicId}Retrieve details about a specific topic in the Proompty API. By sending a GET request to this endpoint with the corresponding topicId parameter, users can access information such a
PUT/topics/{topicId}Update the details of a specific topic in the Proompty API. By sending a PUT request to this endpoint with the corresponding topicId parameter and the updated topic object in the r
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Proompty Topic API
version: 1.1.0
description: '
Proompty is an advanced Retrieval Augmented Generation (RAG) API designed
to empower users in seamlessly integrating their data and harnessing the
power of customized Large Language Model (LLM) prompts for interactive
communication. At its core, Proompty operates through a series of
interconnected functionalities that enable users to navigate and
manipulate their data effectively.'
termsOfService: https://proompty.com/terms-of-service
contact:
email: developers@proompty.com
servers:
- url: https://app.proompty.com/api
security:
- APIKey: []
tags:
- name: Topic
paths:
/topics/{topicId}:
get:
tags:
- Topic
description: Get a topic by ID
summary: Retrieve details about a specific topic in the Proompty API. By sending a GET request to this endpoint with the corresponding topicId parameter, users can access information such as the topic's title, description, and any associated documents or chats. The API responds with the topic object in JSON format, containing the relevant details. In case the requested topic is not found, appropriate error responses are returned (404 for topic not found, 500 for other errors), ensuring users receive accurate feedback regarding the status of their request.
parameters:
- in: path
name: topicId
schema:
type: string
required: true
- in: query
name: include
schema:
type: string
required: false
description: 'Include additional data in the response. Possible values: documents, chats.'
responses:
'200':
description: Topic
content:
application/json:
schema:
$ref: '#/components/schemas/Topic'
'404':
description: Not found
put:
tags:
- Topic
description: Update a topic by ID
summary: Update the details of a specific topic in the Proompty API. By sending a PUT request to this endpoint with the corresponding topicId parameter and the updated topic object in the request body, users can modify the topic's title, description, or other attributes. The API responds with the updated topic object in JSON format, containing the new details. In case the requested topic is not found, an appropriate error response is returned (404), ensuring users receive accurate feedback regarding the status of their request.
parameters:
- in: path
name: topicId
schema:
type: string
required: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Topic'
responses:
'200':
description: Topic
content:
application/json:
schema:
$ref: '#/components/schemas/Topic'
externalDocs:
url: /api.yaml
description: OpenAPI Specification