Pular navegação
Base de conhecimento

Acesso e integrações

Tokens de acesso e webhooks.

Access tokens

Criar token

POST {{baseHost}}/v1/access-tokens

Cria um token de acesso para o workspace. Guarde o valor devolvido — ele é exibido uma única vez.

Request body (json)
{  "name": "token1",  "scope": {    "api": {      "permissions": [        "read",        "write",        "delete"      ]    },    "upload": {      "permissions": []    }  }}

Criar token de upload para um projeto específico

POST {{baseHost}}/v1/access-tokens

Cria um token de acesso apenas para upload, restrito a um único projeto.

Request body (json)
{  "name": "token for upload to project",  "scope": {    "upload": {      "entities": [        {          "id": "<UUID>",          "permissions": [            "read",            "write",            "delete"          ]        }      ],      "permissions": []    }  }}
Responses
{  "data": {    "id": "...",    "name": "token for upload to project",    "workspace_id": "....",    "scope": {      "upload": {        "permissions": [],        "entities": [          {            "id": "<UUID>",            "permissions": [              "read",              "write",              "delete"            ]          }        ]      }    }  }}

Lista de tokens

GET {{baseHost}}/v1/access-tokens

Retorna a lista de tokens de acesso. Os resultados são paginados e podem ser filtrados por parâmetros de consulta.

Responses
{  "meta": {    "offset": 0,    "limit": 10,    "total": 16,    "total_count": 0,    "order": {      "name": "asc"    },    "parent_id": null  },  "data": [    {      "id": "<UUID>",      "name": "Koltin-Kinescope-Player",      "workspace_id": "<UUID>",      "scope": {        "api": {          "permissions": [            "read",            "write",            "delete"          ]        }      }    },    {      "id": "<UUID>",      "name": "Kotlin-Kinescope-Shorts",      "workspace_id": "<UUID>",      "scope": {        "api": {          "permissions": [            "read",            "write",            "delete"          ]        }      }    },    {      "id": "<UUID>",      "name": "Restream",      "workspace_id": "<UUID>",      "scope": {        "api": {          "permissions": [            "read",            "write",            "delete"          ]        },        "upload": {          "permissions": []        }      }    },    {      "id": "<UUID>",      "name": "sadfasdf",      "workspace_id": "<UUID>",      "scope": {        "api": {          "permissions": [            "read",            "write",            "delete"          ]        }      }    },    {      "id": "<UUID>",      "name": "sdfsdfsdf",      "workspace_id": "<UUID>",      "scope": {        "api": {          "permissions": [            "read",            "write",            "delete"          ]        },        "upload": {          "permissions": []        }      }    },    {      "id": "<UUID>",      "name": "Speak",      "workspace_id": "<UUID>",      "scope": {        "api": {          "permissions": [            "read",            "write",            "delete"          ]        },        "upload": {          "permissions": []        }      }    },    {      "id": "<UUID>",      "name": "Speak LiveKit Test Token",      "workspace_id": "<UUID>",      "scope": {        "api": {          "permissions": [            "read",            "write",            "delete"          ]        },        "upload": {          "permissions": []        }      }    },    {      "id": "<UUID>",      "name": "Speak Room",      "workspace_id": "<UUID>",      "scope": {        "api": {          "permissions": [            "read",            "write",            "delete"          ]        },        "upload": {          "permissions": []        }      }    },    {      "id": "<UUID>",      "name": "Test MCP",      "workspace_id": "<UUID>",      "scope": {        "api": {          "permissions": [            "read",            "write",            "delete"          ]        }      }    },    {      "id": "<UUID>",      "name": "Timofey is the best",      "workspace_id": "<UUID>",      "scope": {        "api": {          "permissions": [            "read",            "write",            "delete"          ]        },        "upload": {          "permissions": []        }      }    }  ]}

Obter token

GET {{baseHost}}/v1/access-tokens/:token_id

Retorna os dados de um token de acesso pelo seu identificador único.

Responses
{  "data": {    "id": "<UUID>",    "name": "Koltin-Kinescope-Player",    "workspace_id": "<UUID>",    "scope": {      "api": {        "permissions": [          "read",          "write",          "delete"        ]      }    }  }}
{  "error": {    "code": 400404,    "message": "not found"  }}

Excluir token

DELETE {{baseHost}}/v1/access-tokens/:token_id

Exclui o token de acesso permanentemente. A ação não pode ser desfeita.

Webhooks

https://kinescope.notion.site/886ae0bc2ac14a149e71cf0ffec3881d?pvs=4

Listar webhooks

GET {{baseHost}}/v1/webhooks

Retorna a lista de webhooks. Os resultados são paginados e podem ser filtrados por parâmetros de consulta.

Responses
{  "meta": {    "pagination": {      "page": 1,      "per_page": 10,      "total": 1    },    "order": {      "name": "asc"    }  },  "data": [    {      "id": "<UUID>",      "name": "doc_test_webhook_1776899949",      "endpoint": "https://example.com/kinescope-doc-test",      "login": "",      "password": "<REDACTED>",      "events": [        "media.update.status"      ],      "created_at": "2026-04-22T23:19:10.316926Z",      "updated_at": null,      "deleted_at": null    }  ]}

Criar webhook

POST {{baseHost}}/v1/webhooks

Assina um ou mais tipos de evento. O endpoint configurado passa a receber requisições POST assinadas quando esses eventos acontecem.

Request body (json)
{  "name": "webhook1",  "endpoint": "https://example.io/kinescope/webhook",  "login": "",  "password": "",  "events": [    "media.update.status"  ]}
Responses
{  "data": {    "id": "<UUID>",    "name": "doc_test_webhook_1776899949",    "endpoint": "https://example.com/kinescope-doc-test",    "login": "",    "password": "<REDACTED>",    "events": [      "media.update.status"    ],    "created_at": "2026-04-22T23:19:10.316926Z",    "updated_at": null,    "deleted_at": null  }}

Atualizar webhook

PUT {{baseHost}}/v1/webhooks/:webhook_id

Atualiza o webhook (URL, credenciais HTTP Basic, eventos assinados).

Request body (json)
{  "name": "webhook1_edit2",  "endpoint": "https://example.io/kin/webhook",  "login": "123",  "password": "2222",  "events": [    "media.update.status"  ]}
Responses
{  "data": {    "id": "<UUID>",    "name": "doc_test_webhook_1776899949_upd",    "endpoint": "https://example.com/kinescope-doc-test",    "login": "",    "password": "<REDACTED>",    "events": [      "media.update.status"    ],    "created_at": "2026-04-22T23:19:10.316926Z",    "updated_at": "2026-04-22T23:19:11.087179Z",    "deleted_at": null  }}

Excluir webhook

DELETE {{baseHost}}/v1/webhooks/:webhook_id

Exclui o webhook permanentemente. A ação não pode ser desfeita.

Responses
{  "data": {    "success": true  }}