Generate Brief

Public endpoint: generate structured brief versions from casual input.

Rate-limited to 10 calls/hour per IP (unauthenticated).

POST /api/v1/brief/generate

Generate Brief

cURL

curl --request POST \
  --url https://api.example.com/api/v1/brief/generate \
  --header 'Content-Type: application/json' \
  --data '
{
  "category": "<string>",
  "task_type": "<string>",
  "prompt": "<string>",
  "conversation_history": [
    {
      "role": "<string>",
      "content": "<string>"
    }
  ],
  "file_descriptions": [
    "<string>"
  ],
  "num_versions": 2
}
'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json

category · string · required

task_type · string · required

prompt · string · required

Required string length: 5 - 10000

conversation_history · ConversationMessage · object[] | null

Show child attributes

file_descriptions · string[] | null

num_versions · integer · default: 2

Required range: 1 <= x <= 5

Response

200

application/json

Successful Response