Sign in
DigitalOcean-public.v2-new_GradientAI Platform

Retrieve Information About an Existing Knowledge Base

To retrive information about an existing knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{uuid}.

get/v2/gen-ai/knowledge_bases/{uuid}

Path parameters

uuidstring required

Knowledge base id

Response

A successful response.

database_status'CREATING' | 'ONLINE' | 'POWEROFF' | 'REBUILDING' | 'REBALANCING' | 'DECOMMISSIONED' | 'FORKING' | 'MIGRATING' | 'RESIZING' | 'RESTORING' | 'POWERING_ON' | 'UNHEALTHY'

Example response

{
  "database_status": "CREATING",
  "knowledge_base": {
    "added_to_agent_at": "2023-01-01T00:00:00Z",
    "created_at": "2023-01-01T00:00:00Z",
    "database_id": "123e4567-e89b-12d3-a456-426614174000",
    "embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "is_public": true,
    "last_indexing_job": {
      "completed_datasources": 123,
      "created_at": "2023-01-01T00:00:00Z",
      "data_source_uuids": [
        "example string"
      ],
      "finished_at": "2023-01-01T00:00:00Z",
      "knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "phase": "BATCH_JOB_PHASE_UNKNOWN",
      "started_at": "2023-01-01T00:00:00Z",
      "status": "INDEX_JOB_STATUS_UNKNOWN",
      "tokens": 123,
      "total_datasources": 123,
      "total_items_failed": "12345",
      "total_items_indexed": "12345",
      "total_items_skipped": "12345",
      "updated_at": "2023-01-01T00:00:00Z",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    },
    "name": "example name",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "region": "example string",
    "tags": [
      "example string"
    ],
    "updated_at": "2023-01-01T00:00:00Z",
    "user_id": "12345",
    "uuid": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

Changed in 6 of the 8 revisions of this API.330

  • cb3bf9b214592See the full diff
    • ○

      api tag DigitalOcean-public.v2-new_GradientAI Platform added

      api-tag-added

    • ○

      api tag GradientAI Platform removed

      api-tag-removed

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

  • 9aca3802735e3See the full diff
    • ○

      added the optional property knowledge_base/last_indexing_job/total_items_failed to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property knowledge_base/last_indexing_job/total_items_indexed to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property knowledge_base/last_indexing_job/total_items_skipped to the response with the 200 status

      response-optional-property-added

  • f8e8c290636c8See the full diff
    • ○

      api operation id get_knowledge_base removed and replaced with genai_get_knowledge_base

      api-operation-id-removed

    • ○

      the endpoint scheme security bearer_auth was added to the API

      api-security-added

    • ○

      api tag GradientAI Platform added

      api-tag-added

    • ○

      api tag GenAIAPI removed

      api-tag-removed

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

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

  • 5fc9af728e8238See the full diff
    • ●

      the optional response header ratelimit-limit removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header ratelimit-remaining removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header ratelimit-reset removed for the status 200

      optional-response-header-removed

    • ○

      api operation id genai_get_knowledge_base removed and replaced with get_knowledge_base

      api-operation-id-removed

    • ○

      the endpoint scheme security bearer_auth was removed from the API

      api-security-removed

    • ○

      api tag GenAIAPI added

      api-tag-added

    • ○

      api tag GradientAI Platform removed

      api-tag-removed

    • ○

      removed the non-success response with the status 401

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 404

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 429

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

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

  • f8e8c290636c8See the full diff
    • ○

      api operation id get_knowledge_base removed and replaced with genai_get_knowledge_base

      api-operation-id-removed

    • ○

      the endpoint scheme security bearer_auth was added to the API

      api-security-added

    • ○

      api tag GradientAI Platform added

      api-tag-added

    • ○

      api tag GenAIAPI removed

      api-tag-removed

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

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

  • e8b3cbc80e181See the full diff
    • ○

      added the optional property knowledge_base/last_indexing_job/status to the response with the 200 status

      response-optional-property-added