Skip to main content
GET
/
v1
/
objects
/
{id}
JavaScript
import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: 'My Bearer Token',
});

const objectView = await client.objects.retrieve('id');

console.log(objectView.id);
{
  "id": "<string>",
  "name": "<string>",
  "state": "UPLOADING",
  "size_bytes": 123,
  "content_type": "unspecified",
  "create_time_ms": 123,
  "delete_after_time_ms": 123,
  "upload_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The unique identifier of the Object to retrieve.

Response

Object retrieved successfully.

An Object represents a stored data entity with metadata.

​
id
string
required

The unique identifier of the Object.

​
name
string
required

The name of the Object.

​
state
enum<string>
required

The current state of the Object.

Available options:
UPLOADING,
READ_ONLY,
DELETED,
ERROR
​
content_type
enum<string>
required

The content type of the Object.

Available options:
unspecified,
text,
binary,
gzip,
tar,
tgz
​
create_time_ms
integer
required

The creation time of the Object in milliseconds since epoch.

​
size_bytes
integer | null

The size of the Object content in bytes (null until uploaded).

​
delete_after_time_ms
integer | null

The time after which the Object will be deleted in milliseconds since epoch.

​
upload_url
string | null

Presigned URL for uploading content to S3 (only present on create).