GET/topicsRetrieve all topics in the Proompty API. By sending a GET request to this endpoint, users can access a list of all topics available in the system. The API responds with an array of
POST/topicsCreate a new topic in the Proompty API. By sending a POST request to this endpoint with the new topic object in the request body, users can create a new topic with the specified at
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 Topics 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: Topics
paths:
/topics:
get:
tags:
- Topics
description: Get all topics
summary: Retrieve all topics in the Proompty API. By sending a GET request to this endpoint, users can access a list of all topics available in the system. The API responds with an array of topic objects in JSON format, containing the relevant details. In case no topics are found, an appropriate error response is returned (404), ensuring users receive accurate feedback regarding the status of their request.
parameters:
- in: query
name: include
schema:
type: string
required: false
description: 'Include additional data in the response. Possible values: chats.'
responses:
'200':
description: Topic[]
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Topic'
'404':
description: Not found
post:
tags:
- Topics
description: Create a topic
summary: Create a new topic in the Proompty API. By sending a POST request to this endpoint with the new topic object in the request body, users can create a new topic with the specified attributes. The API responds with the newly created topic object in JSON format, containing the relevant details. In case the maximum number of topics allowed on the user's plan is reached, an appropriate error response is returned (400), ensuring users receive accurate feedback regarding the status of their request.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Topic'
responses:
'200':
description: Topic
content:
application/json:
schema:
$ref: '#/components/schemas/Topic'
'400':
description: Maximum topics reached
'500':
description: Internal server error
externalDocs:
url: /api.yaml
description: OpenAPI Specification