Skip to main content

Get project by id​

get a project by id

Path Parameters
    projectId uuid required

    Your magic AI project id

Responses

successful

Schema
    id uuid

    The unique identifier of the project

    name string

    The name of the project.

    welcomeQuestion string

    Your AI chat bot will greet the user with this question.

    systemPrompt string

    This is the base prompt what will be passed to the AI model. You can customize the chat bot's behavior by changing this.

    isPublic boolean

    If true, the project will be accessible to all users. Only mark it as true if you want to embed your chat bot to your website

    showResources boolean

    If true, the project will show the resources after answering user's question.

    dataSources object[]

    The data sources that you added to your project

  • Array [
    • id uuid

    The unique identifier of the data source

    projectId uuid

    Your Magic AI project id

    name string

    The name of the data source.

    status string

    Possible values: [pending, processing, ready, failed]

    The status of the data source. If the status is ready, it means that the data source is ready to be used to train the AI model. If the status is processing, it means that the data source is still being processed. You can not use the data source until the status is ready.

    sourceType string

    Possible values: [file, drive, notion, web, text]

    Data source type. This is automatically set by the system depending on how did you connect your data source. You can not change it.

    summary string

    A short summary of the data source. When you first upload your data source, the system will automatically generate a summary for you.

    characterCount integer
  • ]
Loading...