Skip to main content
GET
/
jobs
/
{jobGuid}
/
documents
List documents
curl --request GET \
  --url https://live.deck.co/api/v1/jobs/{jobGuid}/documents \
  --header 'x-deck-client-id: <api-key>' \
  --header 'x-deck-secret: <api-key>'
{
  "documents": [
    {
      "document_id": "<string>",
      "file_type": "<string>",
      "metadata": {},
      "file_name": "<string>",
      "file_size": 123,
      "fetch_date": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.deck.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-deck-client-id
string
header
required

Enter your client id

​
x-deck-secret
string
header
required

Enter your secret

Path Parameters

​
jobGuid
string<uuid>
required

The unique identifier of the job.

Query Parameters

​
deduplicate
boolean
default:true

When true (default), returns only documents with unique file content, excluding duplicates. Set to false to return all documents.

Response

OK

​
documents
object[]
required