Business

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

Endpoints

`GET`
`PATCH`
`GET`
`POST`
`GET`
`PATCH`
`DELETE`
`GET`
`POST`
`GET`

← Previous page

Retrieve business knowledge settings

Fetch whether this project learns from resolved support tickets, and whether Support is on in this environment.

Required API key scopes

business_knowledge:read

Response

Example request

GET /api/projects/:project_id/business_knowledge/settings
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/settings/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/business_knowledge/settings/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 The team's Business knowledge learning settings.

RESPONSE
{
  "learn_from_support_enabled": true,
  "support_enabled": true
}

Update business knowledge settings

Partially update Business knowledge learning settings. Enabling learn-from-support requires Support to be on in this environment.

Required API key scopes

business_knowledge:write

Request parameters

learn_from_support_enabled
boolean

Response

Example request

PATCH /api/projects/:project_id/business_knowledge/settings
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/settings/\
	-d learn_from_support_enabled="boolean"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/business_knowledge/settings/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"learn_from_support_enabled": "boolean"
	}
).json()

Example response

Status 200 The updated Business knowledge learning settings.

RESPONSE
{
  "learn_from_support_enabled": true,
  "support_enabled": true
}

Status 400 Learn from support cannot be enabled while Support is off.

List all business knowledge sources

Required API key scopes

business_knowledge:read

Query parameters

added_by
string
One of: "human""learned"
limit
integer
offset
integer
search
string
source_type
string
One of: "file""text""url"

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/business_knowledge/sources/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

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",
      "is_generated": true,
      "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,
      "embedding_status": "pending",
      "learned_from_ticket_number": 0,
      "learned_from_ticket_url": "http://example.com",
      "crawl_mode": "single",
      "crawl_config": null,
      "original_filename": "string",
      "file_content_type": "string",
      "file_size_bytes": 0,
      "always_include": true
    }
  ]
}

Create business knowledge sources

Required API key scopes

business_knowledge:write

Request parameters

name
string
text
string
always_include
boolean
Default: false

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/business_knowledge/sources/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string",
		"text": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "source_type": "text",
  "is_generated": true,
  "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,
  "embedding_status": "pending",
  "learned_from_ticket_number": 0,
  "learned_from_ticket_url": "http://example.com",
  "crawl_mode": "single",
  "crawl_config": null,
  "original_filename": "string",
  "file_content_type": "string",
  "file_size_bytes": 0,
  "always_include": true
}

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/business_knowledge/sources/{business_knowledge-2_id}/".format(
        project_id=project_id,
		business_knowledge-2_id="<the business knowledge-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "source_type": "text",
  "is_generated": true,
  "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,
  "embedding_status": "pending",
  "learned_from_ticket_number": 0,
  "learned_from_ticket_url": "http://example.com",
  "crawl_mode": "single",
  "crawl_config": null,
  "original_filename": "string",
  "file_content_type": "string",
  "file_size_bytes": 0,
  "always_include": true
}

Update business knowledge sources

Required API key scopes

business_knowledge:write

Path parameters

id
string

Request parameters

name
string
text
string
always_include
boolean

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/business_knowledge/sources/{business_knowledge-2_id}/".format(
        project_id=project_id,
		business_knowledge-2_id="<the business knowledge-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "source_type": "text",
  "is_generated": true,
  "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,
  "embedding_status": "pending",
  "learned_from_ticket_number": 0,
  "learned_from_ticket_url": "http://example.com",
  "crawl_mode": "single",
  "crawl_config": null,
  "original_filename": "string",
  "file_content_type": "string",
  "file_size_bytes": 0,
  "always_include": true
}

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/business_knowledge/sources/{business_knowledge-2_id}/".format(
        project_id=project_id,
		business_knowledge-2_id="<the business knowledge-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

List all business knowledge sources documents

Required API key scopes

business_knowledge:read

Path parameters

id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/business_knowledge/sources/:id/documents
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/documents/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/business_knowledge/sources/{business_knowledge-2_id}/documents/".format(
        project_id=project_id,
		business_knowledge-2_id="<the business knowledge-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

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",
      "url": "http://example.com",
      "title": "string",
      "safety_verdict": "unknown"
    }
  ]
}

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/business_knowledge/sources/{business_knowledge-2_id}/refresh/".format(
        project_id=project_id,
		business_knowledge-2_id="<the business knowledge-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"team_id": "integer"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "source_type": "text",
  "is_generated": true,
  "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,
  "embedding_status": "pending",
  "learned_from_ticket_number": 0,
  "learned_from_ticket_url": "http://example.com",
  "crawl_mode": "single",
  "crawl_config": null,
  "original_filename": "string",
  "file_content_type": "string",
  "file_size_bytes": 0,
  "always_include": true
}

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/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/business_knowledge/sources/{business_knowledge-2_id}/text/".format(
        project_id=project_id,
		business_knowledge-2_id="<the business knowledge-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

← Previous page