Environments-7

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

RESTful API for managing desktop meeting recordings.

Standard CRUD operations plus transcript management as a subresource.

Endpoints

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

List all environments desktop recordings

Required API key scopes

desktop_recording:read

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

Response


Example request

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

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": 0,
      "created_by": 0,
      "sdk_upload_id": "7276e323-83a6-4edf-893f-03d54726eb02",
      "recall_recording_id": "08cce185-c34b-4d4f-bb61-49c99f8ccc30",
      "platform": "zoom",
      "meeting_title": "string",
      "meeting_url": "http://example.com",
      "duration_seconds": -2147483648,
      "status": "recording",
      "notes": "string",
      "error_message": "string",
      "video_url": "http://example.com",
      "video_size_bytes": -9223372036854776000,
      "participants": [
        "string"
      ],
      "transcript_text": "string",
      "transcript_segments": [
        {
          "timestamp": 0.1,
          "speaker": "string",
          "text": "string",
          "confidence": 0.1,
          "is_final": true
        }
      ],
      "summary": "string",
      "extracted_tasks": [
        {
          "title": "string",
          "description": "string",
          "assignee": "string"
        }
      ],
      "tasks_generated_at": "2019-08-24T14:15:22Z",
      "summary_generated_at": "2019-08-24T14:15:22Z",
      "started_at": "2019-08-24T14:15:22Z",
      "completed_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create environments desktop recordings

Create a new recording and get Recall.ai upload token for the desktop SDK

Required API key scopes

desktop_recording:write

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

  • platform
    Default: desktop_audio

    Meeting platform being recorded

    • zoom - zoom
    • teams - teams
    • meet - meet
    • desktop_audio - desktop_audio
    • slack - slack

Response


Example request

POST /api/environments/:project_id/desktop_recordings
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/environments/:project_id/desktop_recordings/\
	-d platform=undefined

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team": 0,
  "created_by": 0,
  "sdk_upload_id": "7276e323-83a6-4edf-893f-03d54726eb02",
  "recall_recording_id": "08cce185-c34b-4d4f-bb61-49c99f8ccc30",
  "platform": "zoom",
  "meeting_title": "string",
  "meeting_url": "http://example.com",
  "duration_seconds": -2147483648,
  "status": "recording",
  "notes": "string",
  "error_message": "string",
  "video_url": "http://example.com",
  "video_size_bytes": -9223372036854776000,
  "participants": [
    "string"
  ],
  "transcript_text": "string",
  "transcript_segments": [
    {
      "timestamp": 0.1,
      "speaker": "string",
      "text": "string",
      "confidence": 0.1,
      "is_final": true
    }
  ],
  "summary": "string",
  "extracted_tasks": [
    {
      "title": "string",
      "description": "string",
      "assignee": "string"
    }
  ],
  "tasks_generated_at": "2019-08-24T14:15:22Z",
  "summary_generated_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "upload_token": "string"
}

Retrieve environments desktop recordings

Required API key scopes

desktop_recording:read

Path parameters

  • id
    string

    A UUID string identifying this desktop recording.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team": 0,
  "created_by": 0,
  "sdk_upload_id": "7276e323-83a6-4edf-893f-03d54726eb02",
  "recall_recording_id": "08cce185-c34b-4d4f-bb61-49c99f8ccc30",
  "platform": "zoom",
  "meeting_title": "string",
  "meeting_url": "http://example.com",
  "duration_seconds": -2147483648,
  "status": "recording",
  "notes": "string",
  "error_message": "string",
  "video_url": "http://example.com",
  "video_size_bytes": -9223372036854776000,
  "participants": [
    "string"
  ],
  "transcript_text": "string",
  "transcript_segments": [
    {
      "timestamp": 0.1,
      "speaker": "string",
      "text": "string",
      "confidence": 0.1,
      "is_final": true
    }
  ],
  "summary": "string",
  "extracted_tasks": [
    {
      "title": "string",
      "description": "string",
      "assignee": "string"
    }
  ],
  "tasks_generated_at": "2019-08-24T14:15:22Z",
  "summary_generated_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update environments desktop recordings

Required API key scopes

desktop_recording:write

Path parameters

  • id
    string

    A UUID string identifying this desktop recording.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

  • recall_recording_id
    string
  • platform
  • meeting_title
    string
  • meeting_url
    string
  • duration_seconds
    integer
  • status
  • notes
    string
  • error_message
    string
  • video_url
    string
  • video_size_bytes
    integer
  • participants
    array

    List of participant names

  • transcript_segments
    Click to open
    array

    Transcript segments with timestamps

  • summary
    string
  • extracted_tasks
    Click to open
    array

    AI-extracted tasks from transcript

  • tasks_generated_at
    string
  • summary_generated_at
    string
  • started_at
    string
  • completed_at
    string

Response


Example request

PATCH /api/environments/:project_id/desktop_recordings/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/desktop_recordings/:id/\
	-d team="integer"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team": 0,
  "created_by": 0,
  "sdk_upload_id": "7276e323-83a6-4edf-893f-03d54726eb02",
  "recall_recording_id": "08cce185-c34b-4d4f-bb61-49c99f8ccc30",
  "platform": "zoom",
  "meeting_title": "string",
  "meeting_url": "http://example.com",
  "duration_seconds": -2147483648,
  "status": "recording",
  "notes": "string",
  "error_message": "string",
  "video_url": "http://example.com",
  "video_size_bytes": -9223372036854776000,
  "participants": [
    "string"
  ],
  "transcript_text": "string",
  "transcript_segments": [
    {
      "timestamp": 0.1,
      "speaker": "string",
      "text": "string",
      "confidence": 0.1,
      "is_final": true
    }
  ],
  "summary": "string",
  "extracted_tasks": [
    {
      "title": "string",
      "description": "string",
      "assignee": "string"
    }
  ],
  "tasks_generated_at": "2019-08-24T14:15:22Z",
  "summary_generated_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete environments desktop recordings

Required API key scopes

desktop_recording:write

Path parameters

  • id
    string

    A UUID string identifying this desktop recording.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Example request

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

Example response

Status 204 No response body

Create environments desktop recordings append segments

Append transcript segments (supports batched real-time streaming)

Required API key scopes

desktop_recording:write

Path parameters

  • id
    string

    A UUID string identifying this desktop recording.

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

  • segments
    Click to open
    array

Response


Example request

POST /api/environments/:project_id/desktop_recordings/:id/append_segments
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/environments/:project_id/desktop_recordings/:id/append_segments/\
	-d segments="array"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team": 0,
  "created_by": 0,
  "sdk_upload_id": "7276e323-83a6-4edf-893f-03d54726eb02",
  "recall_recording_id": "08cce185-c34b-4d4f-bb61-49c99f8ccc30",
  "platform": "zoom",
  "meeting_title": "string",
  "meeting_url": "http://example.com",
  "duration_seconds": -2147483648,
  "status": "recording",
  "notes": "string",
  "error_message": "string",
  "video_url": "http://example.com",
  "video_size_bytes": -9223372036854776000,
  "participants": [
    "string"
  ],
  "transcript_text": "string",
  "transcript_segments": [
    {
      "timestamp": 0.1,
      "speaker": "string",
      "text": "string",
      "confidence": 0.1,
      "is_final": true
    }
  ],
  "summary": "string",
  "extracted_tasks": [
    {
      "title": "string",
      "description": "string",
      "assignee": "string"
    }
  ],
  "tasks_generated_at": "2019-08-24T14:15:22Z",
  "summary_generated_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve environments endpoints

List all endpoints for the team.

Required API key scopes

endpoint:read

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Example request

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

Example response

Status 200 No response body

Create environments endpoints

Create a new endpoint

Required API key scopes

endpoint:write

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

  • cache_age_seconds
    number
  • description
    string
  • is_active
    boolean
  • name
    string
  • query

Example request

POST /api/environments/:project_id/endpoints
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/environments/:project_id/endpoints/\
	-d cache_age_seconds="number"

Example response

Status 201 No response body

Retrieve environments endpoints retrieve

Retrieve an endpoint.

Required API key scopes

endpoint:read

Path parameters

  • name
    string

    URL-safe name for the endpoint

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Example request

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

Example response

Status 200 No response body

Update environments endpoints

Path parameters

  • name
    string

    URL-safe name for the endpoint

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Example request

PATCH /api/environments/:project_id/endpoints/:name
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/endpoints/:name/

Example response

Status 200 No response body

Delete environments endpoints

Delete a endpoint.

Required API key scopes

endpoint:write

Path parameters

  • name
    string

    URL-safe name for the endpoint

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Example request

DELETE /api/environments/:project_id/endpoints/:name
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/endpoints/:name/

Example response

Status 204 No response body

Retrieve environments endpoints run

Update an existing endpoint. Parameters are optional.

Required API key scopes

endpoint:read

Path parameters

  • name
    string

    URL-safe name for the endpoint

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Example request

GET /api/environments/:project_id/endpoints/:name/run
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/endpoints/:name/run/

Example response

Status 200 No response body

Create environments endpoints run

Update an existing endpoint. Parameters are optional.

Required API key scopes

endpoint:read

Path parameters

  • name
    string

    URL-safe name for the endpoint

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

  • client_query_id
    string

    Client provided query ID. Can be used to retrieve the status or cancel the query.

  • filters_override
  • query_override
    object
  • refresh
    Default: blocking

    Whether results should be calculated sync or async, and how much to rely on the cache:

    • 'blocking' - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache
    • 'async' - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache
    • 'lazy_async' - kick off background calculation, UNLESS there are somewhat fresh results in the cache
    • 'force_blocking' - calculate synchronously, even if fresh results are already cached
    • 'force_async' - kick off background calculation, even if fresh results are already cached
    • 'force_cache' - return cached data or a cache miss; always completes immediately as it never calculates Background calculation can be tracked using the query_status response field.
  • variables_override
    object
  • variables_values
    object

Example request

POST /api/environments/:project_id/endpoints/:name/run
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/environments/:project_id/endpoints/:name/run/\
	-d client_query_id="string"

Example response

Status 200 No response body

Create environments endpoints last execution times

Get the last execution times in the past 6 monthsfor multiple endpoints.

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

  • names
    array

Response


Example request

POST /api/environments/:project_id/endpoints/last_execution_times
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/environments/:project_id/endpoints/last_execution_times/\
	-d names="array"

Example response

Status 200
RESPONSE
{
  "query_status": {
    "complete": false,
    "dashboard_id": null,
    "end_time": null,
    "error": false,
    "error_message": null,
    "expiration_time": null,
    "id": "string",
    "insight_id": null,
    "labels": null,
    "pickup_time": null,
    "query_async": true,
    "query_progress": {
      "active_cpu_time": 0,
      "bytes_read": 0,
      "estimated_rows_total": 0,
      "rows_read": 0,
      "time_elapsed": 0
    },
    "results": null,
    "start_time": null,
    "task_id": null,
    "team_id": 0
  }
}

List all environments error tracking assignment rules

Required API key scopes

error_tracking:read

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

Response


Example request

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

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",
      "filters": null,
      "assignee": "string",
      "order_key": -2147483648,
      "disabled_data": null
    }
  ]
}

List all environments error tracking assignment rules

Required API key scopes

error_tracking:read

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

Response


Example request

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

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",
      "filters": null,
      "assignee": "string",
      "order_key": -2147483648,
      "disabled_data": null
    }
  ]
}

Create environments error tracking assignment rules

Required API key scopes

error_tracking:write

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

  • filters
  • order_key
    integer
  • disabled_data

Response


Example request

POST /api/environments/:project_id/error_tracking/assignment_rules
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/environments/:project_id/error_tracking/assignment_rules/\
	-d filters=undefined,\
	-d order_key="integer"

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "assignee": "string",
  "order_key": -2147483648,
  "disabled_data": null
}

Create environments error tracking assignment rules

Required API key scopes

error_tracking:write

Path parameters

  • project_id
    string

    Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

  • filters
  • order_key
    integer
  • disabled_data

Response


Example request

POST /api/environments/:project_id/error_tracking/assignment_rules
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/environments/:project_id/error_tracking/assignment_rules/\
	-d filters=undefined,\
	-d order_key="integer"

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "assignee": "string",
  "order_key": -2147483648,
  "disabled_data": null
}
Next page →

Community questions

Questions about this page? or post a community question.