Extract Integration

Create Extract integration

post/integration/extract/create

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/integration/extract/create
  • Auth: HTTP bearer

Request body

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

blueprintIdstring nullable

The ID of the blueprint

botIdstring

The ID of the Bot to use

schemaobject

The configured extraction schema

requeststring

Optional webhook to receive the extracted data

modelstring

The language model to use for data extraction

Response

The Extract integration was created successfully

idstring required

The ID of the Extract Integration

Changes

No recorded changes to this operation across all 1 revision of this API.