Skip to main content
POST
Create a new component

Authorizations

x-api-key
string
header
required

API Key for server-to-server authentication. Resolves to the owning organization.

Body

application/json
type
enum<string>
required

Type of component to create

Available options:
chat,
data_analyst,
flashcards,
scenarios,
practice_test,
audio_recap,
tutor_me,
explainers,
uploads,
chat_analytics
name
string
required

Name of the component

Example:

"My Study Component"

config
object
required

Component-specific configuration

description
string

Component description

Example:

"A component for studying biology"

metadata
object

Additional metadata

Response

201 - application/json

Component created successfully

_id
string
required

Component ID (MongoDB ObjectId)

componentId
string
required

Unique component identifier

type
enum<string>
required

Component type

Available options:
chat,
data_analyst,
flashcards,
scenarios,
practice_test,
audio_recap,
tutor_me,
explainers,
uploads,
chat_analytics
name
string
required

Component name

organization
string
required

Organization ID

config
object
required

Component configuration

status
enum<string>
required

Component status

Available options:
active,
inactive,
draft
usage
object
required

Usage statistics

createdAt
string<date-time>
required

Creation timestamp

updatedAt
string<date-time>
required

Last update timestamp

description
string

Component description