Generate Metadata Keywords

POST

/ai/metadata/keywords/

curl --request POST \
  --url https://example.com/api/ai/metadata/keywords/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "dataset_id": "example" }'

Generate AI-suggested keywords for a dataset.

Authorizations

• OAuth2PasswordBearer

Request Body ^required

Media type application/json

MetadataAssistRequest

Request body for metadata AI endpoints.

object

dataset_id

required

Dataset Id

UUID of the dataset to generate metadata for

string

Example ^generated

{
  "dataset_id": "example"
}

Responses

200

Successful Response

Media type application/json

KeywordSuggestionsResponse

AI-suggested keywords for a dataset.

object

keywords

required

Keywords

List of suggested keywords with classification (5-10 items)

Array<object>

KeywordSuggestion

A single keyword suggestion with classification.

object

keyword

required

Keyword

Lowercase keyword

string

keyword_type

required

Keyword Type

Classification: theme, place, or temporal

string

Example ^generated

{
  "keywords": [
    {
      "keyword": "example",
      "keyword_type": "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": {}
    }
  ]
}