https://scribie.com/_next/static/chunks/pages/docs/files/list-40e429ee0f1f42dd.js

1(self.webpackChunk_N_E=self.webpackChunk_N_E||[]).push([[1749],{90265:function(s,i,e){(window.__NEXT_P=window.__NEXT_P||[]).push(["/docs/files/list",function(){return e(43496)}])},43496:function(s,i,e){"use strict";e.r(i),e.d(i,{useTOC:function(){return a}});var t=e(85893),r=e(37812),n=e(39150),l=e(38925);function a(s){return[{value:"Endpoint",id:"endpoint",depth:2},{value:"Query Parameters",id:"query-parameters",depth:2},{value:"Response",id:"response",depth:2},{value:"Example Request",id:"example-request",depth:2},{value:"Error Codes",id:"error-codes",depth:2}]}i.default=(0,r.c)(function(s){let{toc:i=a(s)}=s,e={code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",span:"span",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.a)(),...s.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(e.h1,{children:"List Files"}),"\n",(0,t.jsx)(e.p,{children:"Get a list of files that the authenticated user has access to."}),"\n",(0,t.jsx)(e.h2,{id:i[0].id,children:i[0].value}),"\n",(0,t.jsx)(e.pre,{tabIndex:"0","data-language":"http","data-word-wrap":"",children:(0,t.jsx)(e.code,{children:(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"GET"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" ${baseUrl}/files"})]})})}),"\n",(0,t.jsx)(e.h2,{id:i[1].id,children:i[1].value}),"\n",(0,t.jsxs)(e.table,{children:[(0,t.jsx)(e.thead,{children:(0,t.jsxs)(e.tr,{children:[(0,t.jsx)(e.th,{children:"Parameter"}),(0,t.jsx)(e.th,{children:"Type"}),(0,t.jsx)(e.th,{children:"Description"})]})}),(0,t.jsx)(e.tbody,{children:(0,t.jsxs)(e.tr,{children:[(0,t.jsx)(e.td,{children:"status"}),(0,t.jsx)(e.td,{children:"string"}),(0,t.jsxs)(e.td,{children:["Filter by file status. Valid values: ",(0,t.jsx)(e.code,{children:"pending"}),", ",(0,t.jsx)(e.code,{children:"in-progress"}),", ",(0,t.jsx)(e.code,{children:"delivered"})]})]})})]}),"\n",(0,t.jsx)(e.h2,{id:i[2].id,children:i[2].value}),"\n",(0,t.jsx)(e.pre,{tabIndex:"0","data-language":"typescript","data-word-wrap":"",children:(0,t.jsxs)(e.code,{children:[(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"interface"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" FileListResponse"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" {"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"  success"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" boolean"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"  data"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" {"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"    files"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" {"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"      id"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" number"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"      fileId"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" string"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB

170"},children:"      filename"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" string"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"      duration"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" number"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"      filesize"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" string"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"      status"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" FileStatus"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"      uploadedBy"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" {"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"        id"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" number"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"        email"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" string"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"        firstname"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" string"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"        lastname"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" string"})]}),"\n",(0,t.jsx)(e.span,{children:(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"      }"})}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"      createdAt"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" string"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"      customInstructions"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"?:"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" string"})]}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#E36209","--shiki-dark":"#FFAB70"},children:"      downloadCount"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:":"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" number"})]}),"\n",(0,t.jsx)(e.span,{children:(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"    }[]"})}),"\n",(0,t.jsx)(e.span,{children:(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"  }"})}),"\n",(0,t.jsx)(e.span,{children:(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"}"})})]})}),"\n",(0,t.jsx)(e.h2,{id:i[3].id,children:i[3].value}),"\n",(0,t.jsx)(e.pre,{tabIndex:"0","data-language":"typescript","data-word-wrap":"",children:(0,t.jsxs)(e.code,{children:[(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"const"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" response"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:" ="}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:" await"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:" fetch"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"("}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:"'${baseUrl}/files?status=pending'"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:", {"})]}),"\n",(0,t.jsx)(e.span,{children:(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"  headers: {"})}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"    Authorization: "}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#032F62","--shiki-dark":"#9ECBFF"},children:"'Basic YOUR_API_KEY'"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:","})]}),"\n",(0,t.jsx)(e.span,{children:(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"  },"})}),"\n",(0,t.jsx)(e.span,{children:(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:"})"})}),"\n",(0,t.jsx)(e.span,{children:" "}),"\n",(0,t.jsxs)(e.span,{children:[(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:"const"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#005CC5","--shiki-dark":"#79B8FF"},children:" data"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:" ="}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#D73A49","--shiki-dark":"#F97583"},children:" await"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"},children:" response."}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#6F42C1","--shiki-dark":"#B392F0"},children:"json"}),(0,t.jsx)(e.span,{style:{"--shiki-light":"#24292E","--shiki-dark":"#E1E4E8"}

1,children:"()"})]})]})}),"\n",(0,t.jsx)(e.h2,{id:i[4].id,children:i[4].value}),"\n",(0,t.jsxs)(e.table,{children:[(0,t.jsx)(e.thead,{children:(0,t.jsxs)(e.tr,{children:[(0,t.jsx)(e.th,{children:"Status Code"}),(0,t.jsx)(e.th,{children:"Description"})]})}),(0,t.jsxs)(e.tbody,{children:[(0,t.jsxs)(e.tr,{children:[(0,t.jsx)(e.td,{children:"200"}),(0,t.jsx)(e.td,{children:"Success"})]}),(0,t.jsxs)(e.tr,{children:[(0,t.jsx)(e.td,{children:"401"}),(0,t.jsx)(e.td,{children:"Unauthorized"})]}),(0,t.jsxs)(e.tr,{children:[(0,t.jsx)(e.td,{children:"500"}),(0,t.jsx)(e.td,{children:"Server Error"})]})]})]})]})},"/docs/files/list",{filePath:"src/pages/docs/files/list.mdx",timestamp:1790324408e3,pageMap:n.v,frontMatter:{},title:"List Files"},"undefined"==typeof RemoteContent?a:RemoteContent.useTOC)},39150:function(s,i,e){"use strict";e.d(i,{v:function(){return t}});let t=[{data:{docs:{title:"Docs",type:"page"}}},{name:"docs",route:"/docs",children:[{data:{index:"Introduction",users:{title:"Users",items:{profile:"User Profile",preferences:"User Preferences",credits:"User Credits",earnings:"User Earnings"}},teams:{title:"Teams",items:{list:"List Teams",create:"Create Team",update:"Update Team",members:"Team Members",invitations:"Team Invitations",rename:"Rename Team"}},files:{title:"Files",items:{list:"List Files",upload:"Upload File",delete:"Delete File",transcripts:"File Transcripts"}},orders:{title:"Orders",items:{list:"List Orders",create:"Create Order",options:"Order Options"}},"payment-methods":{title:"Payment Methods",items:{list:"List Payment Methods"}},invoices:{title:"Invoices",items:{list:"List Invoices",details:"Invoice Details"}},b2b:{title:"B2B API",display:"hidden",items:{index:"Overview",upload:"Upload File with RIS",order:"Create Order with Job ID","download-transcript":"Download Transcript"}}}},{name:"b2b",route:"/docs/b2b",children:[{data:{index:"Overview",upload:"Upload File with RIS",order:"Create Order with Job ID","download-transcript":"Download Transcript"}},{name:"download-transcript",route:"/docs/b2b/download-transcript",frontMatter:{sidebarTitle:"Download Transcript"}},{name:"index",route:"/docs/b2b",frontMatter:{sidebarTitle:"Index"}},{name:"order",route:"/docs/b2b/order",frontMatter:{sidebarTitle:"Order"}},{name:"upload",route:"/docs/b2b/upload",frontMatter:{sidebarTitle:"Upload"}}]},{name:"files",route:"/docs/files",children:[{name:"delete",route:"/docs/files/delete",frontMatter:{sidebarTitle:"Delete"}},{name:"list",route:"/docs/files/list",frontMatter:{sidebarTitle:"List"}},{name:"transcripts",route:"/docs/files/transcripts",frontMatter:{sidebarTitle:"Transcripts"}},{name:"upload",route:"/docs/files/upload",frontMatter:{sidebarTitle:"Upload"}}]},{name:"index",route:"/docs",frontMatter:{sidebarTitle:"Index"}},{name:"invoices",route:"/docs/invoices",children:[{name:"details",route:"/docs/invoices/details",frontMatter:{sidebarTitle:"Details"}},{name:"list",route:"/docs/invoices/list",frontMatter:{sidebarTitle:"List"}}]},{name:"orders",route:"/docs/orders",children:[{name:"create",route:"/docs/orders/create",frontMatter:{sidebarTitle:"Create"}},{name:"list",route:"/docs/orders/list",frontMatter:{sidebarTitle:"List"}},{name:"options",route:"/docs/orders/options",frontMatter:{sidebarTitle:"Options"}}]},{name:"payment-methods",route:"/docs/payment-methods",children:[{name:"list",route:"/docs/payment-methods/list",frontMatter:{sidebarTitle:"List"}}]},{name:"teams",route:"/docs/teams",children:[{name:"create",route:"/docs/teams/create",frontMatter:{sidebarTitle:"Create"}},{name:"invitations",route:"/docs/teams/invitations",frontMatter:{sidebarTitle:"Invitations"}},{name:"list",route:"/docs/teams/list",frontMatter:{sidebarTitle:"List"}},{name:"members",route:"/docs/teams/members",frontMatter:{sidebarTitle:"Members"}},{name:"rename",route:"/docs/teams/rename",frontMatter:{sidebarTitle:"Rename"}}]},{name:"users",route:"/docs/users",children:[{name:"credits",route:"/docs/users/credits",frontMatter:{sidebarTitle:"Credits"}},{name:"earnings",route:"/docs/users/earnings",frontMatter:{sidebarTitle:"Earnings"}},{name:"preferences",route:"/docs/users/preferences",frontMatter:{

1sidebarTitle:"Preferences"}},{name:"profile",route:"/docs/users/profile",frontMatter:{sidebarTitle:"Profile"}}]}]}]}},function(s){s.O(0,[7812,2888,9774,179],function(){return s(s.s=90265)}),_N_E=s.O()}]);