Solicitações de arquivo - Base de conhecimento

File requests

Listar solicitações de arquivo

GET {{baseHost}}/v1/file-requests

Retorna a lista de solicitações de arquivo. Os resultados são paginados e podem ser filtrados por parâmetros de consulta.

Responses

{  "meta": {    "offset": 0,    "limit": 10,    "total": 7,    "total_count": 0,    "order": {      "title": "asc"    },    "parent_id": null  },  "data": [    {      "id": "<UUID>",      "workspace_id": "<UUID>",      "title": "test",      "description": "",      "uploading_location_id": "<UUID>",      "expired_at": null,      "created_by": "Timofey",      "created_at": "2024-11-15T07:39:16.772084Z",      "updated_at": null,      "archived_at": null,      "user_count": 2,      "media_count": 3,      "url": "https://kinescope.io/request/<UUID>"    },    {      "id": "<UUID>",      "workspace_id": "<UUID>",      "title": "Título de exemplo",      "description": "Descrição de exemplo",      "uploading_location_id": "<UUID>",      "expired_at": null,      "created_by": "Alexander Pavlychev",      "created_at": "2025-11-20T09:04:12.850561Z",      "updated_at": null,      "archived_at": null,      "user_count": 1,      "media_count": 1,      "url": "https://kinescope.io/request/<UUID>"    },    {      "id": "<UUID>",      "workspace_id": "<UUID>",      "title": "Para o palestrante número um",      "description": "enviamos arquivos para uma pasta específica",      "uploading_location_id": "<UUID>",      "expired_at": null,      "created_by": "Igor",      "created_at": "2021-11-11T19:10:23.209681Z",      "updated_at": "2022-03-24T13:20:20.317128Z",      "archived_at": null,      "user_count": 10,      "media_count": 13,      "url": "https://kinescope.io/request/<UUID>"    },    {      "id": "<UUID>",      "workspace_id": "<UUID>",      "title": "Título provisório",      "description": "Descrição provisória",      "uploading_location_id": "<UUID>",      "expired_at": null,      "created_by": "Alexander Pavlychev",      "created_at": "2024-09-12T07:39:47.404116Z",      "updated_at": null,      "archived_at": null,      "user_count": 0,      "media_count": 0,      "url": "https://kinescope.io/request/<UUID>"    },    {      "id": "<UUID>",      "workspace_id": "<UUID>",      "title": "teste",      "description": "",      "uploading_location_id": "<UUID>",      "expired_at": null,      "created_by": "Igor",      "created_at": "2024-05-28T09:24:08.291024Z",      "updated_at": null,      "archived_at": null,      "user_count": 0,      "media_count": 0,      "url": "https://kinescope.io/request/<UUID>"    },    {      "id": "<UUID>",      "workspace_id": "<UUID>",      "title": "teste",      "description": "",      "uploading_location_id": "<UUID>",      "expired_at": null,      "created_by": "Igor",      "created_at": "2022-01-21T15:10:25.15006Z",      "updated_at": null,      "archived_at": null,      "user_count": 0,      "media_count": 0,      "url": "https://kinescope.io/request/<UUID>"    },    {      "id": "<UUID>",      "workspace_id": "<UUID>",      "title": "Teste 2",      "description": "",      "uploading_location_id": "<UUID>",      "expired_at": null,      "created_by": "Igor",      "created_at": "2022-01-21T15:51:37.351205Z",      "updated_at": "2023-11-16T13:06:05.528159Z",      "archived_at": null,      "user_count": 1,      "media_count": 3,      "url": "https://kinescope.io/request/<UUID>"    }  ]}

{
  "meta": {
    "offset": 0,
    "limit": 10,
    "total": 7,
    "total_count": 0,
    "order": {
      "title": "asc"
    },
    "parent_id": null
  },
  "data": [
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "title": "test",
      "description": "",
      "uploading_location_id": "<UUID>",
      "expired_at": null,
      "created_by": "Timofey",
      "created_at": "2024-11-15T07:39:16.772084Z",
      "updated_at": null,
      "archived_at": null,
      "user_count": 2,
      "media_count": 3,
      "url": "https://kinescope.io/request/<UUID>"
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "title": "Título de exemplo",
      "description": "Descrição de exemplo",
      "uploading_location_id": "<UUID>",
      "expired_at": null,
      "created_by": "Alexander Pavlychev",
      "created_at": "2025-11-20T09:04:12.850561Z",
      "updated_at": null,
      "archived_at": null,
      "user_count": 1,
      "media_count": 1,
      "url": "https://kinescope.io/request/<UUID>"
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "title": "Para o palestrante número um",
      "description": "enviamos arquivos para uma pasta específica",
      "uploading_location_id": "<UUID>",
      "expired_at": null,
      "created_by": "Igor",
      "created_at": "2021-11-11T19:10:23.209681Z",
      "updated_at": "2022-03-24T13:20:20.317128Z",
      "archived_at": null,
      "user_count": 10,
      "media_count": 13,
      "url": "https://kinescope.io/request/<UUID>"
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "title": "Título provisório",
      "description": "Descrição provisória",
      "uploading_location_id": "<UUID>",
      "expired_at": null,
      "created_by": "Alexander Pavlychev",
      "created_at": "2024-09-12T07:39:47.404116Z",
      "updated_at": null,
      "archived_at": null,
      "user_count": 0,
      "media_count": 0,
      "url": "https://kinescope.io/request/<UUID>"
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "title": "teste",
      "description": "",
      "uploading_location_id": "<UUID>",
      "expired_at": null,
      "created_by": "Igor",
      "created_at": "2024-05-28T09:24:08.291024Z",
      "updated_at": null,
      "archived_at": null,
      "user_count": 0,
      "media_count": 0,
      "url": "https://kinescope.io/request/<UUID>"
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "title": "teste",
      "description": "",
      "uploading_location_id": "<UUID>",
      "expired_at": null,
      "created_by": "Igor",
      "created_at": "2022-01-21T15:10:25.15006Z",
      "updated_at": null,
      "archived_at": null,
      "user_count": 0,
      "media_count": 0,
      "url": "https://kinescope.io/request/<UUID>"
    },
    {
      "id": "<UUID>",
      "workspace_id": "<UUID>",
      "title": "Teste 2",
      "description": "",
      "uploading_location_id": "<UUID>",
      "expired_at": null,
      "created_by": "Igor",
      "created_at": "2022-01-21T15:51:37.351205Z",
      "updated_at": "2023-11-16T13:06:05.528159Z",
      "archived_at": null,
      "user_count": 1,
      "media_count": 3,
      "url": "https://kinescope.io/request/<UUID>"
    }
  ]
}

curl -X GET \  '{{baseHost}}/v1/file-requests?archived=false' \  -H 'Authorization: Bearer <ACCESS_TOKEN>'

curl -X GET \
  '{{baseHost}}/v1/file-requests?archived=false' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Obter solicitação de arquivo

GET {{baseHost}}/v1/file-requests/:file_request_id

Retorna os dados de uma solicitação de arquivo pelo seu identificador único.

Responses

{  "data": {    "id": "<UUID>",    "workspace_id": "<UUID>",    "title": "test",    "description": "",    "uploading_location_id": "<UUID>",    "expired_at": null,    "created_by": "Timofey",    "created_at": "2024-11-15T07:39:16.772084Z",    "updated_at": null,    "archived_at": null,    "user_count": 2,    "media_count": 3,    "url": "https://kinescope.io/request/<UUID>"  }}

{
  "data": {
    "id": "<UUID>",
    "workspace_id": "<UUID>",
    "title": "test",
    "description": "",
    "uploading_location_id": "<UUID>",
    "expired_at": null,
    "created_by": "Timofey",
    "created_at": "2024-11-15T07:39:16.772084Z",
    "updated_at": null,
    "archived_at": null,
    "user_count": 2,
    "media_count": 3,
    "url": "https://kinescope.io/request/<UUID>"
  }
}

{  "error": {    "code": 400404,    "message": "not found"  }}

{
  "error": {
    "code": 400404,
    "message": "not found"
  }
}

curl -X GET \  '{{baseHost}}/v1/file-requests/:file_request_id' \  -H 'Authorization: Bearer <ACCESS_TOKEN>'

curl -X GET \
  '{{baseHost}}/v1/file-requests/:file_request_id' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Criar solicitação de arquivo

POST {{baseHost}}/v1/file-requests

Cria uma solicitação de arquivo. Em caso de sucesso, retorna o objeto criado.

Campo	Tipo	Descrição
name	string	Nome do evento
type	string	one-time ou recurring
auto_start	boolean	O evento ao vivo fica disponível para o usuário na hora
save_stream	boolean	Depois de terminar, o evento é salvo como vídeo
folder_id	string	ID do projeto/pasta onde salvar o vídeo. Obrigatório se save_stream=true

Request body (json)

{  "title": "Título",  "description": "Descrição",  "uploading_location_id": "aUXVrK41BmeNVwyxQ4at6x",  "expired_at": null}

{
  "title": "Título",
  "description": "Descrição",
  "uploading_location_id": "aUXVrK41BmeNVwyxQ4at6x",
  "expired_at": null
}

Responses

{  "data": {    "id": "4LPmdVVrEVvRBZWh4uAV6K",    "workspace_id": "jjGZ6gbAhANmv461rR9MSM",    "title": "Nome",    "description": "Descrição",    "uploading_location_id": "aUXVrK41BmeNVwyxQ4at6x",    "expired_at": null,    "created_by": null,    "created_at": "2021-11-10T16:08:00.086941Z",    "updated_at": null,    "archived_at": null,    "user_count": 0,    "media_count": 0  }}

{
  "data": {
    "id": "4LPmdVVrEVvRBZWh4uAV6K",
    "workspace_id": "jjGZ6gbAhANmv461rR9MSM",
    "title": "Nome",
    "description": "Descrição",
    "uploading_location_id": "aUXVrK41BmeNVwyxQ4at6x",
    "expired_at": null,
    "created_by": null,
    "created_at": "2021-11-10T16:08:00.086941Z",
    "updated_at": null,
    "archived_at": null,
    "user_count": 0,
    "media_count": 0
  }
}

curl -X POST \  '{{baseHost}}/v1/file-requests' \  -H 'Authorization: Bearer <ACCESS_TOKEN>' \  -H 'Content-Type: application/json' \  -d '{  "title": "Título",  "description": "Descrição",  "uploading_location_id": "aUXVrK41BmeNVwyxQ4at6x",  "expired_at": null}'

curl -X POST \
  '{{baseHost}}/v1/file-requests' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "Título",
  "description": "Descrição",
  "uploading_location_id": "aUXVrK41BmeNVwyxQ4at6x",
  "expired_at": null
}'

Atualizar solicitação de arquivo

PUT {{baseHost}}/v1/file-requests/:file_request_id

Atualiza a solicitação de arquivo indicada. Só os campos enviados no corpo da requisição são alterados; os demais ficam como estão.

Campo	Tipo	Descrição
name	string	Nome do evento
type	string	one-time ou recurring
auto_start	boolean	O evento ao vivo fica disponível para o usuário na hora
save_stream	boolean	Depois de terminar, o evento é salvo como vídeo
folder_id	string	ID do projeto/pasta onde salvar o vídeo. Obrigatório se save_stream=true

Request body (json)

{  "title": "Rename request",  "uploading_location_id": "eR9N13hPU2vynDwJxrwoyP",  "expired_at": null,  "archived": false}

{
  "title": "Rename request",
  "uploading_location_id": "eR9N13hPU2vynDwJxrwoyP",
  "expired_at": null,
  "archived": false
}

Responses

{  "data": {    "id": "nmy77cZuc1TABAUZHCfoms",    "workspace_id": "4yE327XRe7zqfXe4doV7mu",    "name": "Rename request",    "uploading_location_id": "eR9N13hPU2vynDwJxrwoyP",    "expired_at": null,    "created_at": "2021-11-06T14:23:07.466584Z",    "updated_at": "2021-11-06T15:19:33.767551Z",    "archived_at": null,    "user_count": 0,    "media_count": 0  }}

{
  "data": {
    "id": "nmy77cZuc1TABAUZHCfoms",
    "workspace_id": "4yE327XRe7zqfXe4doV7mu",
    "name": "Rename request",
    "uploading_location_id": "eR9N13hPU2vynDwJxrwoyP",
    "expired_at": null,
    "created_at": "2021-11-06T14:23:07.466584Z",
    "updated_at": "2021-11-06T15:19:33.767551Z",
    "archived_at": null,
    "user_count": 0,
    "media_count": 0
  }
}

curl -X PUT \  '{{baseHost}}/v1/file-requests/:file_request_id' \  -H 'Authorization: Bearer <ACCESS_TOKEN>' \  -H 'Content-Type: application/json' \  -d '{  "title": "Rename request",  "uploading_location_id": "eR9N13hPU2vynDwJxrwoyP",  "expired_at": null,  "archived": false}'

curl -X PUT \
  '{{baseHost}}/v1/file-requests/:file_request_id' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "Rename request",
  "uploading_location_id": "eR9N13hPU2vynDwJxrwoyP",
  "expired_at": null,
  "archived": false
}'

Excluir solicitação de arquivo

DELETE {{baseHost}}/v1/file-requests/:file_request_id

Exclui a solicitação de arquivo permanentemente. A ação não pode ser desfeita.

Campo	Tipo	Descrição
name	string	Nome do evento
type	string	one-time ou recurring
auto_start	boolean	O evento ao vivo fica disponível para o usuário na hora
save_stream	boolean	Depois de terminar, o evento é salvo como vídeo
folder_id	string	ID do projeto/pasta onde salvar o vídeo. Obrigatório se save_stream=true

Request body (json)

{  "name": "Rename request",  "folder_id": "eR9N13hPU2vynDwJxrwoyP",  "expired_at": null,  "archived": false}

{
  "name": "Rename request",
  "folder_id": "eR9N13hPU2vynDwJxrwoyP",
  "expired_at": null,
  "archived": false
}

Responses

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

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

curl -X DELETE \  '{{baseHost}}/v1/file-requests/:file_request_id' \  -H 'Authorization: Bearer <ACCESS_TOKEN>' \  -H 'Content-Type: application/json' \  -d '{  "name": "Rename request",  "folder_id": "eR9N13hPU2vynDwJxrwoyP",  "expired_at": null,  "archived": false}'

curl -X DELETE \
  '{{baseHost}}/v1/file-requests/:file_request_id' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Rename request",
  "folder_id": "eR9N13hPU2vynDwJxrwoyP",
  "expired_at": null,
  "archived": false
}'