Sign in
Knowledge Bases

Create a new datasource

Creates a datasource shell when only a display name is provided. When file_id is provided, the uploaded file is queued for chunking and ingestion.

post/v2/knowledge/{knowledge_id}/datasources

Path parameters

knowledge_idstring required

Request body

display_namestring
descriptionstring nullable

The description of the knowledge base

file_idstring
idstring

Compatibility fields used by the former datasource shell/legacy route.

Response

Datasource successfully created

display_namestring required
descriptionstring nullable

The description of the knowledge base

status'pending' | 'processing' | 'completed' | 'failed' | 'queued' required
file_idstring nullable

The unique identifier of the file used to create the datasource.

createdstring required
updatedstring required
created_by_idstring uuid nullable

The user ID of the creator of the knowledge base

update_by_idstring uuid nullable

The user ID of the last user who updated the knowledge base

knowledge_idstring required
chunks_countnumber double required
_idstring required

Changes

Changed in 140 of the 251 revisions of this API.6230263

  • addad33219df418See the full diff
    • ▲

      the response property metadata became optional for the status 200

      response-property-became-optional

    • ▲

      the _id response's property type/format changed from string/ulid to string/ for status 200

      response-property-type-changed

    • ▲

      the created_by_id response's property type/format changed from string null/ to string null/uuid for status 200

      response-property-type-changed

    • ▲

      the update_by_id response's property type/format changed from string null/ to string null/uuid for status 200

      response-property-type-changed

    • ○

      added the new optional request property attachment

      new-optional-request-property

    • ○

      added the new optional request property id

      new-optional-request-property

    • ○

      added the new optional request property metadata/characters_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/chunks_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/paragraphs_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/sentences_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/tokens_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/words_count

      new-optional-request-property

    • ○

      added the optional property attachment to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property processing_attempts to the response with the 200 status

      response-optional-property-added

    • ○

      the response optional property _id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property created_by_id became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      the response optional property update_by_id became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      the response property _id became required for the status 200

      response-property-became-required

    • ○

      the _id response's property default value 01M0NTJ652D9R63E23B4BRQ8NB was removed for the status 200

      response-property-default-value-removed

    • ○

      the created_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was added for the status 200

      response-property-pattern-added

    • ○

      the update_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was added for the status 200

      response-property-pattern-added

    • ○

      the _id response's property pattern ^[0-9A-HJKMNP-TV-Z]{26}$ was removed for the status 200

      response-property-pattern-removed

    This revision also has 31 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1586760a252f10108See the full diff
    • ▲

      the response property _id became optional for the status 200

      response-property-became-optional

    • ▲

      the chunks_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the created_by_id response's property type/format changed from string null/uuid to string null/ for status 200

      response-property-type-changed

    • ▲

      the metadata/characters_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/chunks_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/paragraphs_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/sentences_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/tokens_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/words_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the update_by_id response's property type/format changed from string null/uuid to string null/ for status 200

      response-property-type-changed

    • ●

      removed the request property attachment

      request-property-removed

    • ●

      removed the request property id

      request-property-removed

    • ●

      removed the request property metadata/characters_count

      request-property-removed

    • ●

      removed the request property metadata/chunks_count

      request-property-removed

    • ●

      removed the request property metadata/paragraphs_count

      request-property-removed

    • ●

      removed the request property metadata/sentences_count

      request-property-removed

    • ●

      removed the request property metadata/tokens_count

      request-property-removed

    • ●

      removed the request property metadata/words_count

      request-property-removed

    • ●

      removed the optional property attachment from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property processing_attempts from the response with the 200 status

      response-optional-property-removed

    • ○

      the response optional property created_by_id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property update_by_id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response property metadata became required for the status 200

      response-property-became-required

    • ○

      the _id response's property default value 01M0JC91GX8EKQP2VRX14T06GD was added for the status 200

      response-property-default-value-added

    • ○

      the _id response's property pattern ^[0-9A-HJKMNP-TV-Z]{26}$ was added for the status 200

      response-property-pattern-added

    • ○

      the created_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was removed for the status 200

      response-property-pattern-removed

    • ○

      the update_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was removed for the status 200

      response-property-pattern-removed

    • ○

      the response required property _id became read-only for the status 200

      response-required-property-became-read-only

    This revision also has 173 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4fdc24e562eb418See the full diff
    • ▲

      the response property metadata became optional for the status 200

      response-property-became-optional

    • ▲

      the _id response's property type/format changed from string/ulid to string/ for status 200

      response-property-type-changed

    • ▲

      the created_by_id response's property type/format changed from string null/ to string null/uuid for status 200

      response-property-type-changed

    • ▲

      the update_by_id response's property type/format changed from string null/ to string null/uuid for status 200

      response-property-type-changed

    • ○

      added the new optional request property attachment

      new-optional-request-property

    • ○

      added the new optional request property id

      new-optional-request-property

    • ○

      added the new optional request property metadata/characters_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/chunks_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/paragraphs_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/sentences_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/tokens_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/words_count

      new-optional-request-property

    • ○

      added the optional property attachment to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property processing_attempts to the response with the 200 status

      response-optional-property-added

    • ○

      the response optional property _id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property created_by_id became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      the response optional property update_by_id became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      the response property _id became required for the status 200

      response-property-became-required

    • ○

      the _id response's property default value 01M0HFR581NHR6HYN4A458F821 was removed for the status 200

      response-property-default-value-removed

    • ○

      the created_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was added for the status 200

      response-property-pattern-added

    • ○

      the update_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was added for the status 200

      response-property-pattern-added

    • ○

      the _id response's property pattern ^[0-9A-HJKMNP-TV-Z]{26}$ was removed for the status 200

      response-property-pattern-removed

    This revision also has 31 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • be3fe58ce38910108See the full diff
    • ▲

      the response property _id became optional for the status 200

      response-property-became-optional

    • ▲

      the chunks_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the created_by_id response's property type/format changed from string null/uuid to string null/ for status 200

      response-property-type-changed

    • ▲

      the metadata/characters_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/chunks_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/paragraphs_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/sentences_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/tokens_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/words_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the update_by_id response's property type/format changed from string null/uuid to string null/ for status 200

      response-property-type-changed

    • ●

      removed the request property attachment

      request-property-removed

    • ●

      removed the request property id

      request-property-removed

    • ●

      removed the request property metadata/characters_count

      request-property-removed

    • ●

      removed the request property metadata/chunks_count

      request-property-removed

    • ●

      removed the request property metadata/paragraphs_count

      request-property-removed

    • ●

      removed the request property metadata/sentences_count

      request-property-removed

    • ●

      removed the request property metadata/tokens_count

      request-property-removed

    • ●

      removed the request property metadata/words_count

      request-property-removed

    • ●

      removed the optional property attachment from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property processing_attempts from the response with the 200 status

      response-optional-property-removed

    • ○

      the response optional property created_by_id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property update_by_id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response property metadata became required for the status 200

      response-property-became-required

    • ○

      the _id response's property default value 01M0GK5X18VQQJ6BV5DCZHPRHQ was added for the status 200

      response-property-default-value-added

    • ○

      the _id response's property pattern ^[0-9A-HJKMNP-TV-Z]{26}$ was added for the status 200

      response-property-pattern-added

    • ○

      the created_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was removed for the status 200

      response-property-pattern-removed

    • ○

      the update_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was removed for the status 200

      response-property-pattern-removed

    • ○

      the response required property _id became read-only for the status 200

      response-required-property-became-read-only

    This revision also has 175 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f54fa34db0f4418See the full diff
    • ▲

      the response property metadata became optional for the status 200

      response-property-became-optional

    • ▲

      the _id response's property type/format changed from string/ulid to string/ for status 200

      response-property-type-changed

    • ▲

      the created_by_id response's property type/format changed from string null/ to string null/uuid for status 200

      response-property-type-changed

    • ▲

      the update_by_id response's property type/format changed from string null/ to string null/uuid for status 200

      response-property-type-changed

    • ○

      added the new optional request property attachment

      new-optional-request-property

    • ○

      added the new optional request property id

      new-optional-request-property

    • ○

      added the new optional request property metadata/characters_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/chunks_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/paragraphs_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/sentences_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/tokens_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/words_count

      new-optional-request-property

    • ○

      added the optional property attachment to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property processing_attempts to the response with the 200 status

      response-optional-property-added

    • ○

      the response optional property _id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property created_by_id became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      the response optional property update_by_id became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      the response property _id became required for the status 200

      response-property-became-required

    • ○

      the _id response's property default value 01M08SAY23FFXRG5S9KKFX5QPW was removed for the status 200

      response-property-default-value-removed

    • ○

      the created_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was added for the status 200

      response-property-pattern-added

    • ○

      the update_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was added for the status 200

      response-property-pattern-added

    • ○

      the _id response's property pattern ^[0-9A-HJKMNP-TV-Z]{26}$ was removed for the status 200

      response-property-pattern-removed

    This revision also has 31 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ed68e8b009d710108See the full diff
    • ▲

      the response property _id became optional for the status 200

      response-property-became-optional

    • ▲

      the chunks_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the created_by_id response's property type/format changed from string null/uuid to string null/ for status 200

      response-property-type-changed

    • ▲

      the metadata/characters_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/chunks_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/paragraphs_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/sentences_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/tokens_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the metadata/words_count response's property type/format changed from number/double to number/ for status 200

      response-property-type-changed

    • ▲

      the update_by_id response's property type/format changed from string null/uuid to string null/ for status 200

      response-property-type-changed

    • ●

      removed the request property attachment

      request-property-removed

    • ●

      removed the request property id

      request-property-removed

    • ●

      removed the request property metadata/characters_count

      request-property-removed

    • ●

      removed the request property metadata/chunks_count

      request-property-removed

    • ●

      removed the request property metadata/paragraphs_count

      request-property-removed

    • ●

      removed the request property metadata/sentences_count

      request-property-removed

    • ●

      removed the request property metadata/tokens_count

      request-property-removed

    • ●

      removed the request property metadata/words_count

      request-property-removed

    • ●

      removed the optional property attachment from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property processing_attempts from the response with the 200 status

      response-optional-property-removed

    • ○

      the response optional property created_by_id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property update_by_id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response property metadata became required for the status 200

      response-property-became-required

    • ○

      the _id response's property default value 01M08SAY23FFXRG5S9KKFX5QPW was added for the status 200

      response-property-default-value-added

    • ○

      the _id response's property pattern ^[0-9A-HJKMNP-TV-Z]{26}$ was added for the status 200

      response-property-pattern-added

    • ○

      the created_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was removed for the status 200

      response-property-pattern-removed

    • ○

      the update_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was removed for the status 200

      response-property-pattern-removed

    • ○

      the response required property _id became read-only for the status 200

      response-required-property-became-read-only

    This revision also has 173 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d46bd23ae34c418See the full diff
    • ▲

      the response property metadata became optional for the status 200

      response-property-became-optional

    • ▲

      the _id response's property type/format changed from string/ulid to string/ for status 200

      response-property-type-changed

    • ▲

      the created_by_id response's property type/format changed from string null/ to string null/uuid for status 200

      response-property-type-changed

    • ▲

      the update_by_id response's property type/format changed from string null/ to string null/uuid for status 200

      response-property-type-changed

    • ○

      added the new optional request property attachment

      new-optional-request-property

    • ○

      added the new optional request property id

      new-optional-request-property

    • ○

      added the new optional request property metadata/characters_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/chunks_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/paragraphs_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/sentences_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/tokens_count

      new-optional-request-property

    • ○

      added the new optional request property metadata/words_count

      new-optional-request-property

    • ○

      added the optional property attachment to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property processing_attempts to the response with the 200 status

      response-optional-property-added

    • ○

      the response optional property _id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property created_by_id became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      the response optional property update_by_id became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      the response property _id became required for the status 200

      response-property-became-required

    • ○

      the _id response's property default value 01M07MJMHRKCHN2BTXNHPSGA1J was removed for the status 200

      response-property-default-value-removed

    • ○

      the created_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was added for the status 200

      response-property-pattern-added

    • ○

      the update_by_id response's property pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ was added for the status 200

      response-property-pattern-added

    • ○

      the _id response's property pattern ^[0-9A-HJKMNP-TV-Z]{26}$ was removed for the status 200

      response-property-pattern-removed

    This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f459ad9381eb1See the full diff
    • ○

      the _id response's property default value changed from 01M06YQWREKCT6WHK61RAY7GXG to 01M07MJMHRKCHN2BTXNHPSGA1J for the status 200

      response-property-default-value-changed

    This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2502c8757f971See the full diff
    • ○

      the _id response's property default value changed from 01M0083J40C5GE7TYSPP3ZXT0R to 01M06YQWREKCT6WHK61RAY7GXG for the status 200

      response-property-default-value-changed

  • deb8d376faee1See the full diff
    • ○

      the _id response's property default value changed from 01KZZX6HNVMR5RR1YJ8EGDFH44 to 01M0083J40C5GE7TYSPP3ZXT0R for the status 200

      response-property-default-value-changed

    This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 251 revisions, 71 have no diff computed.