post__conversation_{conversationId}_prompt

⚠️ TEST ENVIRONMENT ONLY

This API endpoint is currently available only in the TEST environment. It is not yet available in production.

POST /conversation/{conversationId}/prompt

Send Prompt to Conversation

Send a user prompt to an AI conversation. This endpoint processes the prompt through the configured AI provider and returns the assistant's response, maintaining conversation context for multi-turn interactions.

Key Features:

Sends user prompts to the AI conversation engine
Maintains conversation context across multiple turns
Integrates with repository AI API keys for authentication
Enforces AI policies and governance rules
Tracks token usage and updates conversation statistics
Returns assistant responses in real-time or streaming format

Important Notes:

Users must have access to the conversation's workspace
The conversation must exist and not be deleted
Policy enforcement occurs during prompt processing
Token usage is automatically tracked and updated
Responses are subject to policy validation (log, alert, or block)

Security:

Access is validated against workspace permissions
Only users with workspace read access can send prompts
Policies are evaluated before and during prompt processing
Violations are logged and tracked for compliance

Integration:

This endpoint integrates with external conversation API engines to process prompts and generate responses. The system handles:

Routing to the appropriate AI provider
Context management across conversation turns
Policy enforcement and violation detection
Token counting and usage tracking

TypeScript Client Library

public sendPrompt = async (
  conversationId: string,
  data: SendPromptRequest
): Promise<SendPromptResponse> => {
  return this.makeRequest<SendPromptResponse>(`conversation/${conversationId}/prompt`, 'POST', data);
};

Code Samples

# You can also use wget
curl -X POST https://backend.flashback.tech/conversation/{conversationId}/prompt \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

const inputBody = '{
  "prompt": "What is the best practice for securing API keys?"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://backend.flashback.tech/conversation/{conversationId}/prompt',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://backend.flashback.tech/conversation/{conversationId}/prompt',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://backend.flashback.tech/conversation/{conversationId}/prompt', headers = headers)

print(r.json())

URL obj = new URL("https://backend.flashback.tech/conversation/{conversationId}/prompt");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://backend.flashback.tech/conversation/{conversationId}/prompt", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Body parameter

{
  "prompt": "What is the best practice for securing API keys?"
}

Parameters

Name

Type

Required

Description

conversationId

path

string

true

Unique identifier of the conversation

body

object

true

none

» prompt

body

string

true

User prompt text to send to the AI

Example responses

200 Response

{
  "success": true,
  "message": "Prompt sent successfully"
}

Responses

Status

Meaning

Description

Schema

200

Prompt sent successfully

Inline

400

Bad Request

Validation error or invalid input

Inline

403

Forbidden

Insufficient permissions

Inline

404

Not Found

Conversation not found

Inline

500

Internal Server Error

Failed to send prompt

Inline

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» success

boolean

false

none

Operation success status

» message

string

false

none

Success message

Note: Additional response fields may be added when the external API integration is fully implemented, such as response content, token counts, model information, and streaming metadata.

Status Code 400

Name

Type

Required

Restrictions

Description

» success

boolean

false

none

» message

string

false

none

Error message

Status Code 403

Name

Type

Required

Restrictions

Description

» success

boolean

false

none

» message

string

false

none

Error message

Status Code 404

Name

Type

Required

Restrictions

Description

» success

boolean

false

none

» message

string

false

none

Error message

Status Code 500

Name

Type

Required

Restrictions

Description

» success

boolean

false

none

» message

string

false

none

Error message

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

Previouspost__conversation Nextget__conversation

Last updated 25 days ago

Was this helpful?