Prompt'RDocumentation
Retour à la documentation

API Rest

Documentation interactive de l'API Rest de Prompt'R.
Testez directement les endpoints avec votre token d'API.

Introduction

To use this interactive documentation, you need an API Token.

You can generate one in your account seetings.

auth

Get information about your account

GET
/account
Description

This endpoint allow you to get information about the authenticated user's account.

Note: This endpoint requires authentication.

Responses
200Account information retrieved successfully
401Unauthenticated

health

Health check endpoint

GET
/health
Description

Check if the API service is running smoothly

Responses
200Service is running smoothly

your prompts

Get all your prompts

GET
/prompts
Description

Retrieve all your prompts

Parameters
sort
In query
Sort results by field (prefix with - for descending)
page[number]
In queryDefault: 1
Page number (pagination)
page[size]
In queryDefault: 30
Page size (pagination)
filter[name]
In query
Filter by prompt name
filter[keywords]
In query
Filter by keywords
include
In query
Include related resources (comma-separated)
Responses
200Successful
404Prompt not found

Get one of your prompt by UUID

GET
/prompts/{uuid}
Description

Retrieve one of your prompt by its UUID

Parameters
uuid
In pathRequired
UUID of the public prompt to retrieve
Responses
200Prompt retrieved successfully
404Prompt not found

public prompts

Get all public prompts

GET
/public/prompts
Description

Retrieve all public prompts

Parameters
sort
In query
Sort results by field (prefix with - for descending)
page[number]
In queryDefault: 1
Page number (pagination)
page[size]
In queryDefault: 30
Page size (pagination)
filter[name]
In query
Filter by prompt name
filter[keywords]
In query
Filter by keywords
include
In query
Include related resources (comma-separated)
Responses
200Successful
404Prompt not found

Get one of public prompts by UUID

GET
/public/prompts/{uuid}
Description

Retrieve one of the public prompts by its UUID.

Parameters
uuid
In pathRequired
UUID of the public prompt to retrieve
Responses
200Prompt retrieved successfully
404Prompt not found

Interfaces

Discover all used interfaces.

AccountType

Account's Type information

Properties
name
string
Name of your account
Example: Business

Account

Account resource representation

Properties
uuid
string
UUID of your account
Example: c6e1f5f6-2433-4e8a-b0a9-36cdbd687f19
name
string
Name of your account
Example: AxO Conseils
accountType
#/components/schemas/AccountType

Framework

Declared framework for a prompt.

Properties
id
number
ID of the framework
Example: 1
name
string
Name of the framework
Example: CCOA
overview
string
Overview of the framework
Example: A framework designed to help with creative writing tasks

PaginationMeta

List of pagination meta data

Properties
currentPage
number
Current page number
from
number
First item of the current page
lastPage
number
Last page number
perPage
number
Number of items per page
to
number
Last item of the current page
total
number
Total number of items

Owner

Owner of a prompt.

Properties
id
number
ID of the owner
Example: 1
lastname
string
Lastname of the owner
Example: Doe
firstname
string
Firstname of the owner
Example: John

Prompt

Description of a prompt with all its details, content and instructions.

Properties
uuid
string
Unique identifier of the prompt
Example: 550e8400-e29b-41d4-a716-446655440000
name
string
Name of the prompt
Example: Creative Writing Assistant
overview
string
Brief overview of the prompt
Example: A prompt designed to help with creative writing tasks
instruction
string
Detailed instructions for the prompt
Example: You are a creative writing assistant. Help users develop their stories...
content
string
Main content of the prompt
Example: Please write a creative story about...
created_at
string
Creation timestamp
Example: 2024-01-15T10:30:00.000000Z
updated_at
string
Last update timestamp
Example: 2024-01-16T15:45:00.000000Z
owner
#/components/schemas/Owner
framework
#/components/schemas/Framework
thematics
array
Associated thematics (when loaded)
#/components/schemas/Thematic
tags
array
Associated tags (when loaded)
#/components/schemas/Tag
providers
array
Associated providers (when loaded)
#/components/schemas/Provider
variables
array
Extracted variables from the prompt content (when loaded)
#/components/schemas/PromptVariable

Prompt Variable

Definition of a prompt variable.

Properties
name
string
Name of the variable
Example: Ordre du jour
content
string
Content of the variable
Example: Ordre du jour
type
string
Type of the variable
Example: text
note
string
Information about the variable
Example: Décrivez ici l'ordre du jour de la réunion.
list_values
array
List of possible values for the variable if type is list
position
integer
Position of the first character of the variable
Example: 240
length
integer
Length of the string corresponding to the variable
Example: 15
raw
string
Raw of the variable
Example: {{Order du jour}}

Provider

Declared provider for a prompt.

Properties
id
number
ID of the provider
Example: 1
name
string
Name of the provider
Example: Claude by Anthropic

Tag

Associated tag for a prompt.

Properties
id
number
ID of the tag
Example: 1
name
string
Name of the tag
Example: Creative Writing

Thematic

Thematic resource representation

Properties
id
number
ID of the thematic
Example: 1
name
string
Name of the thematic
Example: Creative Writing