Extract Integration

Fetch a extractIntegration

get/integration/extract/{extractIntegrationId}/fetch

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/integration/extract/{extractIntegrationId}/fetch
  • Auth: HTTP bearer

Path parameters

extractIntegrationIdstring required

The ID of the Extract integration to retrieve

Response

The Extract integration was retrieved successfully

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

idstring required

The instance ID

createdAtnumber required

The timestamp (ms) when the instance was created

updatedAtnumber required

The timestamp (ms) when the instance was updated

blueprintIdstring nullable

The ID of the blueprint

botIdstring required

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

Changes

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