files

Get a file

Get a file's name, type, size, SHA-256 and status, without its bytes.

get/v1/files/{id}

Request

  • Base URL: https://api.pomerado.ai
  • URL: https://api.pomerado.ai/v1/files/{id}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:file_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190

a file ID: file_ and 32 lowercase hex digits

Response

The file

idstring required

a file ID: file_ and 32 lowercase hex digits

namestring required

The file's name, as given

media_typestring required

The file's media type, as checked

sizenumber nullable required

Bytes: the declared size until the upload arrives, then the size received; null when none was declared

sha256string nullable required

The SHA-256 of the bytes, lowercase hex, once they arrived

status'awaiting_upload' | 'ready' | 'in_use' required

awaiting_upload until its bytes arrive at upload_url, ready to pass to a run, in_use once a run took it

direction'input' | 'output' required

input for a file sent to a run, output for one a run collected

job_idstring required

a job ID: job_ and 32 lowercase hex digits

created_atstring required

a string to be decoded into a Date

expires_atstring required

a string to be decoded into a Date

Example response

{
  "id": "file_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190",
  "job_id": "job_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.