Generate Map Endpoint

POST

/ai/generate-map/

curl --request POST \
  --url https://example.com/api/ai/generate-map/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "prompt": "example", "language": "example" }'

Generate a map from a natural language prompt using an LLM.

Authorizations

• OAuth2PasswordBearer

Request Body ^required

Media type application/json

MapGenerateRequest

object

prompt

required

Prompt

string

>= 3 characters <= 1000 characters

language

Any of:

string

string

null

null

Example ^generated

{
  "prompt": "example",
  "language": "example"
}

Responses

200

Successful Response

Media type application/json

MapGenerateResponse

object

map_id

required

Map Id

string

map_name

required

Map Name

string

explanation

required

Explanation

string

datasets_used

required

Datasets Used

Array<string>

Example ^generated

{
  "map_id": "example",
  "map_name": "example",
  "explanation": "example",
  "datasets_used": [
    "example"
  ]
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}