Bold VideoDocs

Viewers

Get a viewer's memory

GET
/api/v1/viewers/{viewer_id}/memory

Authorization

api_token
AuthorizationBearer <token>

API token provided by BOLD Admin

In: header

Path Parameters

viewer_id*string

Viewer UUID

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://app.boldvideo.io/api/v1/viewers/string/memory"
{
  "data": {
    "content": "Situation & goals:\n- Runs a 3-person agency scaling to $1M ARR.",
    "conversations_count": 4,
    "enabled": true,
    "last_conversation_at": "2019-08-24T14:15:22Z",
    "last_distilled_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}

Update a viewer's memory settings

PATCH
/api/v1/viewers/{viewer_id}/memory

Authorization

api_token
AuthorizationBearer <token>

API token provided by BOLD Admin

In: header

Path Parameters

viewer_id*string

Viewer UUID

Request Body

application/json

Memory settings

memory*

Memory settings to update.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://app.boldvideo.io/api/v1/viewers/string/memory" \  -H "Content-Type: application/json" \  -d '{    "memory": {      "enabled": false    }  }'
{
  "data": {
    "content": "Situation & goals:\n- Runs a 3-person agency scaling to $1M ARR.",
    "conversations_count": 4,
    "enabled": true,
    "last_conversation_at": "2019-08-24T14:15:22Z",
    "last_distilled_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}

Clear a viewer's memory

DELETE
/api/v1/viewers/{viewer_id}/memory

Authorization

api_token
AuthorizationBearer <token>

API token provided by BOLD Admin

In: header

Path Parameters

viewer_id*string

Viewer UUID

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://app.boldvideo.io/api/v1/viewers/string/memory"
Empty
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}

Look up a viewer

GET
/api/v1/viewers/lookup

Authorization

api_token
AuthorizationBearer <token>

API token provided by BOLD Admin

In: header

Query Parameters

external_id?string

External ID from course platform

email?string

Viewer email

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.boldvideo.io/api/v1/viewers/lookup"
{
  "data": {
    "avatar_url": "https://example.com/avatars/john.jpg",
    "computed_display_name": "John Doe",
    "created_at": "2019-08-24T14:15:22Z",
    "display_name": "Johnny D",
    "email": "john@example.com",
    "external_id": "usr_123abc",
    "first_name": "John",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_admin": false,
    "last_name": "Doe",
    "name": "John Doe",
    "traits": {
      "business_name": "Acme Corp",
      "stage": "growth"
    },
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}

List viewers (paginated)

GET
/api/v1/viewers

Authorization

api_token
AuthorizationBearer <token>

API token provided by BOLD Admin

In: header

Query Parameters

page?integer

Page number (default: 1)

page_size?integer

Items per page (default: 20)

Response Body

application/json

application/json

application/json

curl -X GET "https://app.boldvideo.io/api/v1/viewers?page=1&page_size=20"
{
  "data": [
    {
      "avatar_url": "https://example.com/avatars/john.jpg",
      "computed_display_name": "John Doe",
      "created_at": "2019-08-24T14:15:22Z",
      "display_name": "Johnny D",
      "email": "john@example.com",
      "external_id": "usr_123abc",
      "first_name": "John",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "is_admin": false,
      "last_name": "Doe",
      "name": "John Doe",
      "traits": {
        "business_name": "Acme Corp",
        "stage": "growth"
      },
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 20,
    "total_entries": 47,
    "total_pages": 3
  }
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}

Create a viewer

POST
/api/v1/viewers

Authorization

api_token
AuthorizationBearer <token>

API token provided by BOLD Admin

In: header

Request Body

application/json

Viewer parameters

avatar_url?string|null

URL to avatar image

Formaturi
display_name?string|null

Preferred display name

email?string

Viewer email

Formatemail
external_id?string|null

External ID from course platform

first_name?string|null

First name

last_name?string|null

Last name

name*string

Viewer name

traits?|null

Custom traits map

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://app.boldvideo.io/api/v1/viewers" \  -H "Content-Type: application/json" \  -d '{    "name": "John Doe"  }'
{
  "data": {
    "avatar_url": "https://example.com/avatars/john.jpg",
    "computed_display_name": "John Doe",
    "created_at": "2019-08-24T14:15:22Z",
    "display_name": "Johnny D",
    "email": "john@example.com",
    "external_id": "usr_123abc",
    "first_name": "John",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_admin": false,
    "last_name": "Doe",
    "name": "John Doe",
    "traits": {
      "business_name": "Acme Corp",
      "stage": "growth"
    },
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}

Get a viewer

GET
/api/v1/viewers/{id}

Authorization

api_token
AuthorizationBearer <token>

API token provided by BOLD Admin

In: header

Path Parameters

id*string

Viewer UUID

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://app.boldvideo.io/api/v1/viewers/string"
{
  "data": {
    "avatar_url": "https://example.com/avatars/john.jpg",
    "computed_display_name": "John Doe",
    "created_at": "2019-08-24T14:15:22Z",
    "display_name": "Johnny D",
    "email": "john@example.com",
    "external_id": "usr_123abc",
    "first_name": "John",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_admin": false,
    "last_name": "Doe",
    "name": "John Doe",
    "traits": {
      "business_name": "Acme Corp",
      "stage": "growth"
    },
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}

Update a viewer

PATCH
/api/v1/viewers/{id}

Authorization

api_token
AuthorizationBearer <token>

API token provided by BOLD Admin

In: header

Path Parameters

id*string

Viewer UUID

Request Body

application/json

Viewer parameters

avatar_url?string|null

URL to avatar image

Formaturi
display_name?string|null

Preferred display name

email?string

Viewer email

Formatemail
external_id?string|null

External ID from course platform

first_name?string|null

First name

last_name?string|null

Last name

name?string

Viewer name

traits?|null

Custom traits map

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://app.boldvideo.io/api/v1/viewers/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "avatar_url": "https://example.com/avatars/john.jpg",
    "computed_display_name": "John Doe",
    "created_at": "2019-08-24T14:15:22Z",
    "display_name": "Johnny D",
    "email": "john@example.com",
    "external_id": "usr_123abc",
    "first_name": "John",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_admin": false,
    "last_name": "Doe",
    "name": "John Doe",
    "traits": {
      "business_name": "Acme Corp",
      "stage": "growth"
    },
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}

Delete a viewer

DELETE
/api/v1/viewers/{id}

Authorization

api_token
AuthorizationBearer <token>

API token provided by BOLD Admin

In: header

Path Parameters

id*string

Viewer UUID

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://app.boldvideo.io/api/v1/viewers/string"
Empty
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}

Update a viewer

PUT
/api/v1/viewers/{id}

Authorization

api_token
AuthorizationBearer <token>

API token provided by BOLD Admin

In: header

Path Parameters

id*string

Viewer UUID

Request Body

application/json

Viewer parameters

avatar_url?string|null

URL to avatar image

Formaturi
display_name?string|null

Preferred display name

email?string

Viewer email

Formatemail
external_id?string|null

External ID from course platform

first_name?string|null

First name

last_name?string|null

Last name

name?string

Viewer name

traits?|null

Custom traits map

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://app.boldvideo.io/api/v1/viewers/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "avatar_url": "https://example.com/avatars/john.jpg",
    "computed_display_name": "John Doe",
    "created_at": "2019-08-24T14:15:22Z",
    "display_name": "Johnny D",
    "email": "john@example.com",
    "external_id": "usr_123abc",
    "first_name": "John",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_admin": false,
    "last_name": "Doe",
    "name": "John Doe",
    "traits": {
      "business_name": "Acme Corp",
      "stage": "growth"
    },
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}
{
  "code": "not_found",
  "message": "Video not found",
  "retryable": false,
  "type": "error"
}

AI Conversations

Previous Page

Progress

Next Page