Logo

Create a new conversation

Creates a new conversation with the provided details.

POST
/conversation

Authorization

api-key<token>

This is a required API key. It must be included in the header of all requests in the format: api-key: value.

In: header

Request Body

application/jsonRequired

metadata
Required
object

curl -X POST "https://api.systemprompt.io/v1/conversation" \
  -H "api-key: <apikey>" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "title": "Research Analysis",
      "description": "A schema for analysing research data for blogs",
      "tag": [
        "SystemPrompt",
        "Blog",
        "Conversation",
        "Text Output"
      ],
      "log_message": "Created a new research analysis"
    }
  }'

Successful response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "message": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "role": "user",
      "content": "Please analyze this text and provide feedback.",
      "reference": [
        {}
      ],
      "model": "gpt-4o-mini",
      "metadata": {
        "title": "Title of the message",
        "description": "Description of the message",
        "tag": [
          "string"
        ],
        "created": "2024-01-01 00:00:00",
        "updated": "2024-01-01 00:00:00",
        "version": 1,
        "status": "published",
        "author": "John Doe"
      }
    }
  ],
  "metadata": {
    "title": "Research Analysis",
    "description": "A schema for analysing research data for blogs",
    "created": "2023-04-01T12:00:00Z",
    "updated": "2023-04-01T12:00:00Z",
    "version": 1,
    "status": "published",
    "tag": [
      "SystemPrompt",
      "Blog",
      "Conversation",
      "Text Output"
    ],
    "log_message": "Created a new research analysis",
    "author": "admin"
  },
  "_link": "string"
}