New: Kith open-sources its ATS.Read why
Skip to Content
Objects

JobDocument

A file uploaded to a job: a job spec, an info document, call notes. Each one is read by a model and merged into the job's brief, and deleting it takes out only what it added.

type JobDocument {
  downloadUrl: String
  filename: String!
  id: ID!
  isProcessing: Boolean!
  kind: JobDocumentKind!
  mimeType: String
  previewUrl: String
  sizeBytes: Int
  summary: String
  text: String
  uploadedAt: DateTime!
  uploadedBy: User
}

Fields

JobDocument.downloadUrl · String scalar

A link that downloads the file, valid for two minutes. Ask for it when someone clicks, not with the list. Null when the file is not held.

JobDocument.filename · String! non-null scalar

The file's name, as uploaded.

JobDocument.id · ID! non-null scalar

The document's id.

JobDocument.isProcessing · Boolean! non-null scalar

True until the document has been read and merged into the brief. Poll while it is true. A document that could not be read stays true: there is no failed state.

JobDocument.kind · JobDocumentKind! non-null enum

What kind of document the uploader said it is.

JobDocument.mimeType · String scalar

The file's media type, such as application/pdf.

JobDocument.previewUrl · String scalar

A link that shows the file in the browser, valid for two minutes, for PDFs only. Null for any other type, and when the file is not held.

JobDocument.sizeBytes · Int scalar

The file's size in bytes. May be null until the document has been read.

JobDocument.summary · String scalar

One or two sentences on what the document says. Null while isProcessing.

JobDocument.text · String scalar

The document's text, as extracted from the file. May be long. Null while isProcessing.

JobDocument.uploadedAt · DateTime! non-null scalar

When it was uploaded.

JobDocument.uploadedBy · User object

Who uploaded it. Null for a document that arrived by email or whose uploader has left.

Member Of

JobDocumentEdge object