Business

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

GET
POST
GET
PATCH
DELETE
POST
GET

List all business knowledge sources

Required API key scopes

business_knowledge:read

Query parameters

  • limit
    integer
  • offset
    integer

Response


Example request

GET /api/projects/:project_id/business_knowledge/sources
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/business_knowledge/sources/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "team_id": 0,
      "name": "string",
      "source_type": "text",
      "status": "pending",
      "error_message": "string",
      "document_count": 0,
      "chunk_count": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "source_url": "http://example.com",
      "last_refresh_at": "2019-08-24T14:15:22Z",
      "last_refresh_status": "success",
      "last_refresh_error": "string",
      "refresh_interval": "manual",
      "next_refresh_at": "string",
      "has_unsafe_documents": true,
      "crawl_mode": "single",
      "crawl_config": null,
      "original_filename": "string",
      "file_content_type": "string",
      "file_size_bytes": 0
    }
  ]
}

Create business knowledge sources

Required API key scopes

business_knowledge:write

Request parameters

  • name
    string
  • text
    string

Response


Example request

POST /api/projects/:project_id/business_knowledge/sources
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/business_knowledge/sources/\
	-d name="string",\
	-d text="string"

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "source_type": "text",
  "status": "pending",
  "error_message": "string",
  "document_count": 0,
  "chunk_count": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "source_url": "http://example.com",
  "last_refresh_at": "2019-08-24T14:15:22Z",
  "last_refresh_status": "success",
  "last_refresh_error": "string",
  "refresh_interval": "manual",
  "next_refresh_at": "string",
  "has_unsafe_documents": true,
  "crawl_mode": "single",
  "crawl_config": null,
  "original_filename": "string",
  "file_content_type": "string",
  "file_size_bytes": 0
}

Retrieve business knowledge sources

Required API key scopes

business_knowledge:read

Path parameters

  • id
    string

Response


Example request

GET /api/projects/:project_id/business_knowledge/sources/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/business_knowledge/sources/:id/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "source_type": "text",
  "status": "pending",
  "error_message": "string",
  "document_count": 0,
  "chunk_count": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "source_url": "http://example.com",
  "last_refresh_at": "2019-08-24T14:15:22Z",
  "last_refresh_status": "success",
  "last_refresh_error": "string",
  "refresh_interval": "manual",
  "next_refresh_at": "string",
  "has_unsafe_documents": true,
  "crawl_mode": "single",
  "crawl_config": null,
  "original_filename": "string",
  "file_content_type": "string",
  "file_size_bytes": 0
}

Update business knowledge sources

Required API key scopes

business_knowledge:write

Path parameters

  • id
    string

Request parameters

  • name
    string
  • text
    string

Response


Example request

PATCH /api/projects/:project_id/business_knowledge/sources/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/business_knowledge/sources/:id/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "source_type": "text",
  "status": "pending",
  "error_message": "string",
  "document_count": 0,
  "chunk_count": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "source_url": "http://example.com",
  "last_refresh_at": "2019-08-24T14:15:22Z",
  "last_refresh_status": "success",
  "last_refresh_error": "string",
  "refresh_interval": "manual",
  "next_refresh_at": "string",
  "has_unsafe_documents": true,
  "crawl_mode": "single",
  "crawl_config": null,
  "original_filename": "string",
  "file_content_type": "string",
  "file_size_bytes": 0
}

Delete business knowledge sources

Required API key scopes

business_knowledge:write

Path parameters

  • id
    string

Example request

DELETE /api/projects/:project_id/business_knowledge/sources/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/business_knowledge/sources/:id/

Example response

Status 204 No response body

Create business knowledge sources refresh

Path parameters

  • id
    string

Request parameters

    Response


    Example request

    POST /api/projects/:project_id/business_knowledge/sources/:id/refresh
    export POSTHOG_PERSONAL_API_KEY=[your personal api key]
    curl 
        -H 'Content-Type: application/json'\
        -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
        <ph_app_host>/api/projects/:project_id/business_knowledge/sources/:id/refresh/\
    	-d team_id="integer"

    Example response

    Status 200
    RESPONSE
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "team_id": 0,
      "name": "string",
      "source_type": "text",
      "status": "pending",
      "error_message": "string",
      "document_count": 0,
      "chunk_count": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "source_url": "http://example.com",
      "last_refresh_at": "2019-08-24T14:15:22Z",
      "last_refresh_status": "success",
      "last_refresh_error": "string",
      "refresh_interval": "manual",
      "next_refresh_at": "string",
      "has_unsafe_documents": true,
      "crawl_mode": "single",
      "crawl_config": null,
      "original_filename": "string",
      "file_content_type": "string",
      "file_size_bytes": 0
    }

    Retrieve business knowledge sources text

    Path parameters

    • id
      string

    Example request

    GET /api/projects/:project_id/business_knowledge/sources/:id/text
    export POSTHOG_PERSONAL_API_KEY=[your personal api key]
    curl \
        -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
        <ph_app_host>/api/projects/:project_id/business_knowledge/sources/:id/text/

    Example response

    Status 200

    Community questions

    Questions about this page? or post a community question.